Link relation aa:asset-by-id-bulk

Overview

A bulk call that gets multiple assets.

HTTP method

POST

URI template variables

-

Query parameters

qkey

Password for key-locked queue.

embed

A comma-separated list of sub resources to embed. Possible values:

  • attributes: embeds the aa:attributes resource for the asset.

  • nsml: embeds the asset nsml.

section

Only if nsml is embedded

A comma-separated list of nsml sections. Possible values are head, form, fields, field-atts, body, aeset, aeset-atts, projects.

Request body

A JSON string array containing the ids of the requested assets:

[
  "id1",
  "id2",
  "id3"
]

  • MediaCentral Asset Management & Production Management: The maximum number of ids in the request body is 20-30

  • MediaCentral Newsroom Management: The maximum number of ids in the request body is 1000

HTTP response

200 OK

Response body

-

An array with one entry for each requested id. For each successfully requested entry:

  • success: true

  • data: an aa:asset resource for the entry.

For each requested entry that caused an error:

  • success: false

  • httpStatus: same response code as for the aa:asset-by-id link rel. Typical example: 404.

  • errorCode (string, optional): machine-readable error code that the non-bulk call would return for this item

  • errorMessage (optional, string): human-readable error message that the non-bulk call would return for this asset

Example response if "id1" is valid, "id2" doesn’t exist, and "id3" is valid again:

[
  {
    "success": true,
    "data": {
       ... same as for aa:asset-by-id for "id1"
    }
  },
  {
    "success": false,
    "httpStatus": 404,
    "errorCode": "not_found",
    "errorMessage": "Resource not found"
  },
  {
    "success": true,
    "data": {
      ... same as for aa:asset-by-id for "id3"
    }
  }
]

Available in

Description

A bulk call that gets multiple assets.