Read an Item by slug
get
/content/management/api/v1.1/items/.by.slug/{slug}
Read an item by slug.
Request
Path Parameters
-
slug: string
Slug value of the latest management Item. Any special characters in slug must be encoded.
Query Parameters
-
asOf(optional): string
This parameter describes a specific item revision. Currently it only supports this value, latestPublished, which means the latest published version. The slug value passed in the url should always be that of the latest management item.
-
asOfDate(optional): string
This parameter defines a point of time as of which the item revision should be returned. The date string format is yyyy-MM-dd'T'HH:mm:ss'Z' or yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. The slug value passed in the url should always be that of the latest management item.
-
expand(optional): string
Expand parameter provides the option of getting child resources (referenced items) inline with the item's response. Accepts a comma-separated list of field names or all. All the user-defined field names should be provided with prefix fields and followed by a period (.). If these fields are of a reference type, then the resource expands their data inline in the response. Field names are case-sensitive. When expand is specified as all (with all in lower case), all the fields of the reference type of the requested item are expanded. When expand is not specified, item response contains links to the referenced items. Expansion of this form is supported for one level only; a request to expand beyond the first level of referenced fields will produce the response HTTP 400. When the expand parameter contains a nonexistent field as per type definition of the requested item, the resource produces HTTP 400.
Example : expand=fields.field1,fields.field2
Returns field1 and field2: names of the user-defined fields in the type to which this item belongs.
Example : expand=taxonomies
Returns taxonomies field containing all categories assigned to this item.
Example : expand=changes
Returns changes field containing information about categorization changes to this item.
Example : expand=metadata
Returns metadata field containing information about available metadata for this item such as EXIF data.
Example : expand=metadata.exif
Returns EXIF metadata available for this item.
Example : expand=suggestedTaxonomies
Returns suggested taxonomies field containing all categories suggested for this item.
Example : expand=workflows
Returns workflows associated with this item.
Example : expand=permissions
Returns allowed actions on this item.
Example : expand=channels
Returns targeted channels of this item along with preview links to preview the item on a particular channel.
Example : expand=versionInfo
Returns version information of a given item.
Example : expand=publishedChannels
Returns all published channels of a given item.
Example : expand=publishInfo
Returns publish information of a given item.
Example : expand=collections
Returns all collections of a given item.
Example : expand=tags
Returns all tags of a given item.
Example : expand=relationships
Returns all relationships for a given item.
Example : expand=variations
Returns all variations of a given item.
Example : expand=lockInfo
Returns lock information of a given item.
Example : expand=connectorFileInfo
Returns the ConnectorFileInfo of a given item.
Example : expand=all
Returns all fields and sub resources (except for permissions) available for this 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
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Item
Type:
objectDiscriminator:
typeCategoryItem
Show Source
-
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:
trueAdditional Properties Allowed: additionalPropertiesUser-defined fields data. Map -
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.
Nested Schema : User
Type:
objectUser object
Show Source
-
displayName(optional):
string
Read Only:
truedisplay name of the user. -
email(optional):
string
Read Only:
trueemail of the user. -
userID(optional):
integer(int64)
Read Only:
trueid of the user. -
userName(optional):
string
Read Only:
truename of the user.
Nested Schema : fields
Type:
objectRead Only:
trueAdditional 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 : ItemMetadataInfo
Type:
objectItemMetadataInfo
Show Source
-
exif(optional):
object EXIFMetadata
EXIF Metadata
-
links(optional):
array links
Links
-
transcripts(optional):
object VideoTranscriptMetadata
Video Transcription Metadata
Nested Schema : ItemReferenceInfo
Type:
objectItemReferenceInfo
Show Source
-
isAccessible(optional):
boolean
Whether the item is accessible.
Nested Schema : VideoBean
Type:
objectVideoBean
Show Source
-
duration(optional):
string
Read Only:
trueThe duration of the video in ISO 8601 format. -
isFormatSupported(optional):
boolean
Read Only:
trueA boolean expressing if the video file format is supported. -
playback(optional):
object PlaybackBean
PlaybackBean
-
processing(optional):
object ProcessingBean
ProcessingBean
-
strip(optional):
object StripBean
StripBean
Nested Schema : WorkflowField
Type:
objectAll mapped workflow fields
Show Source
-
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.)
Nested Schema : ChangesInfo
Type:
objectChangesInfo
Show Source
-
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.
Nested Schema : Link
Type:
objectLink of the resource.
Show Source
-
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.
Nested Schema : ChannelId
Type:
objectChannelId
Show Source
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
Nested Schema : ConnectorFileInfo
Type:
objectConnectorFileInfo
Show Source
-
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
Nested Schema : additionalProperties
Type:
objectNested Schema : LockInfo
Type:
objectLockInfo
Show Source
-
isLocked(optional):
boolean
Represents whether the item is locked or not.
-
lockedBy(optional):
string
Locked by user
-
lockedDate(optional):
object date
date
Nested Schema : EXIFMetadata
Type:
objectEXIF Metadata
Show Source
-
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.)
Nested Schema : VideoTranscriptMetadata
Type:
objectVideo Transcription Metadata
Show Source
-
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.)
Nested Schema : items
Type:
arraySingular resources contained in the collection.
Show Source
-
Array of:
object ItemExtractedExifBean
ItemExtractedExifBean
Nested Schema : links
Type:
arrayLinks of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
arrayPinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : ItemExtractedExifBean
Type:
objectItemExtractedExifBean
Show Source
-
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).
Nested Schema : items
Type:
arraySingular resources contained in the collection.
Show Source
-
Array of:
object Videotranscript
Video transcript
Nested Schema : links
Type:
arrayLinks of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
arrayPinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : Videotranscript
Type:
objectVideo transcript
Show Source
-
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.
Nested Schema : Action
Type:
objectAction
Show Source
-
action(optional):
string
Allowed Values:
[ "view", "update", "create", "delete" ]action is allowed on the resource
Nested Schema : PublishInfo
Type:
objectPublishInfo
Show Source
-
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
Nested Schema : Relationships
Type:
objectRelationships
Show Source
-
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
Nested Schema : referencedBy
Type:
arrayReferenced by ids
Show Source
-
Array of:
object References
References
Nested Schema : Siteplanreference
Type:
objectSite plan reference
Show Source
-
id(optional):
string
id of the site plan.
-
links(optional):
array links
Nested Schema : referencedBySites
Type:
arrayReferenced by sites
Show Source
-
Array of:
object ReferencedBySites
ReferencedBySites
Nested Schema : references
Type:
arrayReference ids
Show Source
-
Array of:
object References
References
Nested Schema : References
Type:
objectReferences
Show Source
-
id(optional):
string
id of the item.
-
links(optional):
array links
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
Nested Schema : ReferencedBySites
Type:
objectReferencedBySites
Show Source
-
component(optional):
string
Component of the item
-
pageId(optional):
string
Page the item added to
-
site(optional):
string
Site the item added to
Nested Schema : data
Type:
Show Source
array-
Array of:
object SuggestedTaxonomyInfo
SuggestedTaxonomyInfo
Nested Schema : SuggestedTaxonomyInfo
Type:
objectSuggestedTaxonomyInfo
Show Source
-
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
Nested Schema : categories
Type:
arrayCategories in the Suggested Taxonomy the item belongs to.
Show Source
Nested Schema : ItemSuggestedCategoryInfo
Type:
Show Source
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.
Nested Schema : CategoryNodeBean
Type:
Show Source
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.
Nested Schema : Tag
Type:
objectTag.
Show Source
-
language:
string
language of the tag.
-
links(optional):
array links
Links
-
name:
string
Name of the tag.
Nested Schema : TaxonomyInfo
Type:
objectTaxonomyInfo
Show Source
-
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
Nested Schema : ItemCategoryInfo
Type:
Show Source
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.
Nested Schema : VariationsInfo
Type:
objectVariations Info.
Show Source
-
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.
Nested Schema : items
Type:
arrayContent item variations.
Show Source
-
Array of:
object Language
LanguageItem
Nested Schema : Language
Type:
objectLanguageItem
Show Source
-
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
Nested Schema : VersionInfo
Type:
objectVersionInfo
Show Source
-
latestVersion(optional):
string
Latest version
-
publishedVersion(optional):
string
Published version
Nested Schema : PlaybackBean
Type:
objectPlaybackBean
Show Source
-
adaptiveStreams(optional):
object AdaptiveStreamsBean
AdaptiveStreamsBean
Nested Schema : ProcessingBean
Type:
objectProcessingBean
Show Source
-
progress(optional):
string
Read Only:
trueThe progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.
Nested Schema : StripBean
Type:
objectStripBean
Show Source
-
frame(optional):
object StripFrameBean
StripFrameBean
Nested Schema : AdaptiveStreamsBean
Type:
objectAdaptiveStreamsBean
Show Source
-
dash(optional):
object PlaybackBean
PlaybackBean
-
hls(optional):
object PlaybackBean
PlaybackBean
Nested Schema : StripFrameBean
Type:
objectStripFrameBean
Show Source
-
count(optional):
integer(int32)
Read Only:
trueThe number of frames in the strip image. -
height(optional):
integer(int32)
Read Only:
trueThe height of the strip image. -
width(optional):
integer(int32)
Read Only:
trueThe width of the strip image.
Nested Schema : items
Type:
arraySingular resources contained in the collection.
Show Source
-
Array of:
object WorkflowInfo
WorkflowInfo.
Nested Schema : links
Type:
arrayLinks of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
arrayPinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : WorkflowInfo
Type:
objectWorkflowInfo.
Show Source
-
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
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.
Examples
The following example shows how to read an item by slug.
curl -i -X GET -H 'Accept:application/json' 'https://host:port/content/management/api/v1.1/items/.by.slug/{slug}'
Example 1
This reads item with slug: {slug}.
/content/management/api/v1.1/items/.by.slug/{slug}
Response Body
{
"id": "COREFFFEC388CFD044D8A34D2F8C46EA5786",
"type": "Type1",
"name": "Item1",
"description": "Item1 description",
"typeCategory": "ContentType",
"createdBy": "cecusername",
"createdDate": {
"value": "2018-11-16T06:19:15.641Z",
"timezone": "UTC"
},
"updatedBy": "cecusername",
"updatedDate": {
"value": "2018-11-16T06:19:15.641Z",
"timezone": "UTC"
},
"slug": "{slug}",
"repositoryId": "FF3F3EA7B9AA02DAB862BD32428A3162608D14D20E49",
"status":"draft",
"isPublished": false,
"languageIsMaster": true,
"language": "en-US",
"translatable": false,
"version": "0.1",
"fileExtension": "contentItem",
"fields": {
"Test13551747354462": "sample_string1"
},
"variations": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/variations",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/publishInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"connectorFileInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/connectorFileInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"channels": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/channels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishedChannels": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/publishedChannels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"collections": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/collections",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"relationships": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/relationships",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"tags": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/tags",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"taxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/taxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"suggestedTaxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}/suggestedTaxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/{slug}",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/.by.slug/{slug}",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
]
}
Example 2
This reads item with slug 'content-item-1-type-1' with the expand parameter.
/content/management/api/v1.1/items/.by.slug/content-item-1-type-1?expand=channels
Response Body
{
"id": "CORE64196863705C44D69D60782C63D68735",
"type": "contentType1",
"name": "content item-1 type-1",
"description": "This is content item 1 from type 1 description",
"typeCategory": "ContentType",
"createdBy": "service1.cecsadmina",
"createdDate": {
"value": "2019-09-10T22:17:07.216Z",
"timezone": "UTC"
},
"updatedBy": "service1.cecsadmina",
"updatedDate": {
"value": "2019-09-24T22:17:37.264Z",
"timezone": "UTC"
},
"slug": "content-item-1-type-1",
"repositoryId": "FC9B60A8EC82EFC6437D498156661572BE4919B95412",
"language": "en-US",
"translatable": true,
"status": "published",
"isPublished": true,
"languageIsMaster": true,
"version": "3",
"fileExtension": "contentItem",
"fields": {
"ct1-field1": "This is my text field value"
},
"tags": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/tags",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"variations": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/variations",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/publishInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"connectorFileInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/connectorFileInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"channels": {
"data": [
{
"id": "CHANNELF0641664AF4D3E048F28C1ACEFC4EFCB8B8882300EF6"
}
],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/channels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishedChannels": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/publishedChannels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"collections": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/collections",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"relationships": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/relationships",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"taxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/taxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"suggestedTaxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1/suggestedTaxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1?expand=channels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/content-item-1-type-1?expand=channels",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/.by.slug/content-item-1-type-1",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
]
}
Example 3
This reads item with slug 'content-item-1-type-1' where the item has one content item(ciref field) and one digital asset (imageref field) as references.
/content/management/api/v1.1/items/.by.slug/content-item-1-type-1
Response Body
{
"id": "CORE74F8CFB889E24CB7834950C155FDC5E4",
"type": "TypeB",
"name": "Item2-typeB",
"description": "",
"typeCategory": "ContentType",
"createdBy": "swebcli.SitesAdmin1.admin",
"createdDate": {
"value": "2019-11-15T07:33:10.603Z",
"timezone": "UTC"
},
"updatedBy": "swebcli.SitesAdmin1.admin",
"updatedDate": {
"value": "2019-11-15T07:33:10.603Z",
"timezone": "UTC"
},
"slug": "1481786098595-item2-typeb",
"repositoryId": "F776676F0BA54386BCBA55FD916A1FAE",
"language": "en-GB",
"translatable": true,
"status": "draft",
"isPublished": false,
"languageIsMaster": true,
"version": "0.1",
"fileExtension": "contentItem",
"fields": {
"ciref": {
"id": "CORE3B5C6BED3C994A6C8C557B107475AE87",
"type": "TypeA",
"typeCategory": "ContentType",
"name": "Item1-typeA",
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/item1-typea",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"imageref": {
"id": "CONTDD682B51E7F447868451BF8A5F45178F",
"type": "DigitalAsset",
"typeCategory": "DigitalAssetType",
"name": "Desert.jpg",
"fileExtension": "jpg",
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/14478684518-desert",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
},
"tags": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/tags",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"variations": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/variations",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"versionInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/versionInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/publishInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"connectorFileInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/connectorFileInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"channels": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/channels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishedChannels": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/publishedChannels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"collections": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/collections",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"relationships": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/relationships",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"taxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/taxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"suggestedTaxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb/suggestedTaxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786098595-item2-typeb",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/.by.slug/1481786098595-item2-typeb",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
],
"currentVersion": "0.1",
"latestVersion": "0.1",
"mimeType": "contentItem",
"fileGroup": "contentItem",
"varSetId": "975E98E4EF4A6F7BE053020012AC93CF"
}
Example 4
This reads item with slug '1481786061865-sample' where the item is of DigitalAssetType.
/content/management/api/v1.1/items/.by.slug/1481786061865-sample
Response Body
{
"id": "CONT4AF34CEC07AD4A56AD7A996F1FB6620B",
"type": "Image",
"typeCategory": "DigitalAssetType",
"name": "Sample.gif",
"description": "",
"createdBy": "ssvrint.cecsadmina",
"createdDate": {
"value": "2021-03-08T12:03:37.362Z",
"timezone": "UTC"
},
"updatedBy": "ssvrint.cecsadmina",
"updatedDate": {
"value": "2021-03-09T08:05:17.760Z",
"timezone": "UTC"
},
"slug": "1481786061865-sample",
"repositoryId": "AE2D5B39266742D1A2ECD142CB46BAD7",
"status": "published",
"isPublished": true,
"language": "en-US",
"translatable": true,
"languageIsMaster": true,
"version": "1",
"fileExtension": "gif",
"scheduled": false,
"tags": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/tags",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"fields": {
"metadata": {
"width": "664",
"height": "360"
},
"size": 42060,
"native": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/native/Sample.gif",
"rel": "self",
"method": "GET",
"mediaType": "image/gif"
}
]
},
"renditions": [
{
"name": "Thumbnail",
"formats": [
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "150",
"height": "81"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Thumbnail/Sample.gif?format=webp&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/webp"
}
]
},
{
"format": "jpg",
"size": 4271,
"mimeType": "image/jpeg",
"metadata": {
"width": "150",
"height": "81"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Thumbnail/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
}
],
"type": "responsiveimage"
},
{
"name": "Medium",
"formats": [
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Medium/Sample.gif?format=webp&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/webp"
}
]
},
{
"format": "jpg",
"size": 59856,
"mimeType": "image/jpeg",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Medium/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
}
],
"type": "responsiveimage"
},
{
"name": "Large",
"formats": [
{
"format": "jpg",
"size": 0,
"mimeType": "image/jpeg",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Large/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
},
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Large/Sample.gif?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": "300",
"height": "162"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Small/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
},
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "300",
"height": "162"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Small/Sample.gif?format=webp&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/webp"
}
]
}
],
"type": "responsiveimage"
}
],
"mimeType": "image/gif",
"fileGroup": "Images",
"fileType": "gif"
},
"variations": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/variations",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"versionInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/versionInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/publishInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"lockInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/lockInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"connectorFileInfo": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/connectorFileInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"channels": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/channels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishedChannels": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/publishedChannels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"collections": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/collections",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"relationships": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/relationships",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"taxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/taxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"suggestedTaxonomies": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/suggestedTaxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"workflows": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/workflows",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"changes": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/CONT4AF34CEC07AD4A56AD7A996F1FB6620B/changes",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/.by.slug/1481786061865-sample",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
],
"publishedVersion": "1",
"currentVersion": "1",
"latestVersion": "1",
"mimeType": "image/gif",
"fileGroup": "Images",
"varSetId": "BD0638FFBBBA74E9E053020011ACFAEA",
"permissions": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/permissions",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
}
Example 5
This reads item with slug '1481786061865-sample' while expanding all subresources where the item is of DigitalAssetType.
/content/management/api/v1.1/items/.by.slug/1481786061865-sample?expand=all
Response Body
{
"id": "CONT4AF34CEC07AD4A56AD7A996F1FB6620B",
"type": "Image",
"typeCategory": "DigitalAssetType",
"name": "Sample.gif",
"description": "",
"createdBy": "ssvrint.cecsadmina",
"createdDate": {
"value": "2021-03-08T12:03:37.362Z",
"timezone": "UTC"
},
"updatedBy": "ssvrint.cecsadmina",
"updatedDate": {
"value": "2021-03-09T08:05:17.760Z",
"timezone": "UTC"
},
"slug": "1481786061865-sample",
"repositoryId": "AE2D5B39266742D1A2ECD142CB46BAD7",
"status": "published",
"isPublished": true,
"languageIsMaster": true,
"translatable": false,
"version": "1",
"fileExtension": "gif",
"scheduled": false,
"tags": {
"data": [],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/tags",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"fields": {
"metadata": {
"width": "664",
"height": "360"
},
"size": 42060,
"native": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/native/Sample.gif",
"rel": "self",
"method": "GET",
"mediaType": "image/gif"
}
]
},
"renditions": [
{
"name": "Thumbnail",
"formats": [
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "150",
"height": "81"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Thumbnail/Sample.gif?format=webp&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/webp"
}
]
},
{
"format": "jpg",
"size": 4271,
"mimeType": "image/jpeg",
"metadata": {
"width": "150",
"height": "81"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Thumbnail/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
}
],
"type": "responsiveimage"
},
{
"name": "Medium",
"formats": [
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Medium/Sample.gif?format=webp&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/webp"
}
]
},
{
"format": "jpg",
"size": 59856,
"mimeType": "image/jpeg",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Medium/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
}
],
"type": "responsiveimage"
},
{
"name": "Large",
"formats": [
{
"format": "jpg",
"size": 0,
"mimeType": "image/jpeg",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Large/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
},
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "664",
"height": "360"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Large/Sample.gif?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": "300",
"height": "162"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Small/Sample.gif?format=jpg&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/jpeg"
}
]
},
{
"format": "webp",
"size": 0,
"mimeType": "image/webp",
"metadata": {
"width": "300",
"height": "162"
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/assets/.by.slug/1481786061865-sample/Small/Sample.gif?format=webp&type=responsiveimage",
"rel": "self",
"method": "GET",
"mediaType": "image/webp"
}
]
}
],
"type": "responsiveimage"
}
],
"mimeType": "image/gif",
"fileGroup": "Images",
"fileType": "gif"
},
"variations": {
"data": [
{
"varType": "language",
"masterItem": "CONT4AF34CEC07AD4A56AD7A996F1FB6620B",
"items": [
{
"id": "CONT4AF34CEC07AD4A56AD7A996F1FB6620B",
"name": "Sample.gif",
"value": "und",
"status": "published",
"isPublished": true
}
]
}
],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/variations",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"versionInfo": {
"data": [
{
"latestVersion": "1",
"publishedVersion": "1"
}
],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/versionInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishInfo": {
"data": [
{
"channel": "RCHANNELBDB36AEC493D41F3BB50ED2E44EF880B",
"publishedBy": "ssvrint.cecsadmina",
"version": "1",
"publishedDate": {
"value": "2021-03-08T13:43:07.153Z",
"timezone": "UTC"
}
}
],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/publishInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"lockInfo": {
"data": {
"isLocked": false
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/lockInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"connectorFileInfo": {
"data": {},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/connectorFileInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"channels": {
"data": [
{
"id": "RCHANNELBDB36AEC493D41F3BB50ED2E44EF880B"
}
],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/channels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishedChannels": {
"data": [
{
"id": "RCHANNELBDB36AEC493D41F3BB50ED2E44EF880B"
}
],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/publishedChannels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"collections": {
"data": [],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/collections",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"relationships": {
"data": {
"references": [],
"referencedBy": [],
"referencedBySites": []
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/relationships",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"taxonomies": {
"data": [],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/taxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"suggestedTaxonomies": {
"data": [],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/suggestedTaxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"workflows": {
"data": [],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/workflows",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"changes": {
"data": [
{
"source": "taxonomies",
"type": "promotion-deleted",
"value": false
},
{
"source": "taxonomies",
"type": "categorization",
"value": false
}
],
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/CONT4AF34CEC07AD4A56AD7A996F1FB6620B/changes",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample?expand=all",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample?expand=all",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/items/.by.slug/1481786061865-sample",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
],
"publishedVersion": "1",
"currentVersion": "1",
"latestVersion": "1",
"mimeType": "image/gif",
"fileGroup": "Images",
"varSetId": "BD0638FFBBBA74E9E053020011ACFAEA",
"permissions": {
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/items/.by.slug/1481786061865-sample/permissions",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
}
Example 6
This reads an item by slug 3000000040002-item-c1 and its permissions (allowed actions) data. This examples shows reference fields point to accessible and inaccessible child items. For clarity, this example skips all other empty sub resources.
/content/management/api/v1.1/items/.by.slug/3000000040002-item-c1?expand=permissions
Response Body
{
"id": "CORE4FDEB4C45AF34766B8CB88D25BD92D90",
"type": "TypeCCC",
"typeCategory": "ContentType",
"name": "Item C1",
"description": "",
"createdBy": "cecusername1",
"createdDate": {
"value": "2021-01-11T19:49:51.358Z",
"timezone": "UTC"
},
"updatedBy": "cecusername2",
"updatedDate": {
"value": "2021-03-18T06:20:53.432Z",
"timezone": "UTC"
},
"slug": "3000000040002-item-c1",
"repositoryId": "6589BF25F2854E6AA928EE7412CBE6AE",
"language": "en-US",
"translatable": true,
"status": "draft",
"isPublished": false,
"languageIsMaster": true,
"version": "0.6",
"fileExtension": "contentItem",
"scheduled": true,
"fields": {
"multi_ref_ccc": [
{
"id": "COREA0B53F00198F4771962526DDF83416C5",
"reference": {
"isAccessible": false
}
},
{
"id": "CORE878A5BEE021849D2A183CF94E64F1D9B",
"type": "TypeAAA",
"typeCategory": "ContentType",
"name": "Item A2",
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/3000000045000-item-a2",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
],
"reference": {
"isAccessible": true
}
}
],
"multi_media_ccc": [
{
"id": "CONTBAEF8D6E7C44433FB553BB53D1D0B531",
"type": "Image",
"typeCategory": "DigitalAssetType",
"name": "DigitalAsset_0011_Blog_3_Header_1440x540px.jpg",
"fileExtension": "jpg",
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/1481786243912-DigitalAsset_0011_Blog_3_Header_1440x540px",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
],
"reference": {
"isAccessible": true
}
},
{
"id": "CONT90C026CB999E470CAEAFE0F76BB55036",
"type": "Image",
"typeCategory": "DigitalAssetType",
"name": "DigitalAsset_0001_Blog_2_Header_1440x540px.jpg",
"fileExtension": "jpg",
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/1481786243902-DigitalAsset_0001_Blog_2_Header_1440x540px",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
],
"reference": {
"isAccessible": true
}
}
],
"txtfield": "c1",
"ref_field_ccc": null
},
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/3000000040002-item-c1?expand=permissions",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/3000000040002-item-c1?expand=permissions",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/items/.by.slug/3000000040002-item-c1",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
],
"currentVersion": "0.6",
"latestVersion": "0.6",
"mimeType": "contentItem",
"fileGroup": "contentItem",
"varSetId": "B8A63421064D678DE053A79C6F649374",
"permissions": {
"data": [
{
"action": "view"
},
{
"action": "update"
},
{
"action": "create"
}
],
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/3000000040002-item-c1/permissions",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
}
Example 7
This reads item with slug 'file-1481786052389-myText' while expanding it's connectorFileInfo.
/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText?expand=connectorFileInfo
Response Body
{
"id": "CONTD84FF07335854BB88ADDBFDACB17E26F",
"type": "File",
"typeCategory": "DigitalAssetType",
"name": "myText.rtf",
"description": "",
"createdBy": "ssvrint.cecsadmina",
"createdDate": {
"value": "2022-02-25T20:58:09.084Z",
"timezone": "UTC"
},
"updatedBy": "ssvrint.cecsadmina",
"updatedDate": {
"value": "2022-02-25T20:59:53.929Z",
"timezone": "UTC"
},
"slug": "file-1481786052389-myText",
"repositoryId": "7D265022BADA428DAA20C4F0F8F1465C",
"language": "en-US",
"translatable": false,
"status": "draft",
"isPublished": false,
"languageIsMaster": true,
"version": "0.2",
"fileExtension": "rtf",
"scheduled": false,
"tags": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/tags",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"fields": {
"metadata": {
"width": "-1",
"height": "-1"
},
"size": 368,
"native": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/assets/.by.slug/file-1481786052389-myText/native/myText.rtf",
"rel": "self",
"method": "GET",
"mediaType": "application/rtf"
}
]
},
"renditions": [],
"mimeType": "application/rtf",
"fileGroup": "Documents",
"fileType": "rtf"
},
"variations": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/variations",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"versionInfo": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/versionInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishInfo": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/publishInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"lockInfo": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/lockInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"connectorFileInfo": {
"data": {
"connectorId": "Documents",
"id": "D24E0B382A99E3514A285460810C1EC8749555FF2EE0",
"version": 2,
"inUse": true
},
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/connectorFileInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"channels": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/channels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"publishedChannels": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/publishedChannels",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"collections": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/collections",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"relationships": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/relationships",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"taxonomies": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/taxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"suggestedTaxonomies": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/suggestedTaxonomies",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"workflows": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/workflows",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"changes": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/CONTD84FF07335854BB88ADDBFDACB17E26F/changes",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"metadata": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/CONTD84FF07335854BB88ADDBFDACB17E26F/metadata",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
},
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText?expand=connectorFileInfo",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText?expand=connectorFileInfo",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/items/.by.slug/file-1481786052389-myText",
"rel": "describedby",
"method": "GET",
"mediaType": "application/json"
}
],
"currentVersion": "0.2",
"latestVersion": "0.2",
"mimeType": "application/rtf",
"fileGroup": "Documents",
"varSetId": "D8DEF4C375224B87E053020013ACC6C7",
"connectorId": "Documents",
"permissions": {
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/items/.by.slug/file-1481786052389-myText/permissions",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
}
]
}
}
}