Delete an attachment for an invoice
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments/{attachmentsUniqID}
Request
-
attachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Attachments resource and used to uniquely identify an instance of Attachments. The client should not generate the hash key value. Instead, the client should query on the Attachments collection resource in order to navigate to a specific instance of Attachments to get the hash key.
-
invoicesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource in order to navigate to a specific instance of Invoices to get the hash key.
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Default Response
Examples
The following example shows how to retrieve and delete an attachment of an invoice.
Get all the attachments of an invoice and use the self URI of the specific attachment. Then, submit a DELETE request on the REST resource using cURL
Here's the cURL command to retrieve all the attachments:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177565180/child/attachments
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"AttachedDocumentId": 300100177565182,
"LastUpdateDate": "2018-09-05T09:19:33.411+00:00",
"LastUpdatedBy": "AP_SUPV_OPERATIONS",
"FileName": "REST Invoice related attachment.txt",
...
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177565180/child/attachments/00020000000EACED00057708000110F0847B15FE0000000EACED00057708000110F0847B15FD",
"name": "attachments",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177565180/child/attachments/00020000000EACED00057708000110F0847B15FE0000000EACED00057708000110F0847B15FD",
"name": "attachments",
"kind": "item"
},
...
]
},
...
],
"count": 10,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177565180/child/attachments",
"name": "attachments",
"kind": "collection"
}
]
}
A
hash key of InvoiceId
and AttachedDocumentId
identifies an
attachment.
Here's the cURL command that uses the hash key in the self URI to retrieve the specific attachment:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177565180/child/attachments/00020000000EACED00057708000110F0847B15FE0000000EACED00057708000110F0847B15FD
Here's the cURL command that uses the self URI to delete the attachment:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X DELETE https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177565180/child/attachments/00020000000EACED00057708000110F0847B15FE0000000EACED00057708000110F0847B15FD
Example Response Body
The following example shows the contents of the response body in JSON format:
204 Response No content. The server successfully processed the request, but is not returning any content.