Create a Digital Item

post

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

Creates a Digital item using a multipart request to specify item and file information.
Notes :
The request is a multipart HTTP request where one part is a JSON object (item) with item details (refer - examples) and the other part is the content of the file itself (file).
If language node is not passed then we set repository default language

Request

Supported Media Types
Query Parameters
Header Parameters
Form Parameters
  • File uploaded
  • Creates an item with the given information in the payload. The fields id, createdBy, createdDate, updatedBy, updatedDate, typeCategory, variations, relationships, publishInfo, suggestedTaxonomies and links will be ignored even if given in the payload. If the name field is missing in payload, then the name of the created item will be based on the name of the file uploaded (fileName in the file part of form-data). Extension of the file uploaded will be appended to the name of the item, if not already present. The Model has to be similar to the create Content Item Payload.
    Note: Created item might be automatically submitted to a workflow depending on the repository workflows configuration.
Back to Top

Response

Supported Media Types

201 Response

Created.
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 create a digital item with the given payload.

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

Example 1

This creates a translatable digital item with a specific slug having no user fields for given payload. The request is a multipart request with a specified boundary delimiter of the following general form. Replace payload with your own data.

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

Request Header

The request is a multipart request with a specified boundary delimiter of the following general form. Replace payload with your own data.

Content-Type: multipart/form-data; boundary=---1234567890
X-Requested-With: XMLHttpRequest

Request Payload

-----1234567890
Content-Disposition: form-data; name="item"
Content-Type: application/json
{
  "name": "example.png",
  "type": "Image",
  "description": "Item1 description",
  "slug": "Image-item1",
  "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49"
}
-----1234567890
Content-Disposition: form-data; name="file"; filename="example.png"
Content-Type: image/png
 
<File Content>
-----1234567890--    

Response Body

{
        "id": "CONTFFFEC388CFD044D8A34D2F8C46EA5786",
        "type": "Image",
        "typeCategory": "DigitalAssetType",
        "name": "example.png",
        "description": "Item1 description",
        "slug": "Image-item1",
        "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": true,
        "language": "en-US",
        "version": "0.1",
        "fileExtension": "png",
        "fields": {
          "metadata": {
            "width": "217",
            "height": "233"
          },
          "size": 5313,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/management/api/v1.1/assets/CONTFFFEC388CFD044D8A34D2F8C46EA5786/native/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Thumbnail/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Thumbnail/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Medium/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Medium/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Large/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Large/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Small/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/Small/example.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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "tags": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Example 2

This creates a translatable digital item having user fields data for given payload. The request is a multipart request with a specified boundary delimiter of the following general form. Replace payload with your own data.

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

Request Header

The request is a multipart request with a specified boundary delimiter of the following general form:

Content-Type: multipart/form-data; boundary=---1234567890
X-Requested-With: XMLHttpRequest

Request Body

-----1234567890
Content-Disposition: form-data; name="item"
Content-Type: application/json
{
  "name": "item",
  "type": "DigitalType2",
  "description": "description of Item2",
  "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
  "translatable": true,
  "fields": {
    "type2_text": "sample_string1",
    "type2_largeText": "sample_string2",
    "type2_number":18,
    "type2_decimal":18.34,
    "type2_boolean":true,
    "type2_dateTime":{
      "value": "2018-11-30T11:51:21+05:30",
      "timezone": "Asia/Calcutta"
    }
  }
}
-----1234567890
Content-Disposition: form-data; name="file"; filename="example1.png"
Content-Type: image/png
 
<File Content>
-----1234567890--

Example 3

This creates a non-translatable digital item with no user fields for given payload along with collection, tags, channels, taxonomies. Replace payload with your own data.

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

Request Header

The request is a multipart request with a specified boundary delimiter of the following general form:

Content-Type: multipart/form-data; boundary=---1234567890
X-Requested-With: XMLHttpRequest

Request Body

-----1234567890
Content-Disposition: form-data; name="item"
Content-Type: application/json
{
   "type": "DigitalType2",
   "description": "description of Item3",
   "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
   "translatable": false,
   "tags": {
     "data": [{"name": "tag1"}]
   },
   "channels": {
     "data" : [{"id":"RCHANNEL692013F4E16F407BBBF26E6543415CFA"}]
   },
   "collections": {
     "data": [{"id": "COLL10879C30499B443CBA6A4337B795B9AB"}]
   },
   "taxonomies": {
      "data": [
        {
          "id": "45D8B115E52842299FA6E47653450F88",
          "categories": [{"id": "60BA3C5FFF7D47E3BD25D0154DC700EE"}]
        }
      ]
   }
}
-----1234567890
Content-Disposition: form-data; name="file"; filename="example1.png"
Content-Type: image/png
 
<File Content>
-----1234567890--

Example 4

This creates a translatable digital item with filename and name in item json being different and with same extension for given payload and created digital item will have name given in item json along with the extension of the file. The request is a multipart request with a specified boundary delimiter of the following general form. Replace payload with your own data.

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

Request Payload

-----1234567890
Content-Disposition: form-data; name="item"
Content-Type: application/json
{
  "name": "Item1.png"
  "type": "Image",
  "description": "Item1 description",
  "slug": "Image-item1",
  "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
 }
-----1234567890
Content-Disposition: form-data; name="file"; filename="example.png"
Content-Type: image/png
 
<File Content>
-----1234567890--    

Request Headers

{
  "Content-Type":"multipart/form-data; boundary=---1234567890",
  "X-Requested-With":"XMLHttpRequest"
}

Response Body

 {
        "id": "CONTFFFEC388CFD044D8A34D2F8C46EA5786",
        "type": "Image",
        "typeCategory": "DigitalAssetType",
        "name": "Item1.png",
        "description": "Item1 description",
        "slug": "image-item1",
        "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": true,
        "language": "en-US",
        "version": "0.1",
        "fileExtension": "png",
        "fields": {
          "metadata": {
            "width": "217",
            "height": "233"
          },
          "size": 5313,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/management/api/v1.1/assets/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "tags": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Example 5

This creates a translatable digital item with filename and name in item json being different for given payload and created digital item will have name given in item json along with the extension of the file. The request is a multipart request with a specified boundary delimiter of the following general form. Replace payload with your own data.

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

Request Payload

-----1234567890
Content-Disposition: form-data; name="item"
Content-Type: application/json
{
  "name": "Item1"
  "type": "Image",
  "description": "Item1 description",
  "slug": "Image-item1",
  "repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
 }
-----1234567890
Content-Disposition: form-data; name="file"; filename="example.png"
Content-Type: image/png
 
<File Content>
-----1234567890--    

Request Headers

{
    "Content-Type":"multipart/form-data; boundary=---1234567890",
    "X-Requested-With":"XMLHttpRequest"
}

Response Body

{
        "id": "CONTFFFEC388CFD044D8A34D2F8C46EA5786",
        "type": "Image",
        "typeCategory": "DigitalAssetType",
        "name": "Item1.png",
        "description": "Item1 description",
        "slug": "image-item1",
        "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": true,
        "language": "en-US",
        "version": "0.1",
        "fileExtension": "png",
        "fields": {
          "metadata": {
            "width": "217",
            "height": "233"
          },
          "size": 5313,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/management/api/v1.1/assets/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/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/CONTFFFEC388CFD044D8A34D2F8C46EA5786/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishInfo": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "tags": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Postman Examples

See Postman Examples in the Get Started section.

Back to Top