• Dernière modification le: 19 October 2021

API des pièces jointes

Utilisez l'API Pièces jointes pour gérer les pièces jointes sur les objets Référence Coupa et Transactionnel.

Actions

La plupart des ressources Coupa vous permettent d'ajouter des pièces jointes aux ressources de base ainsi que des commentaires sur la ressource. Consultez l' API Commentaires pour plus de détails. 

L'API Pièces jointes vous permet d'effectuer les actions suivantes.

Verbe Chemin d'accès Action Description
POSTE /api/contract/:id_contrat/pièces jointes créer Créer une pièce jointe
POSTE /api/voices/:invoice_id/attachments créer Créer une pièce jointe
POSTE /api/expense_reports/:expense_report_id/pièces jointes créer Créer une pièce jointe
POSTE /api/purchase_orders/:purchase_order_id/pièces jointes créer Créer une pièce jointe
POSTE /api/users/:id_utilisateur/pièces jointes créer Créer une pièce jointe
POSTE /api/requisitions/:id_demande/pièces jointes créer Créer une pièce jointe
OBTENIR /api/contract/:id_contrat/pièces jointes index Demander les pièces jointes
OBTENIR /api/inventory_transactions/:id/pièces jointes/:id montrer Afficher la pièce jointe
OBTENIR /api/voices/:invoice_id/attachments index Demander les pièces jointes
OBTENIR /api/expense_reports/:expense_report_id/pièces jointes index Demander les pièces jointes
OBTENIR /api/purchase_orders/:purchase_order_id/pièces jointes index Demander les pièces jointes
OBTENIR /api/users/:id_utilisateur/pièces jointes index Demander les pièces jointes
OBTENIR /api/requisitions/:id_demande/pièces jointes index Demander les pièces jointes
OBTENIR /api/Contracts/:contract_id/attachments/:id montrer Afficher la pièce jointe
OBTENIR /api/voices/:invoice_id/attachments/:id montrer Afficher la pièce jointe
OBTENIR /api/expense_reports/:expense_report_id/pièces jointes/:id montrer Afficher la pièce jointe
OBTENIR /api/purchase_orders/:purchase_order_id/attachments/:id montrer Afficher la pièce jointe
OBTENIR /api/users/:id_utilisateur/pièces jointes/:id montrer Afficher la pièce jointe
OBTENIR /api/requisitions/:id_demande/pièces jointes/:id montrer Afficher la pièce jointe
PATCH /api/Contracts/:contract_id/attachments/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
METTRE /api/Contracts/:contract_id/attachments/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
PATCH /api/voices/:invoice_id/attachments/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
METTRE /api/voices/:invoice_id/attachments/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
PATCH /api/expense_reports/:expense_report_id/pièces jointes/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
METTRE /api/expense_reports/:expense_report_id/pièces jointes/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
PATCH /api/purchase_orders/:purchase_order_id/attachments/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
METTRE /api/purchase_orders/:purchase_order_id/attachments/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
PATCH /api/users/:id_utilisateur/pièces jointes/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
METTRE /api/users/:id_utilisateur/pièces jointes/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
PATCH /api/requisitions/:id_demande/pièces jointes/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
METTRE /api/requisitions/:id_demande/pièces jointes/:id mettre à jour Vous ne pouvez pas mettre à jour les pièces jointes via l'API
EFFACER /api/requisitions/:id_demande/pièces jointes/:id     effacer Supprimer une pièce jointe de l'en-tête de demande (fonctionne pour d'autres types de documents, comme les commandes)
EFFACER /api/requisition_lines/:id_ligne_de_demande/pièces jointes/:id effacer Supprimer une pièce jointe de la ligne de demande (fonctionne également pour d'autres types de documents, comme les commandes)

Éléments

Les éléments suivants sont disponibles pour l'API des pièces jointes :

Élément Description Champ obligatoire ? Unique ? Valeur autorisée Champ Api_In ? Champ Api_Out ? Type de données
créé à Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ         oui datetime
url-fichier URL vers le fichier joint       oui   chaîne
id Identifiant Coupa unique   oui     oui entier
intention intention       oui oui string(40)
lié à lien vers une fonctionnalité spécifique       oui   string(255)
texte texte       oui   texte
type type oui     oui oui string(255)
mis à jour à Créé automatiquement par Coupa au format AAAA-MM-JJFHH:MM:SS+HH:MMZ         oui datetime
url url       oui   string(255)

Exemple

 L' exemple suivant montre comment créer une pièce jointe du fichier,Standard_Terms_Conditions.pdf, pour le contrat 12345.

curl -X POST \
  https://<INSTANCE>/api/requisitions/12345/attachments \
  -H "Accept: application/xml" \
  -H "content-type: multipart/form-data" \
  -H "x-coupa-api-key: <API KEY>" \
  -F "attachment[file]=@/Users/IntegrationAdmin/Contracts/Standard_Terms_Conditions.pdf" \
  -F "attachment[type]=file"
  -F "attachment[intent]=Supplier"

Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.

Articles associés


API Coupa Core

Notre API RESTful fournit un accès fiable pour lire, modifier ou intégrer vos données à la plateforme Coupa.

Démarrez avec l'API

Informations générales sur l'utilisation de l'API Coupa et quand vous devez envisager d'utiliser CSV.

Transition vers OAuth 2.0 et OIDC

Coupa désapprouve les API Keys héritées et nécessite l'utilisation d'OAuth 2.0 / OIDC. À partir de R34, aucune nouvelle clé API ne sera émise et les clés API ne seront plus prises en charge avec R35.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : données de référence, données transactionnelles et ressources partagées.