API Objet personnalisé (/custom_objects/id)
Utilisez l'API Objet personnalisé pour créer de nouveaux enregistrements de données pour vos objets personnalisés.
Introduction
Utilisez l'API Objets personnalisés pour créer, mettre à jour ou interroger les enregistrements de données de vos objets personnalisés. Si vous devez définir un nouvel objet personnalisé, utilisez l'interface utilisateur.
L'URL pour accéder à l'API Objets Personnalisés est : https ://<instance>/api/custom_objects/{object_id}
Voir les meilleures pratiques d'intégration pour plus d'informations.
Actions
| Verbe | Chemin d'accès | Action | Description |
|---|---|---|---|
| PUBLIER | /api/custom_objects/{object_id}/object_instances/ |
créer | Créer un nouvel enregistrement de données pour l'objet personnalisé |
| METTRE | /api/custom_objects/{object_id}/object_instances/{instance_id} |
mettre à jour | Modifier un enregistrement de données existant |
| OBTENIR | /api/custom_objects/{object_id}/object_instances/ |
index | Répertorie tous les enregistrements de données pour l'objet personnalisé |
| OBTENIR | /api/custom_objects/{object_id}/object_instances/{instance_id} |
afficher | Répertorie un enregistrement de données individuel |
Éléments (instance d'objet)
| Élément | Description | Dem. | Unique | Valeur autorisée | Dans | Sortie | Type de données |
|---|---|---|---|---|---|---|---|
| created-at | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | tout | oui | datetime | |||
| créé par | Utilisateur qui a créé | tout | oui | Utilisateur | |||
| custom-object-code | Code d'objet personnalisé | tout | oui | chaîne | |||
| custom-object-name | Nom d'objet personnalisé | any | oui | chaîne | |||
| form-response-id | ID de la réponse au formulaire ayant créé l'instance | any | oui | nombre entier | |||
| id | ID interne de Coupa | tout | oui | nombre entier | |||
| mis-à-jour à | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | tout | oui | datetime | |||
| mis à jour par | Utilisateur ayant réalisé la mise à jour | tout | oui | Utilisateur |
Les éléments ne sont utilisés que pour RECEVOIR des appels. Les appels POST ou PUT n'incluront que les champs personnalisés utilisés dans votre définition d'objet personnalisée. Voir l'exemple ci-dessous pour plus de détails.
Exemples de charges utiles
Étant donné qu'un objet personnalisé est entièrement composé de champs personnalisés, vous devez contenir vos champs personnalisés dans l'espace de noms de champs personnalisés. Un POST ou PUT de base doit prendre cette forme :
<object-instance>
<custom-fields>
<custom-field-1>custom-field-1-value</custom-field-1>
<custom-field-2>custom-field-2-value</custom-field-2>
...
<custom-field-10>custom-field-10-value</custom-field-10>
<custom-fields>
</object-instance>