Link relation aa:update-asset

Overview

Update the Metadata of an asset.

HTTP method

PATCH

URI template variables

-

Query parameters

unlock

Only for MediaCentral Newsroom Management

Put false to preserve asset lock, default value is true.

qkey

Only for MediaCentral Newsroom Management

Password for key-locked queue.

skey

Only for MediaCentral Newsroom Management

Password for key-locked asset.

lockId

Only for MediaCentral Newsroom Management

ID of the edit lock.

Request body

You can update:

  • Common attributes

  • Statuses

  • Custom attributes (by adding an embedded aa:attributes resource to the request body)

In general:

  • Attributes and statuses that are given in the request are updated.

  • Attributes and statuses that are not given are not touched.

There can be implementation-specific mappings between CTMS attributes (common and custom) to properties in the underlying system. If you try updating multiple attributes, that are mapped to the same property in the underlying system, with different values, then it’s implementation-specific which of the values wins.

For details about specific systems, see below.

HTTP response

200 OK or 204 No Content

The asset was updated successfully.

A service may choose to return HTTP status 200 OK or 204 No Content to indicate success.

403 Forbidden

Write access to the asset was denied.

404 Not Found

The asset doesn’t exist or the service or an intermediate resource is not available.

Response body

-

If the service returns the HTTP status code 200 OK the response body contains the updated aa:asset resource.

Available in

Description

MediaCentral Asset Management

The body is expected in the same format that is returned when getting the information about an asset. You can update:

  • Common attributes: name, created, creator, description, durationTC, duration, addToWtnStory, and addToWtnPubPoint

  • Statuses: draft-sequence-exists, incomplete, ada-summary, and ada-transcript

  • Custom attributes

Example with only a common attribute and a status 
 
{
    "common": {
        "name": "A new name"
    },
    "status": {
        "ada-summary": "pending"
    }
}

To update custom attributes, you must include an embedded aa:attributes resource in the request body. See aa:update-attributes for details.

Example with common and custom attributes 
 
{
  "common": {
    "name": "New name"
  },
  "_embedded": {
    "aa:attributes": {
      "attributes": [
        {
          "name": "REGISTRATION_DATETIME",
          "value": "2025-06-10 23:10:12"
        },
        {
          "name": "CONTRIBUTIONS",
          "type": "multi-value compound",
          "value": [
            {
              "index": 0,
              "attributes": [
                {
                  "name": "ROLE",
                  "value": "288"
                },
                {
                  "name": "REAL_NAME",
                  "value": "John Doe"
                }
              ]
            },
            {
              "index": 1,
              "attributes": [
                {
                  "name": "ROLE",
                  "value": "221"
                },
                {
                  "name": "REAL_NAME",
                  "value": "John Smith"
                }
              ]
            }
          ]
        },
        {
          "name": "KEYWORDS",
          "type": "multi-value string",
          "value": [
            {
              "index": 0,
              "value": "Germany"
            },
            {
              "index": 1,
              "value": "Berlin"
            },
            {
              "index": 2,
              "value": null
            },
            {
               "value": "Politics"
            }
          ]
        }
      ]
    }
  }
}

MediaCentral Production Management

The request body is expected in the same format that is returned when getting the information about an asset. You can update:

  • Common attributes: name, description, addToWtnStory (New in MC | Cloud UX 2025.6), and addToWtnPubPoint (New in MC | Cloud UX 2025.6). The common attributes name and description take preference over their originating custom attributes NXN_Display_Name and Comments.

  • Statuses: the statuses that are marked as writable in Status of an aa:asset or loc:item.

  • Custom attributes. To update custom attributes, you must include an embedded aa:attributes resource in the request body. See aa:update-attributes for details.

Example request body 
 
{
  "common": {
    "name": "New name"
  },
  "status": {
    "ada-summary": "pending"
  },
  "_embedded": {
    "aa:attributes": {
      "attributes": [
        {
          "name": "com.avid.workgroup.Property.User.ProdId",
          "value": "P12345"
        }
      ]
    }
  }
}

MediaCentral Newsroom Management

The request body is expected in NSML format. Content-Type must be set to application/vnd.com.avid.inews.nsml+xml. To update story NSML you need to lock corresponding story section, see ia:lock-asset for details.

Example request body 
 
<nsml version="4.1">
<head>
    <meta words="4" rate="180" wordlength="6" version="2"/>
    <formname>DEFAULT-FORM</formname>
    <storyid>0ba0af50:0000a8b9:56bc92a9</storyid>
</head>
<fields>
    <string id="title">Weather forecast</string>
    <date id="create-date">1453717480</date>
    <date id="modify-date">1455198889</date>
    <string id="modify-by">avstar</string>
</fields>
<body>
    <p>The weather is fine.</p>
</body>
</nsml>

Draft sequence

For MediaCentral Asset Management and MediaCentral Production Management: This request body can be used to set the draft-sequence-exists status to true

Example request body 
 
{
  "status": {
    "draft-sequence-exists": true
  }
}