REST API for Content Management

Read an Archived Item

get

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

Read an archived item.

Request

Path Parameters

id: string

id of the item.

Query Parameters

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=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=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 : ArchivedItem

Type: object

Archived Item

Show Source

archivedBy(optional): string

Archived by.
archivedDate(optional): object date

date
archiveFileLocation(optional): string
archiveFileName(optional): string
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: additionalProperties

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.
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.
isRestoreScheduled(optional): boolean

Whether the item is scheduled for restore.
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.

{
    "type":"object",
    "properties":{
        "isRestoreScheduled":{
            "type":"boolean",
            "description":"Whether the item is scheduled for restore."
        },
        "archivedBy":{
            "type":"string",
            "description":"Archived by."
        },
        "archivedDate":{
            "description":"date and time time when the asset was archived",
            "$ref":"#/definitions/date"
        },
        "archiveFileName":{
            "type":"string"
        },
        "archiveFileLocation":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"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."
        },
        "type":{
            "type":"string",
            "description":"Name of the type. It is a required property in the get response and post/put request."
        },
        "name":{
            "type":"string",
            "description":"Name of the item. It is a required property in the get response and post/put request."
        },
        "createdBy":{
            "type":"string",
            "description":"Created by."
        },
        "createdByUser":{
            "description":"Created by.",
            "$ref":"#/definitions/User"
        },
        "createdDate":{
            "description":"date and time Item createdAt",
            "$ref":"#/definitions/date"
        },
        "description":{
            "type":"string",
            "description":"description of the item"
        },
        "repositoryId":{
            "type":"string",
            "description":"Repository of the item. It is a required property in the get response and post/put request."
        },
        "slug":{
            "type":"string",
            "description":"URL slug of the item."
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated by."
        },
        "updatedByUser":{
            "description":"Updated by.",
            "$ref":"#/definitions/User"
        },
        "updatedDate":{
            "description":"date and time Item updatedAt",
            "$ref":"#/definitions/date"
        },
        "language":{
            "type":"string",
            "description":"Language of the item."
        },
        "translatable":{
            "type":"boolean",
            "description":"Whether the item is translatable."
        },
        "status":{
            "type":"string",
            "description":"Current status of the item."
        },
        "languageIsMaster":{
            "type":"boolean",
            "description":"Whether the item is master."
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the item is ever published."
        },
        "version":{
            "type":"string",
            "description":"The current revision version of this item."
        },
        "fileExtension":{
            "type":"string",
            "description":"Extension of the file."
        },
        "connectorId":{
            "type":"string",
            "description":"Connector Id of the item."
        },
        "connectorSyncEnabled":{
            "type":"boolean",
            "description":"Connector Sync Enabled flag of the item."
        },
        "tags":{
            "description":"Tags of the item.",
            "$ref":"#/definitions/ItemSubResourceListTag"
        },
        "versionInfo":{
            "description":"Item version info.",
            "$ref":"#/definitions/ItemSubResourceListVersionInfo"
        },
        "channels":{
            "$ref":"#/definitions/ItemSubResourceListChannelId"
        },
        "publishedChannels":{
            "$ref":"#/definitions/ItemSubResourceListChannelId"
        },
        "collections":{
            "$ref":"#/definitions/ItemSubResourceListCollectionId"
        },
        "changes":{
            "$ref":"#/definitions/ItemSubResourceListChangesInfo"
        },
        "metadata":{
            "$ref":"#/definitions/ItemMetadataInfo"
        },
        "video":{
            "$ref":"#/definitions/VideoBean"
        },
        "taxonomies":{
            "$ref":"#/definitions/ItemSubResourceListTaxonomyInfo"
        },
        "suggestedTaxonomies":{
            "$ref":"#/definitions/ItemSubResourceListSuggestedTaxonomyInfo"
        },
        "workflows":{
            "$ref":"#/definitions/ItemSubResourceListWorkflowInfo"
        },
        "workflowInstances":{
            "$ref":"#/definitions/WorkflowField"
        },
        "lockInfo":{
            "$ref":"#/definitions/ItemSubResourceLockInfo"
        },
        "connectorFileInfo":{
            "$ref":"#/definitions/ItemSubResourceConnectorFileInfo"
        },
        "relationships":{
            "$ref":"#/definitions/ItemSubResourceRelationships"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "fields":{
            "type":"object",
            "description":"User-defined fields data. Map<String,Object>. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.",
            "readOnly":true,
            "additionalProperties":{
                "type":"object"
            }
        },
        "typeCategory":{
            "type":"string",
            "readOnly":true
        },
        "publishInfo":{
            "description":"All targets publish info.",
            "$ref":"#/definitions/ItemSubResourceListPublishInfo"
        },
        "variations":{
            "description":"Item variations.",
            "$ref":"#/definitions/ItemSubResourceListVariationsInfo"
        },
        "sourceId":{
            "type":"string",
            "description":"Source Id."
        },
        "permissions":{
            "$ref":"#/definitions/ItemSubResourceListAction"
        },
        "reference":{
            "description":"Access information of the Referenced Item.",
            "$ref":"#/definitions/ItemReferenceInfo"
        },
        "scheduled":{
            "type":"boolean"
        }
    },
    "description":"Archived Item"
}

Nested Schema : date

Type: object

date

Show Source

timezone(optional): string
value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : ItemSubResourceListChangesInfo

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChangesInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListChannelId

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListCollectionId

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CollectionId"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceConnectorFileInfo

Type: object

Item SubResource.

Show Source

data(optional): object ConnectorFileInfo

ConnectorFileInfo
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/ConnectorFileInfo"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : User

Type: object

User object

Show Source

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.

{
    "type":"object",
    "properties":{
        "userID":{
            "type":"integer",
            "format":"int64",
            "description":"id of the user.",
            "readOnly":true
        },
        "userName":{
            "type":"string",
            "description":"name of the user.",
            "readOnly":true
        },
        "displayName":{
            "type":"string",
            "description":"display name of the user.",
            "readOnly":true
        },
        "email":{
            "type":"string",
            "description":"email of the user.",
            "readOnly":true
        }
    },
    "description":"User object"
}

Nested Schema : fields

Type: object

Read Only: true

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"User-defined fields data. Map<String,Object>. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.",
    "readOnly":true,
    "additionalProperties":{
        "type":"object"
    }
}

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 : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ItemSubResourceLockInfo

Type: object

Item SubResource.

Show Source

data(optional): object LockInfo

LockInfo
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/LockInfo"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemMetadataInfo

Type: object

ItemMetadataInfo

Show Source

exif(optional): object EXIFMetadata

EXIF Metadata
links(optional): array links

Links
transcripts(optional): object VideoTranscriptMetadata

Video Transcription Metadata

{
    "type":"object",
    "properties":{
        "exif":{
            "$ref":"#/definitions/EXIFMetadata"
        },
        "transcripts":{
            "$ref":"#/definitions/VideoTranscriptMetadata"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemMetadataInfo"
}

Nested Schema : ItemSubResourceListAction

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Action"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListPublishInfo

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemReferenceInfo

Type: object

ItemReferenceInfo

Show Source

isAccessible(optional): boolean

Whether the item is accessible.

{
    "type":"object",
    "properties":{
        "isAccessible":{
            "type":"boolean",
            "description":"Whether the item is accessible."
        }
    },
    "description":"ItemReferenceInfo"
}

Nested Schema : ItemSubResourceRelationships

Type: object

Item SubResource.

Show Source

data(optional): object Relationships

Relationships
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/Relationships"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListSuggestedTaxonomyInfo

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuggestedTaxonomyInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListTag

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Tag"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListTaxonomyInfo

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaxonomyInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListVariationsInfo

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VariationsInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListVersionInfo

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VersionInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : VideoBean

Type: object

VideoBean

Show Source

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

{
    "type":"object",
    "properties":{
        "strip":{
            "description":"Data about the video strip image.",
            "readOnly":true,
            "$ref":"#/definitions/StripBean"
        },
        "duration":{
            "type":"string",
            "description":"The duration of the video in ISO 8601 format.",
            "readOnly":true
        },
        "isFormatSupported":{
            "type":"boolean",
            "description":"A boolean expressing if the video file format is supported.",
            "readOnly":true
        },
        "playback":{
            "description":"Video playback data.",
            "readOnly":true,
            "$ref":"#/definitions/PlaybackBean"
        },
        "processing":{
            "description":"Data about the video background process.",
            "readOnly":true,
            "$ref":"#/definitions/ProcessingBean"
        }
    },
    "description":"VideoBean"
}

Nested Schema : WorkflowField

Type: object

All 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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/WorkflowInfo"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"All mapped workflow fields"
}

Nested Schema : ItemSubResourceListWorkflowInfo

Type: object

Item SubResource.

Show Source

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkflowInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : data

Type: array

Show Source

Array of: object ChangesInfo

ChangesInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChangesInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ChangesInfo

Type: object

ChangesInfo

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.

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string",
            "description":"Sub-resource associated to this item which is source of this change."
        },
        "type":{
            "type":"string",
            "description":"Type of change tracked for the given source."
        },
        "value":{
            "type":"boolean",
            "description":"True indicates a change. False indicates no current changes for this source/type."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChangesInfo"
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Link 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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : data

Type: array

Show Source

Array of: object ChannelId

ChannelId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ChannelId

Type: object

ChannelId

Show Source

id(optional): string
isPrimaryChannel(optional): boolean

Indicates if channel is primary for an asset.
links(optional): array links

Links
name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object CollectionId

CollectionId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CollectionId"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : CollectionId

Type: object

CollectionId

Show Source

id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    },
    "description":"CollectionId"
}

Nested Schema : ConnectorFileInfo

Type: object

ConnectorFileInfo

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

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"Connector id."
        },
        "id":{
            "type":"string",
            "description":"File id."
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"File version"
        },
        "inUse":{
            "type":"boolean",
            "description":"Represents whether the latest version of asset is using the file content."
        }
    },
    "description":"ConnectorFileInfo"
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : LockInfo

Type: object

LockInfo

Show Source

isLocked(optional): boolean

Represents whether the item is locked or not.
lockedBy(optional): string

Locked by user
lockedDate(optional): object date

date

{
    "type":"object",
    "properties":{
        "isLocked":{
            "type":"boolean",
            "description":"Represents whether the item is locked or not."
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked by user"
        },
        "lockedDate":{
            "description":"Locked date and time",
            "$ref":"#/definitions/date"
        }
    },
    "description":"LockInfo"
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : EXIFMetadata

Type: object

EXIF 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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/ItemExtractedExifBean"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"EXIF Metadata"
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : VideoTranscriptMetadata

Type: object

Video 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.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Videotranscript"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Video Transcription Metadata"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

Array of: object ItemExtractedExifBean

ItemExtractedExifBean

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/ItemExtractedExifBean"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

name(optional): string

Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : ItemExtractedExifBean

Type: object

ItemExtractedExifBean

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).

{
    "type":"object",
    "properties":{
        "rawId":{
            "type":"string",
            "description":"The ID of the EXIF field. Uniquely identifies one EXIF field."
        },
        "handle":{
            "type":"string",
            "description":"The handle or EXIF field name. This value is not translatable."
        },
        "rawValue":{
            "type":"string",
            "description":"The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value."
        },
        "value":{
            "type":"string",
            "description":"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)."
        },
        "type":{
            "type":"string",
            "description":"The data type of the EXIF field. (date, integer, float, string)."
        },
        "stringValue":{
            "type":"string",
            "description":"The text value of the EXIF field. This value will be a text representation of the EXIF field value."
        },
        "integerValue":{
            "type":"integer",
            "format":"int32",
            "description":"The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point."
        },
        "floatValue":{
            "type":"number",
            "format":"float",
            "description":"The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemExtractedExifBean"
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

Array of: object Videotranscript

Video transcript

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Videotranscript"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : Videotranscript

Type: object

Video 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of each transcript node."
        },
        "start":{
            "type":"string",
            "description":"Start of each transcript node."
        },
        "end":{
            "type":"string",
            "description":"End of each transcript node."
        },
        "text":{
            "type":"string",
            "description":"Text of each transcript node."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Video transcript"
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object Action

Action

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Action"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Action

Type: object

Action

Show Source

action(optional): string

Allowed Values: [ "view", "update", "create", "delete" ]

action is allowed on the resource

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"action is allowed on the resource",
            "enum":[
                "view",
                "update",
                "create",
                "delete"
            ]
        }
    },
    "description":"Action"
}

Nested Schema : data

Type: array

Show Source

Array of: object PublishInfo

PublishInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PublishInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : PublishInfo

Type: object

PublishInfo

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

{
    "type":"object",
    "properties":{
        "channel":{
            "type":"string",
            "description":"Target name"
        },
        "publishedBy":{
            "type":"string",
            "description":"Published by"
        },
        "version":{
            "type":"string",
            "description":"Published version"
        },
        "publishedDate":{
            "description":"date and time Item publishedAt.",
            "$ref":"#/definitions/date"
        },
        "slug":{
            "type":"string",
            "description":"Published slug"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PublishInfo"
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Relationships

Type: object

Relationships

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

{
    "type":"object",
    "properties":{
        "references":{
            "type":"array",
            "description":"Reference ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBy":{
            "type":"array",
            "description":"Referenced by ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBySites":{
            "type":"array",
            "description":"Referenced by sites",
            "items":{
                "$ref":"#/definitions/ReferencedBySites"
            }
        },
        "referencedBySitePlan":{
            "$ref":"#/definitions/Siteplanreference"
        }
    },
    "description":"Relationships"
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : referencedBy

Type: array

Referenced by ids

Show Source

Array of: object References

References

{
    "type":"array",
    "description":"Referenced by ids",
    "items":{
        "$ref":"#/definitions/References"
    }
}

Nested Schema : Siteplanreference

Type: object

Site plan reference

Show Source

id(optional): string

id of the site plan.
links(optional): array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the site plan."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Site plan reference"
}

Nested Schema : referencedBySites

Type: array

Referenced by sites

Show Source

Array of: object ReferencedBySites

ReferencedBySites

{
    "type":"array",
    "description":"Referenced by sites",
    "items":{
        "$ref":"#/definitions/ReferencedBySites"
    }
}

Nested Schema : references

Type: array

Reference ids

Show Source

Array of: object References

References

{
    "type":"array",
    "description":"Reference ids",
    "items":{
        "$ref":"#/definitions/References"
    }
}

Nested Schema : References

Type: object

References

Show Source

id(optional): string

id of the item.
links(optional): array links
reference(optional): object ItemReferenceInfo

ItemReferenceInfo

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "reference":{
            "description":"Access information of the Referenced Item.",
            "$ref":"#/definitions/ItemReferenceInfo"
        }
    },
    "description":"References"
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ReferencedBySites

Type: object

ReferencedBySites

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

{
    "type":"object",
    "properties":{
        "site":{
            "type":"string",
            "description":"Site the item added to"
        },
        "pageId":{
            "type":"string",
            "description":"Page the item added to"
        },
        "component":{
            "type":"string",
            "description":"Component of the item"
        }
    },
    "description":"ReferencedBySites"
}

Nested Schema : data

Type: array

Show Source

Array of: object SuggestedTaxonomyInfo

SuggestedTaxonomyInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuggestedTaxonomyInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : SuggestedTaxonomyInfo

Type: object

SuggestedTaxonomyInfo

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "categories":{
            "type":"array",
            "description":"Categories in the Suggested Taxonomy the item belongs to.",
            "items":{
                "$ref":"#/definitions/ItemSuggestedCategoryInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"SuggestedTaxonomyInfo"
}

Nested Schema : categories

Type: array

Categories in the Suggested Taxonomy the item belongs to.

Show Source

Array of: object ItemSuggestedCategoryInfo

{
    "type":"array",
    "description":"Categories in the Suggested Taxonomy the item belongs to.",
    "items":{
        "$ref":"#/definitions/ItemSuggestedCategoryInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ItemSuggestedCategoryInfo

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category assigned to the item."
        },
        "isRejected":{
            "type":"boolean",
            "description":"Status of the Suggested Category for the Item."
        },
        "order":{
            "type":"integer",
            "format":"int32",
            "description":"Probability order of the Suggested Category across all the Taxonomies assigned to the repository."
        },
        "nodes":{
            "type":"array",
            "description":"Nodes in the category assigned to the item.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : nodes

Type: array

Nodes in the category assigned to the item.

Show Source

Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"Nodes in the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : CategoryNodeBean

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object Tag

Tag.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Tag"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Tag

Type: object

Tag.

Show Source

language: string

language of the tag.
links(optional): array links

Links
name: string

Name of the tag.

{
    "type":"object",
    "required":[
        "language",
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the tag."
        },
        "language":{
            "type":"string",
            "description":"language of the tag."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Tag."
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object TaxonomyInfo

TaxonomyInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaxonomyInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : TaxonomyInfo

Type: object

TaxonomyInfo

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "categories":{
            "type":"array",
            "description":"Categories in the Taxonomy the item belongs to.",
            "items":{
                "$ref":"#/definitions/ItemCategoryInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"TaxonomyInfo"
}

Nested Schema : categories

Type: array

Categories in the Taxonomy the item belongs to.

Show Source

Array of: object ItemCategoryInfo

{
    "type":"array",
    "description":"Categories in the Taxonomy the item belongs to.",
    "items":{
        "$ref":"#/definitions/ItemCategoryInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : ItemCategoryInfo

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category assigned to the item."
        },
        "nodes":{
            "type":"array",
            "description":"Nodes in the category assigned to the item.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : nodes

Type: array

Nodes in the category assigned to the item.

Show Source

Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"Nodes in the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object VariationsInfo

Variations Info.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VariationsInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : VariationsInfo

Type: object

Variations 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.

{
    "type":"object",
    "properties":{
        "setId":{
            "type":"string",
            "description":"Variation set id."
        },
        "varType":{
            "type":"string",
            "description":"Variation type name."
        },
        "masterItem":{
            "type":"string",
            "description":"Master item."
        },
        "items":{
            "type":"array",
            "description":"Content item variations.",
            "items":{
                "$ref":"#/definitions/Language"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Variations Info."
}

Nested Schema : items

Type: array

Content item variations.

Show Source

Array of: object Language

LanguageItem

{
    "type":"array",
    "description":"Content item variations.",
    "items":{
        "$ref":"#/definitions/Language"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Language

Type: object

LanguageItem

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "value":{
            "type":"string",
            "description":"Language value"
        },
        "status":{
            "type":"string",
            "description":"status of item"
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the item is ever published."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"LanguageItem"
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object VersionInfo

VersionInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/VersionInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : VersionInfo

Type: object

VersionInfo

Show Source

latestVersion(optional): string

Latest version
publishedVersion(optional): string

Published version

{
    "type":"object",
    "properties":{
        "latestVersion":{
            "type":"string",
            "description":"Latest version"
        },
        "publishedVersion":{
            "type":"string",
            "description":"Published version"
        }
    },
    "description":"VersionInfo"
}

Nested Schema : PlaybackBean

Type: object

PlaybackBean

Show Source

adaptiveStreams(optional): object AdaptiveStreamsBean

AdaptiveStreamsBean

{
    "type":"object",
    "properties":{
        "adaptiveStreams":{
            "description":"The available adaptive streams.",
            "readOnly":true,
            "$ref":"#/definitions/AdaptiveStreamsBean"
        }
    },
    "description":"PlaybackBean"
}

Nested Schema : ProcessingBean

Type: object

ProcessingBean

Show Source

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.

{
    "type":"object",
    "properties":{
        "progress":{
            "type":"string",
            "description":"The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.",
            "readOnly":true
        }
    },
    "description":"ProcessingBean"
}

Nested Schema : StripBean

Type: object

StripBean

Show Source

frame(optional): object StripFrameBean

StripFrameBean

{
    "type":"object",
    "properties":{
        "frame":{
            "description":"The frame data about the strip image.",
            "readOnly":true,
            "$ref":"#/definitions/StripFrameBean"
        }
    },
    "description":"StripBean"
}

Nested Schema : AdaptiveStreamsBean

Type: object

AdaptiveStreamsBean

Show Source

dash(optional): object PlaybackBean

PlaybackBean
hls(optional): object PlaybackBean

PlaybackBean

{
    "type":"object",
    "properties":{
        "hls":{
            "description":"The HLS adaptive stream data.",
            "readOnly":true,
            "$ref":"#/definitions/PlaybackBean"
        },
        "dash":{
            "description":"The DASH adaptive stream data.",
            "readOnly":true,
            "$ref":"#/definitions/PlaybackBean"
        }
    },
    "description":"AdaptiveStreamsBean"
}

Nested Schema : StripFrameBean

Type: object

StripFrameBean

Show Source

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.

{
    "type":"object",
    "properties":{
        "width":{
            "type":"integer",
            "format":"int32",
            "description":"The width of the strip image.",
            "readOnly":true
        },
        "height":{
            "type":"integer",
            "format":"int32",
            "description":"The height of the strip image.",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of frames in the strip image.",
            "readOnly":true
        }
    },
    "description":"StripFrameBean"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

Array of: object WorkflowInfo

WorkflowInfo.

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/WorkflowInfo"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : WorkflowInfo

Type: object

WorkflowInfo.

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

{
    "type":"object",
    "required":[
        "instanceId"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Workflow id."
        },
        "instanceId":{
            "type":"string",
            "description":"Workflow instance id."
        },
        "name":{
            "type":"string",
            "description":"Workflow name."
        },
        "status":{
            "type":"string",
            "description":"Workflow status."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        },
        "isCompleted":{
            "type":"boolean",
            "description":"If workflow instance is completed or not in OIC."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowInfo."
}

Nested Schema : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object WorkflowInfo

WorkflowInfo.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkflowInfo"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Link of the resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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 archived item by submitting a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/archive/items/{id}'

Example 1

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

This reads an archived digital item with id: CONT04DEF647141A4E158BBBB0012AEE07D6.

Response Body

{
        "isRestoreScheduled": true,
        "archivedBy": "cecusername",
        "archivedDate": {
          "value": "2022-01-11T10:50:08.524Z",
          "timezone": "UTC"
        },
        "id": "CONT04DEF647141A4E158BBBB0012AEE07D6",
        "type": "Image",
        "name": "atiffimg.jpg",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2022-01-06T06:20:27.140Z",
          "timezone": "UTC"
        },
        "description": "",
        "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
        "slug": "image-1481786065211-atiffimg",
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2022-01-06T06:20:27.140Z",
          "timezone": "UTC"
        },
        "language": "en-US",
        "translatable": false,
        "status": "draft",
        "languageIsMaster": true,
        "isPublished": false,
        "version": "0.1",
        "fileExtension": "jpg",
        "latestVersion": "0.1",
        "mimeType": "image/jpg",
        "fileGroup": "Images",
        "varSetId": "D4E4DE1540CD6D1EE053020011ACC0BD",
        "tags": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "changes": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/changes",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "suggestedTaxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/suggestedTaxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "workflows": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/workflows",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "lockInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/lockInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/json"
          }
        ],
        "fields": {
          "metadata": {
            "width": "273",
            "height": "184"
          },
          "size": 11743,
          "native": {
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/assets/CONT04DEF647141A4E158BBBB0012AEE07D6/native/atiffimg.jpg",
                "rel": "self",
                "method": "GET",
                "mediaType": "image/jpg"
              }
            ]
          },
          "mimeType": "image/jpg",
          "fileGroup": "Images",
          "fileType": "jpg"
        },
        "typeCategory": "DigitalAssetType",
        "publishInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "variations": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "permissions": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CONT04DEF647141A4E158BBBB0012AEE07D6/permissions",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "scheduled": false
      }

Example 2

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

This reads an archived content item with id: CORE83FB90323FBB497EA7105E977B540FAD.

Response Body

 {
        "isRestoreScheduled": false,
        "archivedBy": "cecusername",
        "archivedDate": {
          "value": "2021-12-24T11:22:31.690Z",
          "timezone": "UTC"
        },
        "id": "CORE83FB90323FBB497EA7105E977B540FAD",
        "type": "type1",
        "name": "item1",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2021-12-22T13:41:04.782Z",
          "timezone": "UTC"
        },
        "description": "",
        "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
        "slug": "3000000000009-item1",
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2021-12-22T13:41:04.782Z",
          "timezone": "UTC"
        },
        "language": "en-US",
        "translatable": true,
        "status": "draft",
        "languageIsMaster": true,
        "isPublished": false,
        "version": "0.1",
        "fileExtension": "contentItem",
        "latestVersion": "0.1",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "varSetId": "D3BD45F9D5523A6EE053020011AC5895",
        "tags": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "changes": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/changes",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "suggestedTaxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/suggestedTaxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "workflows": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/workflows",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "lockInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/lockInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/archive/items/CORE83FB90323FBB497EA7105E977B540FAD",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/json"
          }
        ],
        "fields": {
          "type1text": "vn"
        },
        "typeCategory": "ContentType",
        "publishInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "variations": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "permissions": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE83FB90323FBB497EA7105E977B540FAD/permissions",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "scheduled": false
      }

Example 3

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

This reads an archived content item with id: CORE8C77233CC9C0477AA83E5667E5E84CC6 having reference item which is not archived.

Response Body

{
        "isRestoreScheduled": false,
        "archivedBy": "cecusername",
        "archivedDate": {
          "value": "2022-01-11T17:25:20.489Z",
          "timezone": "UTC"
        },
        "id": "CORE8C77233CC9C0477AA83E5667E5E84CC6",
        "type": "type_ref",
        "name": "item_ref",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2022-01-11T17:21:31.598Z",
          "timezone": "UTC"
        },
        "description": "",
        "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
        "slug": "3000000050014-item_ref",
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2022-01-11T17:21:31.598Z",
          "timezone": "UTC"
        },
        "language": "en-US",
        "translatable": true,
        "status": "draft",
        "languageIsMaster": true,
        "isPublished": false,
        "version": "0.1",
        "fileExtension": "contentItem",
        "latestVersion": "0.1",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "varSetId": "D552AF2DADBB3DE7E053020011AC62F4",
        "tags": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "changes": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/changes",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "suggestedTaxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/suggestedTaxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "workflows": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/workflows",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "lockInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/lockInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/json"
          }
        ],
        "fields": {
          "ref": {
            "id": "COREC3B176C460F34CA39E92D909037CD951",
            "type": "type2",
            "name": "badminton",
            "createdBy": "cecusername",
            "createdDate": {
              "value": "2022-01-07T13:26:15.452Z",
              "timezone": "UTC"
            },
            "description": "",
            "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
            "slug": "3000000045000-badminton",
            "updatedBy": "cecusername",
            "updatedDate": {
              "value": "2022-01-07T13:26:15.452Z",
              "timezone": "UTC"
            },
            "language": "en-US",
            "translatable": true,
            "status": "draft",
            "languageIsMaster": true,
            "isPublished": false,
            "version": "0.1",
            "fileExtension": "contentItem",
            "currentVersion": "0.1",
            "latestVersion": "0.1",
            "mimeType": "contentItem",
            "fileGroup": "contentItem",
            "varSetId": "D4FEEE6D131C3758E053020011ACF203",
            "tags": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/tags",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "versionInfo": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/versionInfo",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "channels": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/channels",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "publishedChannels": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/publishedChannels",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "collections": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/collections",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "changes": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/changes",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "metadata": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/metadata",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "taxonomies": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/taxonomies",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "suggestedTaxonomies": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/suggestedTaxonomies",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "workflows": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/workflows",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "lockInfo": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/lockInfo",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "relationships": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/relationships",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ],
            "fields": {
              "img": {
                "id": "CONT1289CCCEC54E4F2389E5DA44DD207AA3",
                "type": "Image",
                "typeCategory": "DigitalAssetType",
                "name": "badminton.jpg",
                "fileExtension": "jpg"
              },
              "item_value": "hello"
            },
            "typeCategory": "ContentType",
            "publishInfo": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/publishInfo",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "variations": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/variations",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "permissions": {
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/items/COREC3B176C460F34CA39E92D909037CD951/permissions",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "scheduled": false
          }
        },
        "typeCategory": "ContentType",
        "publishInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "variations": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "permissions": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6/permissions",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "scheduled": false
      }

Example 4

/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6?expand=all

This reads an archived content item with id: CORE8C77233CC9C0477AA83E5667E5E84CC6 having expand=all as query parameter. This content item has variations.

Response Body

{
          "isRestoreScheduled": false,
          "archivedBy": "cecusername",
          "archivedDate": {
            "value": "2022-01-11T17:42:02.535Z",
            "timezone": "UTC"
          },
          "id": "COREC40D3505294444E998AA009FFF788931",
          "type": "type1",
          "name": "item_archive",
          "createdBy": "cecusername",
          "createdDate": {
            "value": "2022-01-11T17:35:11.214Z",
            "timezone": "UTC"
          },
          "description": "",
          "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
          "slug": "3000000050015-item_archive",
          "updatedBy": "cecusername",
          "updatedDate": {
            "value": "2022-01-11T17:40:38.171Z",
            "timezone": "UTC"
          },
          "language": "en-US",
          "translatable": true,
          "status": "draft",
          "languageIsMaster": true,
          "isPublished": false,
          "version": "0.2",
          "fileExtension": "contentItem",
          "latestVersion": "0.2",
          "mimeType": "contentItem",
          "fileGroup": "contentItem",
          "varSetId": "D552AF2DADBE3DE7E053020011AC62F4",
          "tags": {
            "data": [
              {
                "name": "item",
                "language": "en",
                "properties": {
                  "type": "auto"
                }
              },
              {
                "name": "field",
                "language": "en",
                "properties": {
                  "type": "auto"
                }
              },
              {
                "name": "archive",
                "language": "en",
                "properties": {
                  "type": "auto"
                }
              },
              {
                "name": "version",
                "language": "en",
                "properties": {
                  "type": "auto"
                }
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/tags",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "versionInfo": {
            "data": [
              {
                "latestVersion": "0.2"
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/versionInfo",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "channels": {
            "data": [
              {
                "id": "RCHANNEL07D5AB98C9734D55B97179371B4946BA"
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/channels",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "publishedChannels": {
            "data": [],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishedChannels",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "collections": {
            "data": [
              {
                "id": "COLLC6B5D62DF91547A0AA396D16CCE7BDFA"
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/collections",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "changes": {
            "data": [
              {
                "source": "taxonomies",
                "type": "categorization",
                "value": true
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/changes",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "metadata": {
            "exif": {
              "hasMore": false,
              "totalResults": 0,
              "items": [],
              "links": [
                {
                  "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/metadata/exif",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/metadata",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "taxonomies": {
            "data": [
              {
                "id": "60785C9FD8F848828A56404D3BCF518B",
                "name": "test_taxonomy",
                "shortName": "TES",
                "categories": [
                  {
                    "id": "30119B0222E444D895F5A15CB3BBB252",
                    "name": "books",
                    "apiName": "tes-b",
                    "nodes": [
                      {
                        "id": "30119B0222E444D895F5A15CB3BBB252",
                        "name": "books",
                        "apiName": "tes-b"
                      }
                    ],
                    "links": [
                      {
                        "href": "http://<hostname>/content/management/api/v1.1/taxonomies/60785C9FD8F848828A56404D3BCF518B/categories/30119B0222E444D895F5A15CB3BBB252",
                        "rel": "self",
                        "method": "GET",
                        "mediaType": "application/json"
                      }
                    ]
                  },
                  {
                    "id": "CB9351459AD2461AB72BEE1AA7685FF5",
                    "name": "english",
                    "apiName": "tes-b-n-e",
                    "nodes": [
                      {
                        "id": "30119B0222E444D895F5A15CB3BBB252",
                        "name": "books",
                        "apiName": "tes-b"
                      },
                      {
                        "id": "68688AB242144D47A0290701651950BD",
                        "name": "novels",
                        "apiName": "tes-b-c"
                      },
                      {
                        "id": "CB9351459AD2461AB72BEE1AA7685FF5",
                        "name": "english",
                        "apiName": "tes-b-n-e"
                      }
                    ],
                    "links": [
                      {
                        "href": "http://<hostname>/content/management/api/v1.1/taxonomies/60785C9FD8F848828A56404D3BCF518B/categories/CB9351459AD2461AB72BEE1AA7685FF5",
                        "rel": "self",
                        "method": "GET",
                        "mediaType": "application/json"
                      }
                    ]
                  }
                ],
                "links": [
                  {
                    "href": "http://<hostname>/content/management/api/v1.1/taxonomies/60785C9FD8F848828A56404D3BCF518B",
                    "rel": "self",
                    "method": "GET",
                    "mediaType": "application/json"
                  }
                ]
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/taxonomies",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "suggestedTaxonomies": {
            "data": [
              {
                "id": "60785C9FD8F848828A56404D3BCF518B",
                "name": "test_taxonomy",
                "shortName": "TES",
                "categories": [
                  {
                    "id": "8F984EF36C25483A90446DEE928BD291",
                    "name": "hindi",
                    "apiName": "tes-b-n-h",
                    "isRejected": false,
                    "order": 1,
                    "nodes": [
                      {
                        "id": "30119B0222E444D895F5A15CB3BBB252",
                        "name": "books",
                        "apiName": "tes-b"
                      },
                      {
                        "id": "68688AB242144D47A0290701651950BD",
                        "name": "novels",
                        "apiName": "tes-b-c"
                      },
                      {
                        "id": "8F984EF36C25483A90446DEE928BD291",
                        "name": "hindi",
                        "apiName": "tes-b-n-h"
                      }
                    ],
                    "links": [
                      {
                        "href": "http://<hostname>/content/management/api/v1.1/taxonomies/60785C9FD8F848828A56404D3BCF518B/categories/8F984EF36C25483A90446DEE928BD291",
                        "rel": "self",
                        "method": "GET",
                        "mediaType": "application/json"
                      }
                    ]
                  }
                ],
                "links": [
                  {
                    "href": "http://<hostname>/content/management/api/v1.1/taxonomies/60785C9FD8F848828A56404D3BCF518B",
                    "rel": "self",
                    "method": "GET",
                    "mediaType": "application/json"
                  }
                ]
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/suggestedTaxonomies",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "workflows": {
            "data": [],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/workflows",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "lockInfo": {
            "data": {
              "isLocked": false
            },
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/lockInfo",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "relationships": {
            "data": {
              "references": [],
              "referencedBy": [],
              "referencedBySites": []
            },
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/relationships",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=all",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            },
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=all",
              "rel": "canonical",
              "method": "GET",
              "mediaType": "application/json"
            },
            {
              "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/archive/items/COREC40D3505294444E998AA009FFF788931",
              "rel": "describedby",
              "method": "GET",
              "mediaType": "application/json"
            }
          ],
          "fields": {
            "type1_update": "archive_field_updated_version"
          },
          "typeCategory": "ContentType",
          "publishInfo": {
            "data": [],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishInfo",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "variations": {
            "data": [
              {
                "varType": "language",
                "masterItem": "COREC40D3505294444E998AA009FFF788931",
                "items": [
                  {
                    "id": "CORE662D161A892E483F95304EA53AFD6E12",
                    "name": "item_archive_hi",
                    "value": "hi",
                    "status": "draft",
                    "isPublished": false
                  },
                  {
                    "id": "COREC40D3505294444E998AA009FFF788931",
                    "name": "item_archive",
                    "value": "en-US",
                    "status": "draft",
                    "isPublished": false
                  }
                ]
              }
            ],
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/variations",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "permissions": {
            "links": [
              {
                "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/permissions",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "scheduled": false
        }

Example 5

/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6?expand=permissions

This reads an archived content item with id: CORE8C77233CC9C0477AA83E5667E5E84CC6 having expand=permissions as query parameter.

Response Body

{
        "isRestoreScheduled": false,
        "archivedBy": "cecusername",
        "archivedDate": {
          "value": "2022-01-11T17:42:02.535Z",
          "timezone": "UTC"
        },
        "id": "COREC40D3505294444E998AA009FFF788931",
        "type": "type1",
        "name": "item_archive",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2022-01-11T17:35:11.214Z",
          "timezone": "UTC"
        },
        "description": "",
        "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
        "slug": "3000000050015-item_archive",
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2022-01-11T17:40:38.171Z",
          "timezone": "UTC"
        },
        "language": "en-US",
        "translatable": true,
        "status": "draft",
        "languageIsMaster": true,
        "isPublished": false,
        "version": "0.2",
        "fileExtension": "contentItem",
        "latestVersion": "0.2",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "varSetId": "D552AF2DADBE3DE7E053020011AC62F4",
        "tags": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "changes": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/changes",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "suggestedTaxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/suggestedTaxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "workflows": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/workflows",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "lockInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/lockInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=permissions",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=permissions",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/archive/items/COREC40D3505294444E998AA009FFF788931",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/json"
          }
        ],
        "fields": {
          "type1_update": "archive_field_updated_version"
        },
        "typeCategory": "ContentType",
        "publishInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "variations": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "permissions": {
          "data": [
            {
              "action": "view"
            },
            {
              "action": "update"
            },
            {
              "action": "create"
            },
            {
              "action": "delete"
            }
          ],
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/permissions",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "scheduled": false
      }

Example 6

/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6?expand=lockInfo

This reads an archived content item with id: CORE8C77233CC9C0477AA83E5667E5E84CC6 having expand=lockInfo as query parameter.

Response Body

{
        "isRestoreScheduled": false,
        "archivedBy": "cecusername",
        "archivedDate": {
          "value": "2022-01-11T17:42:02.535Z",
          "timezone": "UTC"
        },
        "id": "COREC40D3505294444E998AA009FFF788931",
        "type": "type1",
        "name": "item_archive",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2022-01-11T17:35:11.214Z",
          "timezone": "UTC"
        },
        "description": "",
        "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
        "slug": "3000000050015-item_archive",
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2022-01-11T17:40:38.171Z",
          "timezone": "UTC"
        },
        "language": "en-US",
        "translatable": true,
        "status": "draft",
        "languageIsMaster": true,
        "isPublished": false,
        "version": "0.2",
        "fileExtension": "contentItem",
        "latestVersion": "0.2",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "varSetId": "D552AF2DADBE3DE7E053020011AC62F4",
        "tags": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "changes": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/changes",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "suggestedTaxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/suggestedTaxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "workflows": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/workflows",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "lockInfo": {
          "data": {
            "isLocked": false
          },
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/lockInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=lockInfo",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=lockInfo",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/archive/items/COREC40D3505294444E998AA009FFF788931",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/json"
          }
        ],
        "fields": {
          "type1_update": "archive_field_updated_version"
        },
        "typeCategory": "ContentType",
        "publishInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "variations": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "permissions": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/permissions",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "scheduled": false
       }

Example 7

/content/management/api/v1.1/archive/items/CORE8C77233CC9C0477AA83E5667E5E84CC6?expand=collections

This reads an archived content item with id: CORE8C77233CC9C0477AA83E5667E5E84CC6 having expand=collections as query parameter.

Response Body

      {
        "isRestoreScheduled": false,
        "archivedBy": "cecusername",
        "archivedDate": {
          "value": "2022-01-11T17:42:02.535Z",
          "timezone": "UTC"
        },
        "id": "COREC40D3505294444E998AA009FFF788931",
        "type": "type1",
        "name": "item_archive",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2022-01-11T17:35:11.214Z",
          "timezone": "UTC"
        },
        "description": "",
        "repositoryId": "5C841C5E24E746599558FFF9FCBBE874",
        "slug": "3000000050015-item_archive",
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2022-01-11T17:40:38.171Z",
          "timezone": "UTC"
        },
        "language": "en-US",
        "translatable": true,
        "status": "draft",
        "languageIsMaster": true,
        "isPublished": false,
        "version": "0.2",
        "fileExtension": "contentItem",
        "latestVersion": "0.2",
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "varSetId": "D552AF2DADBE3DE7E053020011AC62F4",
        "tags": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/tags",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "versionInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/versionInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "channels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/channels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "publishedChannels": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishedChannels",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "collections": {
          "data": [
            {
              "id": "COLLC6B5D62DF91547A0AA396D16CCE7BDFA"
            }
          ],
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/collections",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "changes": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/changes",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "metadata": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/metadata",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "taxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/taxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "suggestedTaxonomies": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/suggestedTaxonomies",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "workflows": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/workflows",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "lockInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/lockInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "relationships": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/relationships",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=collections",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931?expand=collections",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/archive/items/COREC40D3505294444E998AA009FFF788931",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/json"
          }
        ],
        "fields": {
          "type1_update": "archive_field_updated_version"
        },
        "typeCategory": "ContentType",
        "publishInfo": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/publishInfo",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "variations": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/variations",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "permissions": {
          "links": [
            {
              "href": "http://<hostname>/content/management/api/v1.1/archive/items/COREC40D3505294444E998AA009FFF788931/permissions",
              "rel": "self",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "scheduled": false
      }
    }