Retrieve a File Attached to a Record

To retrieve a file that is attached to a record from MYOB Acumatica by using the contract-based REST API, you access the URL address of the file with the GET HTTP method. See the following sections for details on the request and the response.

HTTP Method and URL

If you need to obtain a file attached to a record, you use the GET HTTP method and the following URL.

GET http://<Base endpoint URL>/files/<File identifier>

The URL has the following components:

<Base endpoint URL> is the URL of the contract-based endpoint through which you are going to work with MYOB Acumatica, which has the following format: http://<MYOB Acumatica instance URL>/entity/<Endpoint name>/<Endpoint version>/.
<File identifier> is the internal identifier of the file in the system.

To get this URL for a particular file attached to a record, you should obtain the record from MYOB Acumatica and, in the returned JSON representation of the record, find the value of the href property of the needed file in the files array. For information on how to retrieve a record from MYOB Acumatica, see Retrieve a Record by Key Fields and Retrieve a Record by ID.

For example, suppose that you retrieved the stock item record that contains the following files array from a local MYOB Acumatica instance with the name AcumaticaDB.

{
  ...,
  "files":[
    {
      "id":"9be45eb7-f97d-400b-96a5-1c4cf82faa96",
      "filename":"Stock Items (AAMACHINE1)\\T2MCRO.jpg",
      "href":
"/AcumaticaDB/entity/Default/23.200.001/files/9be45eb7-f97d-400b-96a5-1c4cf82faa96"
    }
  ]
}

You should use the following HTTP method and URL to retrieve the T2MCRO.jpg file attached to the stock item record.

GET http://localhost/AcumaticaDB/entity/Default/23.200.001/files/9be45eb7-f97d-400b-96a5-1c4cf82faa96

Parameters

You use no parameters when you retrieve a file attached to a record.

Request Headers

You can specify the following header in the request.


Header	Description
Accept	Specifies the format of the response body, which should be application/json.

Response Status Codes

The following table lists the HTTP status codes that the system returns for a request that retrieves a file attached to a record.


Code	Description
200	The request has been completed successfully. The response contains the requested file.
401	The user is not signed in to the system.
403	The user has insufficient rights to access the MYOB Acumatica form that corresponds to the entity.
429	The number of requests has exceeded the limit imposed by the license (see License Restrictions for API Users).
500	An internal server error has occurred.

Example

Tip:

In the request examples below, <MYOB Acumatica instance URL> is the URL of the MYOB Acumatica instance (such as https://my.acumatica.com/MyInstance). You can omit the instance name in the URL (such as https://my.acumatica.com) if the instance is installed in the root of the website.

The following request shows an example of the retrieval of the list of files attached to the JUICER20C stock item.

GET /JUICER20C?$select=InventoryID,files&$expand=files HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/StockItem
Accept: application/json
Content-Type: application/json

Suppose that the request above returns the following response body.

{
    "id": "a0f8594a-7de2-e811-b816-00155d408001",
    "rowNumber": 1,
    "note": {
        "value": ""
    },
    "InventoryID": {
        "value": "EJECTOR03"
    },
    "custom": {},
    "files": [
        {
            "id": "0a8ac74e-53d3-4f13-ba02-dbbf419da119",
            "filename": "Stock Items (EJECTOR03   )\\T2MCRO.jpg",
            "href": "[/<MYOB Acumatica instance name>]/entity/Default/23.200.001/
                 files/dbcf82e7-660a-4d56-9b64-1cb654660ddb"
        }
    ]
}
{
    "id": "eb01ae69-7ee2-e811-b816-00155d408001",
    "rowNumber": 1,
    "note": {
        "value": ""
    },
    "InventoryID": {
        "value": "JUICER20C"
    },
    "custom": {},
    "_links": {
        "self": "/<MYOB Acumatica instance name>/entity/Default/23.200.001/
StockItem/eb01ae69-7ee2-e811-b816-00155d408001",
        "files:put": "/<MYOB Acumatica instance name>/entity/Default/23.200.001/
files/PX.Objects.IN.InventoryItemMaint/Item/eb01ae69-7ee2-e811-b816-00155d408001/{filename}"
    },
    "files": [
        {
            "id": "e77c0c80-2296-4ef9-9588-877692933f31",
            "filename": "Stock Items (JUICER20C   )\\commercial_citrus_juicer.jpg",
            "href": "/<MYOB Acumatica instance name>/entity/Default/23.200.001/
files/e77c0c80-2296-4ef9-9588-877692933f31"
        }
    ]
}

The following request retrieves the commercial_citrus_juicer.jpg file attached to the JUICER20C stock item by the ID of the file.

GET /e77c0c80-2296-4ef9-9588-877692933f31 HTTP/1.1
Host: [<MYOB Acumatica instance URL>]/entity/Default/23.200.001/files
Accept: application/octet-stream
Content-Type: application/json