KOkontainer
DAM: Files: References

Returns a single DAM file's external references

get/dam/files/{file_id}/relationships/external-references

Request

Path parameters

file_idstring required

ID of File

Query parameters

page[size]integer

Define the per page size. (defaults to 100, limit is 500) Example: page[size]=10

page[number]integer

Define the page number. (defaults to 1) Example: page[number]=1

Response

success

Example response

{
  "data": [
    {
      "id": "1234",
      "type": "file-reference-external",
      "attributes": {
        "name": "Example Reference",
        "url": "https://example.com/resource"
      },
      "meta": {
        "integration": "Example Integration"
      }
    }
  ],
  "links": {
    "first": "https://example.kontainer.com/jsonapi/v2/dam/files/{file_id}/relationships/external-references?page=1",
    "last": "https://example.kontainer.com/jsonapi/v2/dam/files/{file_id}/relationships/external-references?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "Previous",
        "active": false
      },
      {
        "url": "https://example.kontainer.com/jsonapi/v2/dam/files/{file_id}/relationships/external-references?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next",
        "active": false
      }
    ],
    "per_page": 100,
    "to": 10,
    "total": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.