Skip to main content
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Ressources et collections

Contributeurs
PDF

L'API REST Astra Control permet d'accéder aux instances de ressources et aux ensembles d'instances de ressources.

Remarque Sur le plan conceptuel, une ressource REST * est similaire à un objet tel que défini avec les langages et systèmes de programmation orientés objet (OOP). Parfois, ces termes sont utilisés de manière interchangeable. Mais en général, la méthode « ressource » est préférée lorsqu'elle est utilisée dans le contexte de l'API REST externe tandis que l'option « objet » est utilisée pour les données d'instance avec état correspondantes stockées sur le serveur.

Caractéristiques des ressources Astra

L'API REST Astra Control est conforme aux principes de conception RESTful. Chaque instance de ressource Astra est créée en fonction d'un type de ressource bien défini. Un ensemble d'instances de ressource du même type est appelé collection. Les appels de l'API agissent sur des ressources individuelles ou des collections de ressources.

Types de ressource

Les types de ressource inclus avec l'API REST Astra Control présentent les caractéristiques suivantes :

  • Chaque type de ressource est défini à l'aide d'un schéma (généralement au format JSON).

  • Chaque schéma de ressource inclut le type et la version de ressource

  • Les types de ressources sont globalement uniques

Instances de ressources

Les instances de ressources disponibles via l'API REST Astra Control présentent les caractéristiques suivantes :

  • Les instances de ressources sont créées en fonction d'un type de ressource unique

  • Le type de ressource est indiqué à l'aide de la valeur Type de support

  • Les instances sont composées de données avec état qui sont conservées par le service Astra

  • Chaque instance est accessible via une URL unique et longue durée

  • Dans les cas où une instance de ressource peut avoir plusieurs représentations, différents types de support peuvent être utilisés pour demander la représentation souhaitée

Collections de ressources

Les collections de ressources disponibles via l'API REST Astra Control présentent les caractéristiques suivantes :

  • L'ensemble des instances de ressource d'un type de ressource unique est appelé collection

  • Les collections de ressources ont une URL unique et de longue durée

Identifiants d'instances

Un identifiant est attribué à chaque instance de ressource lors de sa création. Cet identifiant est une valeur UUIDv4 128 bits. Les valeurs UUIDv4 attribuées sont globalement uniques et immuables. Après l'émission d'un appel API qui crée une nouvelle instance, une URL avec l'ID associé est renvoyée à l'appelant dans un Location En-tête de la réponse HTTP. Vous pouvez extraire l'identificateur et l'utiliser sur les appels suivants lorsque vous faites référence à l'instance de ressource.

Remarque L'identifiant de ressource est la clé principale utilisée pour les collections.

Structure commune pour les ressources Astra

Chaque ressource Astra Control est définie à l'aide d'une structure commune.

Les données communes

Chaque ressource Astra contient les valeurs-clés indiquées dans le tableau suivant.

Clé Description

type

Type de ressource unique et global appelé type de ressource.

version

Un identificateur de version appelé version de ressource.

id

Un identificateur unique global appelé identificateur de ressource.

les métadonnées

Objet JSON contenant diverses informations, y compris les étiquettes de l'utilisateur et du système.
Objet de métadonnées

L'objet de métadonnées JSON inclus avec chaque ressource Astra contient les valeurs de clé indiquées dans le tableau suivant.

Clé Description

étiquettes

Tableau JSON d'étiquettes spécifiées par le client associées à la ressource.

CréationTimestamp

Chaîne JSON contenant un horodatage indiquant quand la ressource a été créée.

ModificationTimestamp

Chaîne JSON contenant un horodatage au format ISO-8601 indiquant quand la ressource a été modifiée pour la dernière fois.

CreatedBy

Chaîne JSON contenant l'identifiant UUIDv4 de l'ID utilisateur qui a créé la ressource. Si la ressource a été créée par un composant système interne et qu'aucun UUID n'est associé à l'entité de création, l'UUID null est utilisé.
État de la ressource

Ressources sélectionnées a state valeur utilisée pour orchestrer les transitions de cycle de vie et contrôler l'accès.