Update an Item
/content/management/api/v1.1/items/{id}
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
- application/json
-
id: string
id of the item.
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
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.
object
typeCategory
-
changes(optional):
object ItemSubResourceListChangesInfo
Item SubResource.
-
channels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
collections(optional):
object ItemSubResourceListCollectionId
Item SubResource.
-
connectorFileInfo(optional):
object ItemSubResourceConnectorFileInfo
Item SubResource.
-
connectorId(optional):
string
Connector Id of the item.
-
connectorSyncEnabled(optional):
boolean
Connector Sync Enabled flag of the item.
-
createdBy(optional):
string
Created by.
-
createdByUser(optional):
object User
User object
-
createdDate(optional):
object date
date
-
description(optional):
string
description of the item
-
fields(optional):
object fields
Read Only:
true
Additional Properties Allowed: additionalPropertiesUser-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. -
fileExtension(optional):
string
Extension of the file.
-
id(optional):
string
id of the item. It is a required property in the get response and put request whereas it is not required in the post request.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
language(optional):
string
Language of the item.
-
languageIsMaster(optional):
boolean
Whether the item is master.
-
links(optional):
array links
Links
-
lockInfo(optional):
object ItemSubResourceLockInfo
Item SubResource.
-
metadata(optional):
object ItemMetadataInfo
ItemMetadataInfo
-
name(optional):
string
Name of the item. It is a required property in the get response and post/put request.
-
permissions(optional):
object ItemSubResourceListAction
Item SubResource.
-
publishedChannels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
publishInfo(optional):
object ItemSubResourceListPublishInfo
Item SubResource.
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
-
relationships(optional):
object ItemSubResourceRelationships
Item SubResource.
-
repositoryId(optional):
string
Repository of the item. It is a required property in the get response and post/put request.
-
scheduled(optional):
boolean
-
slug(optional):
string
URL slug of the item.
-
sourceId(optional):
string
Source Id.
-
status(optional):
string
Current status of the item.
-
suggestedTaxonomies(optional):
object ItemSubResourceListSuggestedTaxonomyInfo
Item SubResource.
-
tags(optional):
object ItemSubResourceListTag
Item SubResource.
-
taxonomies(optional):
object ItemSubResourceListTaxonomyInfo
Item SubResource.
-
translatable(optional):
boolean
Whether the item is translatable.
-
type(optional):
string
Name of the type. It is a required property in the get response and post/put request.
-
typeCategory(optional):
string
Read Only:
true
-
updatedBy(optional):
string
Updated by.
-
updatedByUser(optional):
object User
User object
-
updatedDate(optional):
object date
date
-
variations(optional):
object ItemSubResourceListVariationsInfo
Item SubResource.
-
version(optional):
string
The current revision version of this item.
-
versionInfo(optional):
object ItemSubResourceListVersionInfo
Item SubResource.
-
video(optional):
object VideoBean
VideoBean
-
workflowInstances(optional):
object WorkflowField
All mapped workflow fields
-
workflows(optional):
object ItemSubResourceListWorkflowInfo
Item SubResource.
object
-
displayName(optional):
string
Read Only:
true
display name of the user. -
email(optional):
string
Read Only:
true
email of the user. -
userID(optional):
integer(int64)
Read Only:
true
id of the user. -
userName(optional):
string
Read Only:
true
name of the user.
object
true
object
-
exif(optional):
object EXIFMetadata
EXIF Metadata
-
links(optional):
array links
Links
-
transcripts(optional):
object VideoTranscriptMetadata
Video Transcription Metadata
object
-
isAccessible(optional):
boolean
Whether the item is accessible.
object
-
duration(optional):
string
Read Only:
true
The duration of the video in ISO 8601 format. -
isFormatSupported(optional):
boolean
Read Only:
true
A boolean expressing if the video file format is supported. -
playback(optional):
object PlaybackBean
PlaybackBean
-
processing(optional):
object ProcessingBean
ProcessingBean
-
strip(optional):
object StripBean
StripBean
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
links(optional):
array links
-
source(optional):
string
Sub-resource associated to this item which is source of this change.
-
type(optional):
string
Type of change tracked for the given source.
-
value(optional):
boolean
True indicates a change. False indicates no current changes for this source/type.
object
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
object
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
object
-
connectorId(optional):
string
Connector id.
-
id(optional):
string
File id.
-
inUse(optional):
boolean
Represents whether the latest version of asset is using the file content.
-
version(optional):
integer(int32)
File version
object
object
-
isLocked(optional):
boolean
Represents whether the item is locked or not.
-
lockedBy(optional):
string
Locked by user
-
lockedDate(optional):
object date
date
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
array
-
Array of:
object ItemExtractedExifBean
ItemExtractedExifBean
array
-
Array of:
object Link
Link of the resource.
array
object
-
floatValue(optional):
number(float)
The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision.
-
handle(optional):
string
The handle or EXIF field name. This value is not translatable.
-
integerValue(optional):
integer(int32)
The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point.
-
links(optional):
array links
Links
-
rawId(optional):
string
The ID of the EXIF field. Uniquely identifies one EXIF field.
-
rawValue(optional):
string
The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value.
-
stringValue(optional):
string
The text value of the EXIF field. This value will be a text representation of the EXIF field value.
-
type(optional):
string
The data type of the EXIF field. (date, integer, float, string).
-
value(optional):
string
The display value of the EXIF field. This value will be a text representation of the actual type value of the EXIF field (date, int, float, string).
array
-
Array of:
object Videotranscript
Video transcript
array
-
Array of:
object Link
Link of the resource.
array
object
-
end(optional):
string
End of each transcript node.
-
id(optional):
string
Id of each transcript node.
-
links(optional):
array links
Links
-
start(optional):
string
Start of each transcript node.
-
text(optional):
string
Text of each transcript node.
object
-
action(optional):
string
Allowed Values:
[ "view", "update", "create", "delete" ]
action is allowed on the resource
object
-
channel(optional):
string
Target name
-
links(optional):
array links
Links
-
publishedBy(optional):
string
Published by
-
publishedDate(optional):
object date
date
-
slug(optional):
string
Published slug
-
version(optional):
string
Published version
object
-
referencedBy(optional):
array referencedBy
Referenced by ids
-
referencedBySitePlan(optional):
object Siteplanreference
Site plan reference
-
referencedBySites(optional):
array referencedBySites
Referenced by sites
-
references(optional):
array references
Reference ids
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the site plan.
-
links(optional):
array links
array
-
Array of:
object ReferencedBySites
ReferencedBySites
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
object
-
component(optional):
string
Component of the item
-
pageId(optional):
string
Page the item added to
-
site(optional):
string
Site the item added to
array
-
Array of:
object SuggestedTaxonomyInfo
SuggestedTaxonomyInfo
object
-
categories(optional):
array categories
Categories in the Suggested Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
array
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
isRejected(optional):
boolean
Status of the Suggested Category for the Item.
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
-
order(optional):
integer(int32)
Probability order of the Suggested Category across all the Taxonomies assigned to the repository.
object
-
apiName(optional):
string
The apiName of the Category node.
-
id(optional):
string
The id of the Category node.
-
name(optional):
string
The name of the Category node.
object
-
language:
string
language of the tag.
-
links(optional):
array links
Links
-
name:
string
Name of the tag.
object
-
categories(optional):
array categories
Categories in the Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
object
-
items(optional):
array items
Content item variations.
-
links(optional):
array links
-
masterItem(optional):
string
Master item.
-
setId(optional):
string
Variation set id.
-
varType(optional):
string
Variation type name.
array
-
Array of:
object Language
LanguageItem
object
-
id(optional):
string
id of the item.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
links(optional):
array links
-
name(optional):
string
name of the item.
-
status(optional):
string
status of item
-
value(optional):
string
Language value
object
-
latestVersion(optional):
string
Latest version
-
publishedVersion(optional):
string
Published version
object
-
adaptiveStreams(optional):
object AdaptiveStreamsBean
AdaptiveStreamsBean
object
-
progress(optional):
string
Read Only:
true
The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.
object
-
frame(optional):
object StripFrameBean
StripFrameBean
object
-
dash(optional):
object PlaybackBean
PlaybackBean
-
hls(optional):
object PlaybackBean
PlaybackBean
object
-
count(optional):
integer(int32)
Read Only:
true
The number of frames in the strip image. -
height(optional):
integer(int32)
Read Only:
true
The height of the strip image. -
width(optional):
integer(int32)
Read Only:
true
The width of the strip image.
array
-
Array of:
object WorkflowInfo
WorkflowInfo.
array
-
Array of:
object Link
Link of the resource.
array
object
-
id(optional):
string
Workflow id.
-
instanceId:
string
Workflow instance id.
-
isCompleted(optional):
boolean
If workflow instance is completed or not in OIC.
-
links(optional):
array links
Links
-
name(optional):
string
Workflow name.
-
status(optional):
string
Workflow status.
-
submittedBy(optional):
string
Submitted by user
-
submittedDate(optional):
object date
date
Response
- application/json
200 Response
object
typeCategory
-
changes(optional):
object ItemSubResourceListChangesInfo
Item SubResource.
-
channels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
collections(optional):
object ItemSubResourceListCollectionId
Item SubResource.
-
connectorFileInfo(optional):
object ItemSubResourceConnectorFileInfo
Item SubResource.
-
connectorId(optional):
string
Connector Id of the item.
-
connectorSyncEnabled(optional):
boolean
Connector Sync Enabled flag of the item.
-
createdBy(optional):
string
Created by.
-
createdByUser(optional):
object User
User object
-
createdDate(optional):
object date
date
-
description(optional):
string
description of the item
-
fields(optional):
object fields
Read Only:
true
Additional Properties Allowed: additionalPropertiesUser-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. -
fileExtension(optional):
string
Extension of the file.
-
id(optional):
string
id of the item. It is a required property in the get response and put request whereas it is not required in the post request.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
language(optional):
string
Language of the item.
-
languageIsMaster(optional):
boolean
Whether the item is master.
-
links(optional):
array links
Links
-
lockInfo(optional):
object ItemSubResourceLockInfo
Item SubResource.
-
metadata(optional):
object ItemMetadataInfo
ItemMetadataInfo
-
name(optional):
string
Name of the item. It is a required property in the get response and post/put request.
-
permissions(optional):
object ItemSubResourceListAction
Item SubResource.
-
publishedChannels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
publishInfo(optional):
object ItemSubResourceListPublishInfo
Item SubResource.
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
-
relationships(optional):
object ItemSubResourceRelationships
Item SubResource.
-
repositoryId(optional):
string
Repository of the item. It is a required property in the get response and post/put request.
-
scheduled(optional):
boolean
-
slug(optional):
string
URL slug of the item.
-
sourceId(optional):
string
Source Id.
-
status(optional):
string
Current status of the item.
-
suggestedTaxonomies(optional):
object ItemSubResourceListSuggestedTaxonomyInfo
Item SubResource.
-
tags(optional):
object ItemSubResourceListTag
Item SubResource.
-
taxonomies(optional):
object ItemSubResourceListTaxonomyInfo
Item SubResource.
-
translatable(optional):
boolean
Whether the item is translatable.
-
type(optional):
string
Name of the type. It is a required property in the get response and post/put request.
-
typeCategory(optional):
string
Read Only:
true
-
updatedBy(optional):
string
Updated by.
-
updatedByUser(optional):
object User
User object
-
updatedDate(optional):
object date
date
-
variations(optional):
object ItemSubResourceListVariationsInfo
Item SubResource.
-
version(optional):
string
The current revision version of this item.
-
versionInfo(optional):
object ItemSubResourceListVersionInfo
Item SubResource.
-
video(optional):
object VideoBean
VideoBean
-
workflowInstances(optional):
object WorkflowField
All mapped workflow fields
-
workflows(optional):
object ItemSubResourceListWorkflowInfo
Item SubResource.
object
-
displayName(optional):
string
Read Only:
true
display name of the user. -
email(optional):
string
Read Only:
true
email of the user. -
userID(optional):
integer(int64)
Read Only:
true
id of the user. -
userName(optional):
string
Read Only:
true
name of the user.
object
true
object
-
exif(optional):
object EXIFMetadata
EXIF Metadata
-
links(optional):
array links
Links
-
transcripts(optional):
object VideoTranscriptMetadata
Video Transcription Metadata
object
-
isAccessible(optional):
boolean
Whether the item is accessible.
object
-
duration(optional):
string
Read Only:
true
The duration of the video in ISO 8601 format. -
isFormatSupported(optional):
boolean
Read Only:
true
A boolean expressing if the video file format is supported. -
playback(optional):
object PlaybackBean
PlaybackBean
-
processing(optional):
object ProcessingBean
ProcessingBean
-
strip(optional):
object StripBean
StripBean
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
links(optional):
array links
-
source(optional):
string
Sub-resource associated to this item which is source of this change.
-
type(optional):
string
Type of change tracked for the given source.
-
value(optional):
boolean
True indicates a change. False indicates no current changes for this source/type.
object
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
object
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
object
-
connectorId(optional):
string
Connector id.
-
id(optional):
string
File id.
-
inUse(optional):
boolean
Represents whether the latest version of asset is using the file content.
-
version(optional):
integer(int32)
File version
object
object
-
isLocked(optional):
boolean
Represents whether the item is locked or not.
-
lockedBy(optional):
string
Locked by user
-
lockedDate(optional):
object date
date
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
array
-
Array of:
object ItemExtractedExifBean
ItemExtractedExifBean
array
-
Array of:
object Link
Link of the resource.
array
object
-
floatValue(optional):
number(float)
The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision.
-
handle(optional):
string
The handle or EXIF field name. This value is not translatable.
-
integerValue(optional):
integer(int32)
The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point.
-
links(optional):
array links
Links
-
rawId(optional):
string
The ID of the EXIF field. Uniquely identifies one EXIF field.
-
rawValue(optional):
string
The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value.
-
stringValue(optional):
string
The text value of the EXIF field. This value will be a text representation of the EXIF field value.
-
type(optional):
string
The data type of the EXIF field. (date, integer, float, string).
-
value(optional):
string
The display value of the EXIF field. This value will be a text representation of the actual type value of the EXIF field (date, int, float, string).
array
-
Array of:
object Videotranscript
Video transcript
array
-
Array of:
object Link
Link of the resource.
array
object
-
end(optional):
string
End of each transcript node.
-
id(optional):
string
Id of each transcript node.
-
links(optional):
array links
Links
-
start(optional):
string
Start of each transcript node.
-
text(optional):
string
Text of each transcript node.
object
-
action(optional):
string
Allowed Values:
[ "view", "update", "create", "delete" ]
action is allowed on the resource
object
-
channel(optional):
string
Target name
-
links(optional):
array links
Links
-
publishedBy(optional):
string
Published by
-
publishedDate(optional):
object date
date
-
slug(optional):
string
Published slug
-
version(optional):
string
Published version
object
-
referencedBy(optional):
array referencedBy
Referenced by ids
-
referencedBySitePlan(optional):
object Siteplanreference
Site plan reference
-
referencedBySites(optional):
array referencedBySites
Referenced by sites
-
references(optional):
array references
Reference ids
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the site plan.
-
links(optional):
array links
array
-
Array of:
object ReferencedBySites
ReferencedBySites
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
object
-
component(optional):
string
Component of the item
-
pageId(optional):
string
Page the item added to
-
site(optional):
string
Site the item added to
array
-
Array of:
object SuggestedTaxonomyInfo
SuggestedTaxonomyInfo
object
-
categories(optional):
array categories
Categories in the Suggested Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
array
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
isRejected(optional):
boolean
Status of the Suggested Category for the Item.
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
-
order(optional):
integer(int32)
Probability order of the Suggested Category across all the Taxonomies assigned to the repository.
object
-
apiName(optional):
string
The apiName of the Category node.
-
id(optional):
string
The id of the Category node.
-
name(optional):
string
The name of the Category node.
object
-
language:
string
language of the tag.
-
links(optional):
array links
Links
-
name:
string
Name of the tag.
object
-
categories(optional):
array categories
Categories in the Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
object
-
items(optional):
array items
Content item variations.
-
links(optional):
array links
-
masterItem(optional):
string
Master item.
-
setId(optional):
string
Variation set id.
-
varType(optional):
string
Variation type name.
array
-
Array of:
object Language
LanguageItem
object
-
id(optional):
string
id of the item.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
links(optional):
array links
-
name(optional):
string
name of the item.
-
status(optional):
string
status of item
-
value(optional):
string
Language value
object
-
latestVersion(optional):
string
Latest version
-
publishedVersion(optional):
string
Published version
object
-
adaptiveStreams(optional):
object AdaptiveStreamsBean
AdaptiveStreamsBean
object
-
progress(optional):
string
Read Only:
true
The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.
object
-
frame(optional):
object StripFrameBean
StripFrameBean
object
-
dash(optional):
object PlaybackBean
PlaybackBean
-
hls(optional):
object PlaybackBean
PlaybackBean
object
-
count(optional):
integer(int32)
Read Only:
true
The number of frames in the strip image. -
height(optional):
integer(int32)
Read Only:
true
The height of the strip image. -
width(optional):
integer(int32)
Read Only:
true
The width of the strip image.
array
-
Array of:
object WorkflowInfo
WorkflowInfo.
array
-
Array of:
object Link
Link of the resource.
array
object
-
id(optional):
string
Workflow id.
-
instanceId:
string
Workflow instance id.
-
isCompleted(optional):
boolean
If workflow instance is completed or not in OIC.
-
links(optional):
array links
Links
-
name(optional):
string
Workflow name.
-
status(optional):
string
Workflow status.
-
submittedBy(optional):
string
Submitted by user
-
submittedDate(optional):
object date
date
400 Response
403 Response
404 Response
500 Response
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" }