1. REST API for Content Management
  2. Tasks
  3. Items

Update an Item

put

/content/management/api/v1.1/items/{id}

Update an item with the given payload. This is for both Content Item and Digital Item standard fields.

Notes :
There are additional fields which cannot be updated via this request. The API described in Items Bulk Operations contains a list of operations that will allow updating some of these fields.

The translatable node value can not be updated via this request. There are are some extended operations to achieve that.

If item is not published or not scheduled for publish, and language node is not passed then we set language from existing version. If language is not set on existing version then we set repository default language.

Request

Supported Media Types
Path Parameters
Query Parameters
Header Parameters
Body ()
Updates an item with the given information in the payload.

The following fields are read-only in this operation: createdBy, createdDate, updatedBy, updatedDate, status, isPublished, languageIsMaster, version, fileExtension, scheduled, tags, typeCategory, variations, versionInfo, publishInfo, lockInfo, connectorFileInfo, channels, publishedChannels, collections, relationships, taxonomies, suggestedTaxonomies, workflows, changes, metadata, currentVersion, latestVersion, mimeType, fileGroup, varSetId, connectorId, connectorSyncEnabled, sourceId, permissions, reference and links. They will be ignored even if given in the payload.
Root Schema : Item
Type: object
Discriminator: typeCategory
Item
Show Source
Nested Schema : ItemSubResourceListChangesInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListChannelId
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListCollectionId
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceConnectorFileInfo
Type: object
Item SubResource.
Show Source
Nested Schema : User
Type: object
User object
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : fields
Type: object
Read Only: true
Additional Properties Allowed
Show Source
User-defined fields data. Map. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.
Nested Schema : ItemSubResourceLockInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemMetadataInfo
Type: object
ItemMetadataInfo
Show Source
Nested Schema : ItemSubResourceListAction
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListPublishInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemReferenceInfo
Type: object
ItemReferenceInfo
Show Source
Nested Schema : ItemSubResourceRelationships
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListSuggestedTaxonomyInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListTag
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListTaxonomyInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListVariationsInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListVersionInfo
Type: object
Item SubResource.
Show Source
Nested Schema : VideoBean
Type: object
VideoBean
Show Source
Nested Schema : WorkflowField
Type: object
All mapped workflow fields
Show Source
Nested Schema : ItemSubResourceListWorkflowInfo
Type: object
Item SubResource.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : ChangesInfo
Type: object
ChangesInfo
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : ChannelId
Type: object
ChannelId
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : CollectionId
Type: object
CollectionId
Show Source
Nested Schema : ConnectorFileInfo
Type: object
ConnectorFileInfo
Show Source
Nested Schema : additionalProperties
Type: object
Nested Schema : LockInfo
Type: object
LockInfo
Show Source
Nested Schema : EXIFMetadata
Type: object
EXIF Metadata
Show Source
Nested Schema : VideoTranscriptMetadata
Type: object
Video Transcription Metadata
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : AggregationResult
Type: object
Show Source
Nested Schema : ItemExtractedExifBean
Type: object
ItemExtractedExifBean
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : Videotranscript
Type: object
Video transcript
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : Action
Type: object
Action
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : PublishInfo
Type: object
PublishInfo
Show Source
Nested Schema : Relationships
Type: object
Relationships
Show Source
Nested Schema : referencedBy
Type: array
Referenced by ids
Show Source
Nested Schema : Siteplanreference
Type: object
Site plan reference
Show Source
Nested Schema : referencedBySites
Type: array
Referenced by sites
Show Source
Nested Schema : references
Type: array
Reference ids
Show Source
Nested Schema : References
Type: object
References
Show Source
Nested Schema : ReferencedBySites
Type: object
ReferencedBySites
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : SuggestedTaxonomyInfo
Type: object
SuggestedTaxonomyInfo
Show Source
Nested Schema : categories
Type: array
Categories in the Suggested Taxonomy the item belongs to.
Show Source
Nested Schema : ItemSuggestedCategoryInfo
Type: object
Show Source
Nested Schema : nodes
Type: array
Nodes in the category assigned to the item.
Show Source
Nested Schema : CategoryNodeBean
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : Tag
Type: object
Tag.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : TaxonomyInfo
Type: object
TaxonomyInfo
Show Source
Nested Schema : categories
Type: array
Categories in the Taxonomy the item belongs to.
Show Source
Nested Schema : ItemCategoryInfo
Type: object
Show Source
Nested Schema : nodes
Type: array
Nodes in the category assigned to the item.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : VariationsInfo
Type: object
Variations Info.
Show Source
Nested Schema : items
Type: array
Content item variations.
Show Source
Nested Schema : Language
Type: object
LanguageItem
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : VersionInfo
Type: object
VersionInfo
Show Source
Nested Schema : PlaybackBean
Type: object
PlaybackBean
Show Source
Nested Schema : ProcessingBean
Type: object
ProcessingBean
Show Source
  • Read Only: true
    The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.
Nested Schema : StripBean
Type: object
StripBean
Show Source
Nested Schema : AdaptiveStreamsBean
Type: object
AdaptiveStreamsBean
Show Source
Nested Schema : StripFrameBean
Type: object
StripFrameBean
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : WorkflowInfo
Type: object
WorkflowInfo.
Show Source
Nested Schema : data
Type: array
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : Item
Type: object
Discriminator: typeCategory
Item
Show Source
Nested Schema : ItemSubResourceListChangesInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListChannelId
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListCollectionId
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceConnectorFileInfo
Type: object
Item SubResource.
Show Source
Nested Schema : User
Type: object
User object
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : fields
Type: object
Read Only: true
Additional Properties Allowed
Show Source
User-defined fields data. Map. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.
Nested Schema : ItemSubResourceLockInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemMetadataInfo
Type: object
ItemMetadataInfo
Show Source
Nested Schema : ItemSubResourceListAction
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListPublishInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemReferenceInfo
Type: object
ItemReferenceInfo
Show Source
Nested Schema : ItemSubResourceRelationships
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListSuggestedTaxonomyInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListTag
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListTaxonomyInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListVariationsInfo
Type: object
Item SubResource.
Show Source
Nested Schema : ItemSubResourceListVersionInfo
Type: object
Item SubResource.
Show Source
Nested Schema : VideoBean
Type: object
VideoBean
Show Source
Nested Schema : WorkflowField
Type: object
All mapped workflow fields
Show Source
Nested Schema : ItemSubResourceListWorkflowInfo
Type: object
Item SubResource.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : ChangesInfo
Type: object
ChangesInfo
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : ChannelId
Type: object
ChannelId
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : CollectionId
Type: object
CollectionId
Show Source
Nested Schema : ConnectorFileInfo
Type: object
ConnectorFileInfo
Show Source
Nested Schema : additionalProperties
Type: object
Nested Schema : LockInfo
Type: object
LockInfo
Show Source
Nested Schema : EXIFMetadata
Type: object
EXIF Metadata
Show Source
Nested Schema : VideoTranscriptMetadata
Type: object
Video Transcription Metadata
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : AggregationResult
Type: object
Show Source
Nested Schema : ItemExtractedExifBean
Type: object
ItemExtractedExifBean
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : Videotranscript
Type: object
Video transcript
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : Action
Type: object
Action
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : PublishInfo
Type: object
PublishInfo
Show Source
Nested Schema : Relationships
Type: object
Relationships
Show Source
Nested Schema : referencedBy
Type: array
Referenced by ids
Show Source
Nested Schema : Siteplanreference
Type: object
Site plan reference
Show Source
Nested Schema : referencedBySites
Type: array
Referenced by sites
Show Source
Nested Schema : references
Type: array
Reference ids
Show Source
Nested Schema : References
Type: object
References
Show Source
Nested Schema : ReferencedBySites
Type: object
ReferencedBySites
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : SuggestedTaxonomyInfo
Type: object
SuggestedTaxonomyInfo
Show Source
Nested Schema : categories
Type: array
Categories in the Suggested Taxonomy the item belongs to.
Show Source
Nested Schema : ItemSuggestedCategoryInfo
Type: object
Show Source
Nested Schema : nodes
Type: array
Nodes in the category assigned to the item.
Show Source
Nested Schema : CategoryNodeBean
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : Tag
Type: object
Tag.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : TaxonomyInfo
Type: object
TaxonomyInfo
Show Source
Nested Schema : categories
Type: array
Categories in the Taxonomy the item belongs to.
Show Source
Nested Schema : ItemCategoryInfo
Type: object
Show Source
Nested Schema : nodes
Type: array
Nodes in the category assigned to the item.
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : VariationsInfo
Type: object
Variations Info.
Show Source
Nested Schema : items
Type: array
Content item variations.
Show Source
Nested Schema : Language
Type: object
LanguageItem
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : VersionInfo
Type: object
VersionInfo
Show Source
Nested Schema : PlaybackBean
Type: object
PlaybackBean
Show Source
Nested Schema : ProcessingBean
Type: object
ProcessingBean
Show Source
  • Read Only: true
    The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.
Nested Schema : StripBean
Type: object
StripBean
Show Source
Nested Schema : AdaptiveStreamsBean
Type: object
AdaptiveStreamsBean
Show Source
Nested Schema : StripFrameBean
Type: object
StripFrameBean
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : WorkflowInfo
Type: object
WorkflowInfo.
Show Source
Nested Schema : data
Type: array
Show Source

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.
Back to Top

Examples

The following example shows how to update an Item by submitting a PUT request on a REST resource using cURL. 

curl -X PUT -H  'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/items/{id}'

Example 1:

This updates item with id: COREFFFEC388CFD044D8A34D2F8C46EA5786. Replace payload with your own data. 

/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786

Request Payload

{
        "id": "CORE654333E2065D4A5FB6366A1662380A79",
        "name": "Item1_updated",
        "type": "Type1",
        "description": "Item1 updated description",
        "slug": "type1-item1-updated",
        "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
        "language": "en-US",
        "translatable": false
 }

Response Body 

{
        "id": "COREFFFEC388CFD044D8A34D2F8C46EA5786",
        "type": "Type1",
        "name": "Item1_updated",
        "description": "Item1 updated description",
        "typeCategory": "ContentType",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2018-11-16T06:19:15.641Z",
          "timezone": "UTC"
        },
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2018-11-18T20:00:33.278Z",
          "timezone": "UTC"
        },
        "slug": "type1-item1-updated",
        "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
        "status":"draft",
        "isPublished": false,
        "languageIsMaster": true,
        "language": "en-US",
        "translatable": false,
        "version": "0.2",
        "fileExtension": "contentItem",
        "variations": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "tags": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/COREFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/COREFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Example 2:

This updates item with id: CORE5793C78A6C3944038641DE1A48F0915B. Replace payload with your own data. 

/content/management/api/v1.1/items/CORE5793C78A6C3944038641DE1A48F0915B

Request Payload

{
        "id": "CORE5793C78A6C3944038641DE1A48F0915B",
        "name": "Item2_updated",
        "type": "Type2",
        "description": "Updated description of Item2",
        "typeCategory": "ContentType",
        "slug": "type2-item2-updated",
        "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
        "language": "en-US",
        "translatable": false,
        "fields": {
          "type2_text": "sample_string1 updated",
          "type2_largeText": "sample_string2 updated",
          "type2_number":19,
          "type2_decimal":19.44,
          "type2_boolean":false,
          "type2_reference":{
            "id": "CORE249125675D0E481BBEF19598AAD2EB1E",
            "type": "TypeB"
          },
          "type2_media":{
            "id": "CONT32F5F5D22C3E492F454CD9F9A874531F",
            "type": "DigitalAsset"
          },
          "type2_dateTime":{
            "value": "2018-11-30T11:51:21+05:30",
            "timezone": "Asia/Colombo"
          }
        }

Example 3:

This updates digital item with id: CONT92D59C9D771844019E16BD47E2AA36C2 with updated name and with user fields data in given payload and the updated item will have updated name given in payload with file extension appended to it if not present. Replace payload with your own data.

/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2

Request Payload

{
        "id": "CONT92D59C9D771844019E16BD47E2AA36C2",
        "type": "DigitalType2",
        "name": "Item2 updated",
        "description": "description of Item2",
        "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
        "translatable": false,
        "fields": {
          "type2_text": "sample_string1",
          "type2_largeText": "sample_string2",
          "type2_number":19,
          "type2_decimal":18.34,
          "type2_boolean":true,
          "type2_reference":{
            "id": "CORE039124915D0E481BBEF19598AAD2EB1E",
            "type": "TypeA"
          },
          "type2_dateTime":{
            "value": "2018-11-30T11:51:21+05:30",
            "timezone": "Asia/Calcutta"
          }
        }
      }

Request Headers

{
    "Content-Type": "application/json",
    "X-Requested-With": "XMLHttpRequest"
}

Response Body

{
        "id": "CONT92D59C9D771844019E16BD47E2AA36C2",
        "type": "DigitalType2",
        "typeCategory": "DigitalAssetType",
        "name": "Item2updated.png",
        "description": "description of Item2",
        "slug": "image-item2",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2018-11-16T06:19:15.641Z",
          "timezone": "UTC"
        },
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2018-11-16T06:19:15.641Z",
          "timezone": "UTC"
        },
        "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
        "status":"draft",
        "isPublished": false,
        "languageIsMaster": true,
        "translatable": false,
        "language": "en-US",
        "version": "0.1",
        "fileExtension": "png",
        "fields": {
          "type2_text": "sample_string1",
          "type2_largeText": "sample_string2",
          "type2_number":19,
          "type2_decimal":18.34,
          "type2_boolean":true,
          "type2_reference":{
            "id": "CORE039124915D0E481BBEF19598AAD2EB1E",
            "type": "TypeA"
          },
          "type2_dateTime":{
            "value": "2018-11-30T11:51:21+05:30",
            "timezone": "Asia/Calcutta"
          },
          "metadata": {
            "width": "217",
            "height": "233"
          },
          "size": 5313,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/native/Item1.png",
                "rel": "self",
                "method": "GET",
                "mediaType": "image/png"
              }
            ]
          },
          "renditions": [
            {
              "name": "Thumbnail",
              "formats": [
                {
                  "format": "jpg",
                  "size": 0,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "150",
                    "height": "161"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Thumbnail/Item1.png?format=jpg&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "150",
                    "height": "161"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Thumbnail/Item1.png?format=webp&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Medium",
              "formats": [
                {
                  "format": "jpg",
                  "size": 0,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "217",
                    "height": "233"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Medium/Item1.png?format=jpg&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "217",
                    "height": "233"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Medium/Item1.png?format=webp&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Large",
              "formats": [
                {
                  "format": "jpg",
                  "size": 0,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "217",
                    "height": "233"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Large/Item1.png?format=jpg&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "217",
                    "height": "233"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Large/Item1.png?format=webp&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Small",
              "formats": [
                {
                  "format": "jpg",
                  "size": 0,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "217",
                    "height": "233"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Small/Item1.png?format=jpg&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "217",
                    "height": "233"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/management/api/v1.1/assets/CONT92D59C9D771844019E16BD47E2AA36C2/Small/Item1.png?format=webp&type=responsiveimage",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            }
          ],
          "mimeType": "image/png",
          "fileGroup": "Images",
          "fileType": "png"
        },
        "variations": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "tags": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/CONT92D59C9D771844019E16BD47E2AA36C2",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Example 4:

This tried to update digital item with id: CONT92D59C9D771844019E16BD47E2AA36C2 without name in given payload and the update would fail as update without name is not allowed.

/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2

Request Payload

{
        "id": "CONT92D59C9D771844019E16BD47E2AA36C2",
        "type": "DigitalType2",
        "description": "description of Item2",
        "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
        "translatable": false,
        "fields": {
          "type2_text": "sample_string1",
          "type2_largeText": "sample_string2",
          "type2_number":19,
          "type2_decimal":18.34,
          "type2_boolean":true,
          "type2_reference":{
            "id": "CORE039124915D0E481BBEF19598AAD2EB1E",
            "type": "TypeA"
          },
          "type2_dateTime":{
            "value": "2018-11-30T11:51:21+05:30",
            "timezone": "Asia/Calcutta"
          }
        }
      }

Request Headers

{
   "Content-Type": "application/json",
   "X-Requested-With": "XMLHttpRequest"
}

Response Body

 {
    "detail": "Item name cannot be empty or null",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title": "Item update failed",
    "status": 400
}

Example 5:

This updates content item with id CORECA548D096E4948EFB9BEF43B2D4FD87F on some of its fields. This is a sample response when Granular Permissions feature is enabled. Also all empty sub resources are skipped in the response for clarity. Replace payload with your own data. 

/content/management/api/v1.1/items/CORECA548D096E4948EFB9BEF43B2D4FD87F

Request Payload

{
	    "id": "CORECA548D096E4948EFB9BEF43B2D4FD87F",
	    "type": "TypeCCC",
	    "typeCategory": "ContentType",
	    "name": "Item C1",
	    "description": "updated desc",
	    "repositoryId": "6589BF25F2854E6AA928EE7412CBE6AE",
	    "language": "en-US",
	    "fields": {
	        "multi_ref_ccc": [
	            {
	                "id": "CORE9478B48DC80041CAAF38E66E363ABD99",
	                "type": "TypeAAA",
	                "typeCategory": "ContentType",
	                "name": "Item A1"
	            },
	            {
	                "id": "COREA0B53F00198F4771962526DDF83416C5",
	                "type": "TypeBBB",
	                "typeCategory": "ContentType",
	                "name": "Item B2"
	            }
	        ],
	        "multi_media_ccc": [
	            {
	                "id": "CONT82DF3215D31B45A4A4518F01B156A8F1",
	                "type": "Image",
	                "typeCategory": "DigitalAssetType",
	                "name": "WMATA-2ct.jpg"
	            }
	        ],
	        "txtfield": "c1 text value (updated)",
	        "ref_field_ccc": null
	    }
      }

Response Body

{
	    "id": "CORECA548D096E4948EFB9BEF43B2D4FD87F",
	    "type": "TypeCCC",
	    "typeCategory": "ContentType",
	    "name": "Item C1",
	    "description": "updated desc",
	    "createdBy": "cecusername",
	    "createdDate": {
	        "value": "2021-07-13T21:13:33.351Z",
	        "timezone": "UTC"
	    },
	    "updatedBy": "cecusername",
	    "updatedDate": {
	        "value": "2021-07-13T21:46:38.933Z",
	        "timezone": "UTC"
	    },
	    "slug": "3000000406001-item-c1",
	    "repositoryId": "6589BF25F2854E6AA928EE7412CBE6AE",
	    "language": "en-US",
	    "status": "draft",
	    "isPublished": false,
	    "languageIsMaster": true,
	    "version": "0.2",
           "fileExtension": "contentItem",
	    "scheduled": false,
	    "fields": {
	        "txtfield": "c1 text value (updated)",
	        "ref_field_ccc": null,
	        "multi_ref_ccc": [
	            {
	                "id": "CORE9478B48DC80041CAAF38E66E363ABD99",
	                "type": "TypeAAA",
	                "typeCategory": "ContentType",
	                "name": "Item A1",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE9478B48DC80041CAAF38E66E363ABD99",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "COREA0B53F00198F4771962526DDF83416C5",
	                "type": "TypeBBB",
	                "typeCategory": "ContentType",
	                "name": "Item B2",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/COREA0B53F00198F4771962526DDF83416C5",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ],
	        "multi_media_ccc": [
	            {
	                "id": "CONT82DF3215D31B45A4A4518F01B156A8F1",
	                "type": "Image",
	                "typeCategory": "DigitalAssetType",
	                "name": "WMATA-2ct.jpg",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONT82DF3215D31B45A4A4518F01B156A8F1",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ]
	    },
	    "versionInfo": {
	        "data": [
	            {
	                "latestVersion": "0.2"
	            }
	        ],
	        "links": [
	            {
	                "href": "http://<hostname>/content/management/api/v1.1/items/CORECA548D096E4948EFB9BEF43B2D4FD87F/versionInfo",
	                "rel": "self",
	                "method": "GET",
	                "mediaType": "application/json"
	            }
	        ]
	    },
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/items/CORECA548D096E4948EFB9BEF43B2D4FD87F",
	            "rel": "self",
	            "method": "PUT",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/items/CORECA548D096E4948EFB9BEF43B2D4FD87F",
	            "rel": "canonical",
	            "method": "PUT",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/items/CORECA548D096E4948EFB9BEF43B2D4FD87F",
	            "rel": "describedby",
	            "method": "GET",
	            "mediaType": "application/schema+json"
	        }
	    ],
	    "currentVersion": "0.2",
	    "latestVersion": "0.2",
	    "mimeType": "contentItem",
	    "fileGroup": "contentItem",
	    "varSetId": "C708B5DC8C332217E053A79C6F645F7C"
      }
    }
  ]
}

Example 6:

This updates digital item with id: CONT92D59C9D771844019E16BD47E2AA36C2 with user fields data in given payload. Replace payload with your own data.

/content/management/api/v1.1/items/CONT92D59C9D771844019E16BD47E2AA36C2

Request Payload

{
        "id": "CONT92D59C9D771844019E16BD47E2AA36C2",
        "type": "DigitalType2",
        "name": "Item2",
        "description": "description of Item2",
        "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
        "translatable": false,
        "fields": {
          "type2_text": "sample_string1",
          "type2_largeText": "sample_string2",
          "type2_number":19,
          "type2_decimal":18.34,
          "type2_boolean":true,
          "type2_reference":{
            "id": "CORE039124915D0E481BBEF19598AAD2EB1E",
            "type": "TypeA"
          },
          "type2_dateTime":{
            "value": "2018-11-30T11:51:21+05:30",
            "timezone": "Asia/Calcutta"
          }
        }
      }

Request Headers

{
   "Content-Type": "application/json",
   "X-Requested-With": "XMLHttpRequest"
}
Back to Top