Create attachments

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Creates a attachment in Dynamics 365 Business Central.

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline.

POST businesscentralPrefix/companies({id})/attachments

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json

Request body

In the request body, supply a JSON representation of a attachment object.

Response

If successful, this method returns 201 Created response code and a attachment object in the response body.

Example

Request

Here is an example of a request.

POST https://{businesscentralPrefix}/api/v1.0/companies({id})/attachments
Content-type: application/json
```json
{
	"parentId" : "0a077d18-45e3-ea11-bb43-000d3a2feca1",
	"fileName": "myPDF.pdf"
}

ParentId is the Id of the entity, for which an attachment is being created.

Response

HTTP/1.1 201 Created
Content-type: application/json

{
    "id": "b282a6f1-bfe3-ea11-aa60-000d3ad7cacb",
    "parentId": "0a077d18-45e3-ea11-bb43-000d3a2feca1",
    "fileName": "myPDF.pdf",
    "byteSize": 0,
    "lastModifiedDateTime": "2020-08-21T15:06:53Z",
    "parentType": "Journal"
}

See also

Tips for working with the APIs
attachment
Get attachment
Delete attachment
Update attachment