Pièces jointes API
Utilisez l'API Pièces jointes pour gérer les pièces jointes sur les objets de référence et transactionnels Coupa.
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. Voir 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 |
---|---|---|---|
PUBLIER | /api/contracts/:contract_id/attachments | créer | Créer une pièce jointe |
PUBLIER | /api/INVOICES/:invoice_id/attachments | créer | Créer une pièce jointe |
PUBLIER | /api/expense_reports/:expense_report_id/pièces jointes | créer | Créer une pièce jointe |
PUBLIER | /api/purchase_orders/:purchase_order_id/attachments | créer | Créer une pièce jointe |
PUBLIER | /api/users/:user_id/attachments | créer | Créer une pièce jointe |
PUBLIER | /api/requisitions/:requisition_id/pièces jointes | créer | Créer une pièce jointe |
OBTENIR | /api/contracts/:contract_id/attachments | index | Demander les pièces jointes |
OBTENIR | /api/inventory_transactions/: |
afficher | Afficher la pièce jointe |
OBTENIR | /api/INVOICES/:invoice_id/attachments | index | Pièces jointes de la requête |
OBTENIR | /api/expense_reports/:expense_report_id/pièces jointes | index | Demander les pièces jointes |
OBTENIR | /api/purchase_orders/:purchase_order_id/attachments | index | Pièces jointes de la requête |
OBTENIR | /api/users/:user_id/attachments | index | Demander les pièces jointes |
OBTENIR | /api/requisitions/:requisition_id/pièces jointes | index | Pièces jointes de la requête |
OBTENIR | /api/contracts/:contract_id/attachments/:id | afficher | Afficher la pièce jointe |
OBTENIR | /api/invoices/:invoice_id/attachments/:id | afficher | Afficher la pièce jointe |
OBTENIR | /api/expense_reports/:expense_report_id/attachments/:id | afficher | Afficher la pièce jointe |
OBTENIR | /api/purchase_orders/:purchase_order_id/attachments/:id | afficher | Afficher la pièce jointe |
OBTENIR | /api/users/:user_id/attachments/:id | afficher | Afficher la pièce jointe |
OBTENIR | /api/requisitions/:requisition_id/attachments/:id | afficher | Afficher la pièce jointe |
PATCH | /api/contracts/:contract_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
METTRE | /api/contracts/:contract_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
PATCH | /api/invoices/:invoice_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
METTRE | /api/invoices/:invoice_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
PATCH | /api/expense_reports/:expense_report_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
METTRE | /api/expense_reports/:expense_report_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
PATCH | /api/purchase_orders/:purchase_order_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
METTRE | /api/purchase_orders/:purchase_order_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
PATCH | /api/users/:user_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
METTRE | /api/users/:user_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
PATCH | /api/requisitions/:requisition_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
METTRE | /api/requisitions/:requisition_id/attachments/:id | mettre à jour | Vous ne pouvez pas mettre à jour des pièces jointes au moyen de l'API |
SUPPRIMER | /api/requisitions/:requisition_id/attachments/:id | supprimer | Supprimer une pièce jointe de l'en-tête de la demande (fonctionne également pour d'autres types de documents, comme les commandes) |
SUPPRIMER | /api/réquisition_lignes/:réquisition_ligne_id/pièces jointes/:id | supprimer | Supprimer une pièce jointe de la ligne de la demande (fonctionne également pour d'autres types de documents, comme les commandes) |
Éléments
Les éléments suivants sont disponibles pour l'API Pièces jointes :
Élément | Description | Champ obligatoire ? | Unique ? | Valeur autorisée | Api_In Field ? | Api_Out Field ? | Type de données |
---|---|---|---|---|---|---|---|
created-at | Créé automatiquement par Coupa au format AAAA-MM-JJFHH :MM :SS+HH :MMZ | oui | datetime | ||||
file-url | URL du fichier joint | oui | chaîne | ||||
id | Identifiant unique Coupa | oui | oui | nombre entier | |||
intention | intention | oui | oui | string(40) | |||
lié à | lien vers une caractéristique 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 crée une pièce jointe du fichier, Standard_Terms_Conditions.pdf
, pour le contrat 12345
.
curl -X POST \ https ://<INSTANCE>/api/réquisitions/12345/pièces jointes \ -H "Accepter : application/xml" \ -H "content-type : multipart/form-data" \ -H "x-coupa-api-key :<API KEY>" \ -F "pièce jointe[file]=@/Users/IntegrationAdmin/Contracts/Standard_Terms_Conditions.pdf" \ -F "pièce jointe[type]=fichier" -F "pièce jointe[intention]=Fournisseur"