Performs Bulk Items Operations
/content/management/api/v1.1/bulkItemsOperations
Request
- application/json
-
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
-
Prefer(optional): string
This parameter is used to control the interaction type (synchronous/asynchronous) of the request. If the header is provided with value respond-async, it indicates that asynchronous interaction is preferred. Otherwise, synchronous interaction is preferred. Asynchronous request is responded with 202 status with a status link in the location header. Synchronous request is responded with 200 along with response body.Allowed Values:
[ "respond-async" ]
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
object
-
links(optional):
array links
Links of the bulk items operations resource.
-
operations(optional):
object BulkItemsOperationsActions
Operations that can be performed. Currently only one operation at a time is supported.
-
q(optional):
string
This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using OR operators. The value of query condition follows the format of id eq "{itemId}". Query condition on any item field other than id is not supported. Any operator other than eq (Equals) in the query condition is not supported.Example:
id eq "COREBE1BDF66159849B790CC9ACE49BD2199" OR id eq "CONT22AA154CDD884D81A3678E1BD37333B7"
array
-
Array of:
object Link
Link of the resource.
object
-
addCategories(optional):
object CategoryIds
CategoryIds
-
addChannels(optional):
object ChannelIds
ChannelIds
-
addCollections(optional):
object CollectionIds
CollectionIds
-
addTags(optional):
object Tags
Tags.
-
addToRepository(optional):
object AddToRepository
AddToRepository
-
approve(optional):
object Approve
Approve
-
changeTypeByItems(optional):
object ChangeTypeByItems
Change asset type for assets
-
completeWorkflowInstance(optional):
object BooleanOperation
BooleanOperation
-
convertToAdvancedVideo(optional):
object ConvertToAdvancedVideo
ConvertToAdvancedVideo
-
copy(optional):
object CopyItems
CopyItems
-
deleteItems(optional):
object DeleteItems
DeleteItems
-
executeScheduledTask(optional):
object ExecuteScheduledTask
ExecuteScheduledTask
-
generateRenditions(optional):
object GenerateRenditions
Generate renditions for content types
-
lock(optional):
object LockAssets
LockAssets
-
makeTranslatable(optional):
object BooleanOperation
BooleanOperation
-
publish(optional):
object Publish
Publish
-
rejectSuggestedCategories(optional):
object CategoryIds
CategoryIds
-
removeCategories(optional):
object CategoryIds
CategoryIds
-
removeChannels(optional):
object ChannelIds
ChannelIds
-
removeCollections(optional):
object CollectionIds
CollectionIds
-
removeTags(optional):
object Tags
Tags.
-
rollback(optional):
object Rollback
Rollback
-
setAsTranslated(optional):
object BooleanOperation
BooleanOperation
-
submitForApproval(optional):
object BooleanOperation
BooleanOperation
-
submitToWorkflow(optional):
object submitToWorkflow
submitToWorkflow
-
unlock(optional):
object UnlockAssets
UnlockAssets
-
unpublish(optional):
object Unpublish
Unpublish
-
validatePublish(optional):
object ValidatePublish
ValidatePublish
-
workflowAction(optional):
object WorkflowActionBean
WorkflowActionBean
object
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
object
-
categories(optional):
array categories
categories
-
items(optional):
array items
-
taxonomyId(optional):
object TaxonomyId
TaxonomyId
object
-
items(optional):
array items
-
tags(optional):
array tags
Tags of the item.
object
-
channels(optional):
array channels
Channels
-
collections(optional):
array collections
Collections
-
connectorId(optional):
string
connectorId
-
externalIds(optional):
array externalIds
externalIds
-
externalItems(optional):
array externalItems
externalItems
-
failedChannels(optional):
object FailedChannels
-
failedCollections(optional):
object FailedCollections
-
failedExternalIds(optional):
object FailedExternalIds
-
failedTags(optional):
object FailedTags
-
failedTaxonomies(optional):
object FailedTaxonomyCategories
-
items(optional):
array items
-
repositoryId(optional):
string
repositoryId
-
storageProvider(optional):
string
Allowed Values:
[ "docs", "kaltura" ]
source storageProvider of the externalIds -
tags(optional):
array tags
Add tags to items
-
taxonomies(optional):
array taxonomies
taxonomies
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
isExtendedWorkflow(optional):
boolean
If workflow is extended or not after approve in OIC
-
items(optional):
array items
-
value(optional):
boolean
value
object
-
failedItems(optional):
array failedItems
conversion failed items list
-
items(optional):
array items
conversion completed items list
-
setItems(optional):
array setItems
List of items to be converted
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
value(optional):
boolean
value
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
items on which the action is applied
-
provider(optional):
object Provider
Provider
object
-
channels(optional):
object ChannelsInCopy
-
collections(optional):
object CollectionsInCopy
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
message(optional):
array message
message
-
targetRepository(optional):
object RepositoryId
RepositoryId
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
value(optional):
boolean
value
object
-
taskId(optional):
string
The group id that is going to be executed
-
taskType(optional):
string
The type of the task
object
-
dependencies(optional):
boolean
dependencies to be included or not
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
items on which the action is applied
-
translations(optional):
object LockTranslations
object
-
channels(optional):
array channels
List of publish channels. If channels is not empty, items in the q are published to the given channels. If the channels is empty, all the items as per q are published to their respective targeted channels.
-
ids(optional):
array ids
links of the detailed published item ids.
-
ignoredItems(optional):
array ignoredItems
-
items(optional):
array items
-
itemVersions(optional):
object itemVersions
Additional Properties Allowed: additionalProperties
-
options(optional):
object PublishOptions
-
validation(optional):
object PublishValidation
PublishValidation
object
-
autoSubmit(optional):
boolean
-
failedItems(optional):
array failedItems
items on which the action failed
-
id(optional):
string
Workflow to which items are submitted for approval
-
includeDependencies(optional):
boolean
If dependencies are included or not during submission of items to workflow.
-
items(optional):
array items
-
itemWorkflows(optional):
array itemWorkflows
Items to be submitted to the specified workflows
object
-
dependencies(optional):
boolean
dependencies to be included or not
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
items on which the action is applied
-
translations(optional):
object UnlockTranslations
object
-
allowUnpublishFromActiveSite(optional):
boolean
whether to allow active site items to be unpublished.(defaults to false)
-
channels(optional):
array channels
List of unpublish channels. If channels is not empty, items in the q are unpublished to the given channels. If the channels is empty, all the items as per q are unpublished to their respective targeted channels.
-
ids(optional):
array ids
links of the detailed unpublished item ids.
-
items(optional):
array items
object
-
channels(optional):
array channels
List of channels to be validated for publish. If channels is not empty, items in the q are validated for publish against the given channels. If the channels is empty, all the items as per q are validated for publish against their respective targeted channels.
-
missingItems(optional):
array missingItems
-
validation(optional):
object PublishValidation
PublishValidation
-
validationResults(optional):
array validationResults
object
-
comments(optional):
string
comments related to the action taken
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
tasks(optional):
array tasks
Item to tasks mapping
-
value(optional):
string
action applied on the items
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
array
-
Array of:
object Link
Link of the resource.
object
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
array
-
Array of:
object CollectionId
CollectionId
object
-
language:
string
language of the tag.
-
links(optional):
array links
Links
-
name:
string
Name of the tag.
array
-
Array of:
object CollectionId
CollectionId
array
-
Array of:
object Item
Discriminator:
typeCategory
Item
object
-
channels(optional):
array channels
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
object
-
collections(optional):
array collections
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
object
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
object
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
-
tags(optional):
array tags
object
-
items(optional):
object items
Additional Properties Allowed: additionalPropertiesItems that failed to be categorizes.
-
taxonomies(optional):
array taxonomies
List of taxonomies and categories not assigned to the requested items
array
-
Array of:
object Item
Discriminator:
typeCategory
Item
object
typeCategory
-
changes(optional):
object ItemSubResourceListChangesInfo
Item SubResource.
-
channels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
collections(optional):
object ItemSubResourceListCollectionId
Item SubResource.
-
connectorFileInfo(optional):
object ItemSubResourceConnectorFileInfo
Item SubResource.
-
connectorId(optional):
string
Connector Id of the item.
-
connectorSyncEnabled(optional):
boolean
Connector Sync Enabled flag of the item.
-
createdBy(optional):
string
Created by.
-
createdByUser(optional):
object User
User object
-
createdDate(optional):
object date
date
-
description(optional):
string
description of the item
-
fields(optional):
object fields
Read Only:
true
Additional Properties Allowed: additionalPropertiesUser-defined fields data. Map. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request. -
fileExtension(optional):
string
Extension of the file.
-
id(optional):
string
id of the item. It is a required property in the get response and put request whereas it is not required in the post request.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
language(optional):
string
Language of the item.
-
languageIsMaster(optional):
boolean
Whether the item is master.
-
links(optional):
array links
Links
-
lockInfo(optional):
object ItemSubResourceLockInfo
Item SubResource.
-
metadata(optional):
object ItemMetadataInfo
ItemMetadataInfo
-
name(optional):
string
Name of the item. It is a required property in the get response and post/put request.
-
permissions(optional):
object ItemSubResourceListAction
Item SubResource.
-
publishedChannels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
publishInfo(optional):
object ItemSubResourceListPublishInfo
Item SubResource.
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
-
relationships(optional):
object ItemSubResourceRelationships
Item SubResource.
-
repositoryId(optional):
string
Repository of the item. It is a required property in the get response and post/put request.
-
scheduled(optional):
boolean
-
slug(optional):
string
URL slug of the item.
-
sourceId(optional):
string
Source Id.
-
status(optional):
string
Current status of the item.
-
suggestedTaxonomies(optional):
object ItemSubResourceListSuggestedTaxonomyInfo
Item SubResource.
-
tags(optional):
object ItemSubResourceListTag
Item SubResource.
-
taxonomies(optional):
object ItemSubResourceListTaxonomyInfo
Item SubResource.
-
translatable(optional):
boolean
Whether the item is translatable.
-
type(optional):
string
Name of the type. It is a required property in the get response and post/put request.
-
typeCategory(optional):
string
Read Only:
true
-
updatedBy(optional):
string
Updated by.
-
updatedByUser(optional):
object User
User object
-
updatedDate(optional):
object date
date
-
variations(optional):
object ItemSubResourceListVariationsInfo
Item SubResource.
-
version(optional):
string
The current revision version of this item.
-
versionInfo(optional):
object ItemSubResourceListVersionInfo
Item SubResource.
-
video(optional):
object VideoBean
VideoBean
-
workflowInstances(optional):
object WorkflowField
All mapped workflow fields
-
workflows(optional):
object ItemSubResourceListWorkflowInfo
Item SubResource.
object
-
displayName(optional):
string
Read Only:
true
display name of the user. -
email(optional):
string
Read Only:
true
email of the user. -
userID(optional):
integer(int64)
Read Only:
true
id of the user. -
userName(optional):
string
Read Only:
true
name of the user.
object
true
object
-
exif(optional):
object EXIFMetadata
EXIF Metadata
-
links(optional):
array links
Links
-
transcripts(optional):
object VideoTranscriptMetadata
Video Transcription Metadata
object
-
isAccessible(optional):
boolean
Whether the item is accessible.
object
-
duration(optional):
string
Read Only:
true
The duration of the video in ISO 8601 format. -
isFormatSupported(optional):
boolean
Read Only:
true
A boolean expressing if the video file format is supported. -
playback(optional):
object PlaybackBean
PlaybackBean
-
processing(optional):
object ProcessingBean
ProcessingBean
-
strip(optional):
object StripBean
StripBean
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
links(optional):
array links
-
source(optional):
string
Sub-resource associated to this item which is source of this change.
-
type(optional):
string
Type of change tracked for the given source.
-
value(optional):
boolean
True indicates a change. False indicates no current changes for this source/type.
object
-
connectorId(optional):
string
Connector id.
-
id(optional):
string
File id.
-
inUse(optional):
boolean
Represents whether the latest version of asset is using the file content.
-
version(optional):
integer(int32)
File version
object
object
-
isLocked(optional):
boolean
Represents whether the item is locked or not.
-
lockedBy(optional):
string
Locked by user
-
lockedDate(optional):
object date
date
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
array
-
Array of:
object ItemExtractedExifBean
ItemExtractedExifBean
array
-
Array of:
object Link
Link of the resource.
array
object
-
floatValue(optional):
number(float)
The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision.
-
handle(optional):
string
The handle or EXIF field name. This value is not translatable.
-
integerValue(optional):
integer(int32)
The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point.
-
links(optional):
array links
Links
-
rawId(optional):
string
The ID of the EXIF field. Uniquely identifies one EXIF field.
-
rawValue(optional):
string
The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value.
-
stringValue(optional):
string
The text value of the EXIF field. This value will be a text representation of the EXIF field value.
-
type(optional):
string
The data type of the EXIF field. (date, integer, float, string).
-
value(optional):
string
The display value of the EXIF field. This value will be a text representation of the actual type value of the EXIF field (date, int, float, string).
array
-
Array of:
object Videotranscript
Video transcript
array
-
Array of:
object Link
Link of the resource.
array
object
-
end(optional):
string
End of each transcript node.
-
id(optional):
string
Id of each transcript node.
-
links(optional):
array links
Links
-
start(optional):
string
Start of each transcript node.
-
text(optional):
string
Text of each transcript node.
object
-
action(optional):
string
Allowed Values:
[ "view", "update", "create", "delete" ]
action is allowed on the resource
object
-
channel(optional):
string
Target name
-
links(optional):
array links
Links
-
publishedBy(optional):
string
Published by
-
publishedDate(optional):
object date
date
-
slug(optional):
string
Published slug
-
version(optional):
string
Published version
object
-
referencedBy(optional):
array referencedBy
Referenced by ids
-
referencedBySitePlan(optional):
object Siteplanreference
Site plan reference
-
referencedBySites(optional):
array referencedBySites
Referenced by sites
-
references(optional):
array references
Reference ids
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the site plan.
-
links(optional):
array links
array
-
Array of:
object ReferencedBySites
ReferencedBySites
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
object
-
component(optional):
string
Component of the item
-
pageId(optional):
string
Page the item added to
-
site(optional):
string
Site the item added to
array
-
Array of:
object SuggestedTaxonomyInfo
SuggestedTaxonomyInfo
object
-
categories(optional):
array categories
Categories in the Suggested Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
array
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
isRejected(optional):
boolean
Status of the Suggested Category for the Item.
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
-
order(optional):
integer(int32)
Probability order of the Suggested Category across all the Taxonomies assigned to the repository.
object
-
apiName(optional):
string
The apiName of the Category node.
-
id(optional):
string
The id of the Category node.
-
name(optional):
string
The name of the Category node.
object
-
categories(optional):
array categories
Categories in the Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
object
-
items(optional):
array items
Content item variations.
-
links(optional):
array links
-
masterItem(optional):
string
Master item.
-
setId(optional):
string
Variation set id.
-
varType(optional):
string
Variation type name.
array
-
Array of:
object Language
LanguageItem
object
-
id(optional):
string
id of the item.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
links(optional):
array links
-
name(optional):
string
name of the item.
-
status(optional):
string
status of item
-
value(optional):
string
Language value
object
-
latestVersion(optional):
string
Latest version
-
publishedVersion(optional):
string
Published version
object
-
adaptiveStreams(optional):
object AdaptiveStreamsBean
AdaptiveStreamsBean
object
-
progress(optional):
string
Read Only:
true
The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.
object
-
frame(optional):
object StripFrameBean
StripFrameBean
object
-
dash(optional):
object PlaybackBean
PlaybackBean
-
hls(optional):
object PlaybackBean
PlaybackBean
object
-
count(optional):
integer(int32)
Read Only:
true
The number of frames in the strip image. -
height(optional):
integer(int32)
Read Only:
true
The height of the strip image. -
width(optional):
integer(int32)
Read Only:
true
The width of the strip image.
array
-
Array of:
object WorkflowInfo
WorkflowInfo.
array
-
Array of:
object Link
Link of the resource.
array
object
-
id(optional):
string
Workflow id.
-
instanceId:
string
Workflow instance id.
-
isCompleted(optional):
boolean
If workflow instance is completed or not in OIC.
-
links(optional):
array links
Links
-
name(optional):
string
Workflow name.
-
status(optional):
string
Workflow status.
-
submittedBy(optional):
string
Submitted by user
-
submittedDate(optional):
object date
date
object
array
object
-
categories(optional):
array categories
Categories to be assigned
-
id(optional):
string
The id of the Taxonomy.
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
message(optional):
string
failed item message.
-
name(optional):
string
name of the item.
array
-
Array of:
object Link
Link of the resource.
array
-
Array of:
object ChangeTypeItemBean
set information for change type
object
-
fields(optional):
object fields
Additional Properties Allowed: additionalPropertiesfields to be added as part of type conversion
-
id(optional):
string
id of the item
-
type(optional):
string
target type name
object
object
object
-
targetToChannel(optional):
array targetToChannel
targetToChannel
object
-
collectionName(optional):
string
Name of the collection to be created
object
-
id(optional):
string
-
name(optional):
string
Name of the repository. It is a required property in the get response and post/put request.
array
-
Array of:
object ChannelId
ChannelId
object
-
id(optional):
string
id of the copied item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
-
originalId(optional):
string
id of the original item.
array
-
Array of:
object Link
Link of the resource.
object
-
compiledAt(optional):
string
Date and time of this status message in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
-
compiledTime(optional):
string(date-time)
-
jobId(optional):
string
Content item rendition compilation job id.
-
progress(optional):
number(double)
Compilation job status progress percentage.
-
status(optional):
string
Compilation job status.
array
-
Array of:
object ContentItemRenditions
Content Rendition of a item
array
-
Array of:
object ContentRenditionFormat
Content Rendition Format
object
-
lockAll(optional):
boolean
lock all the translations in a set or a specific translation
array
-
Array of:
object ChannelId
ChannelId
array
-
Array of:
object Link
Link of the resource.
object
-
unlockAfterPublish(optional):
boolean
Unlock the items owned by user after successful publish
object
-
languageOnly(optional):
boolean
-
testOnly(optional):
boolean
-
verbosity(optional):
string
Allowed Values:
[ "none", "terse", "normal", "verbose" ]
object
-
channels(optional):
array channels
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
message(optional):
string
ignored item message.
-
name(optional):
string
name of the item.
array
-
Array of:
object Link
Link of the resource.
array
-
Array of:
object ItemWorkflows
ItemWorkflows
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
-
workflowInstanceId(optional):
string
workflow Instance Id to which an item is submitted for review.
array
-
Array of:
object Link
Link of the resource.
object
-
itemId(optional):
string
Item id
-
workflowId(optional):
string
Workflow id
object
-
unlockAll(optional):
boolean
Unlock all the translations in a set or a specific translation
array
-
Array of:
object ChannelId
ChannelId
array
-
Array of:
object Link
Link of the resource.
array
-
Array of:
object ChannelId
ChannelId
array
-
Array of:
object PublishValidationResult
Publish validation result for publishing items to channels
object
-
error(optional):
string
-
policyValidation(optional):
object PolicyValidationResult
PolicyValidationResult
object
-
dependencies(optional):
array dependencies
-
dependencyStatus(optional):
string
-
fileId(optional):
string
-
id(optional):
string
-
language(optional):
string
-
name(optional):
string
-
optionalDependency(optional):
string
-
primaryChannelId(optional):
string
-
type(optional):
string
-
validations(optional):
array validations
-
version(optional):
string
array
-
Array of:
object TaskItemMapping
TaskItemMapping
object
-
itemId(optional):
string
id of the item.
-
taskId(optional):
string
id of the workflow task.
Response
- application/json
200 Response
object
-
links(optional):
array links
Links of the bulk items operations resource.
-
operations(optional):
object BulkItemsOperationsActions
Operations that can be performed. Currently only one operation at a time is supported.
-
q(optional):
string
This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using OR operators. The value of query condition follows the format of id eq "{itemId}". Query condition on any item field other than id is not supported. Any operator other than eq (Equals) in the query condition is not supported.Example:
id eq "COREBE1BDF66159849B790CC9ACE49BD2199" OR id eq "CONT22AA154CDD884D81A3678E1BD37333B7"
array
-
Array of:
object Link
Link of the resource.
object
-
addCategories(optional):
object CategoryIds
CategoryIds
-
addChannels(optional):
object ChannelIds
ChannelIds
-
addCollections(optional):
object CollectionIds
CollectionIds
-
addTags(optional):
object Tags
Tags.
-
addToRepository(optional):
object AddToRepository
AddToRepository
-
approve(optional):
object Approve
Approve
-
changeTypeByItems(optional):
object ChangeTypeByItems
Change asset type for assets
-
completeWorkflowInstance(optional):
object BooleanOperation
BooleanOperation
-
convertToAdvancedVideo(optional):
object ConvertToAdvancedVideo
ConvertToAdvancedVideo
-
copy(optional):
object CopyItems
CopyItems
-
deleteItems(optional):
object DeleteItems
DeleteItems
-
executeScheduledTask(optional):
object ExecuteScheduledTask
ExecuteScheduledTask
-
generateRenditions(optional):
object GenerateRenditions
Generate renditions for content types
-
lock(optional):
object LockAssets
LockAssets
-
makeTranslatable(optional):
object BooleanOperation
BooleanOperation
-
publish(optional):
object Publish
Publish
-
rejectSuggestedCategories(optional):
object CategoryIds
CategoryIds
-
removeCategories(optional):
object CategoryIds
CategoryIds
-
removeChannels(optional):
object ChannelIds
ChannelIds
-
removeCollections(optional):
object CollectionIds
CollectionIds
-
removeTags(optional):
object Tags
Tags.
-
rollback(optional):
object Rollback
Rollback
-
setAsTranslated(optional):
object BooleanOperation
BooleanOperation
-
submitForApproval(optional):
object BooleanOperation
BooleanOperation
-
submitToWorkflow(optional):
object submitToWorkflow
submitToWorkflow
-
unlock(optional):
object UnlockAssets
UnlockAssets
-
unpublish(optional):
object Unpublish
Unpublish
-
validatePublish(optional):
object ValidatePublish
ValidatePublish
-
workflowAction(optional):
object WorkflowActionBean
WorkflowActionBean
object
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
object
-
categories(optional):
array categories
categories
-
items(optional):
array items
-
taxonomyId(optional):
object TaxonomyId
TaxonomyId
object
-
items(optional):
array items
-
tags(optional):
array tags
Tags of the item.
object
-
channels(optional):
array channels
Channels
-
collections(optional):
array collections
Collections
-
connectorId(optional):
string
connectorId
-
externalIds(optional):
array externalIds
externalIds
-
externalItems(optional):
array externalItems
externalItems
-
failedChannels(optional):
object FailedChannels
-
failedCollections(optional):
object FailedCollections
-
failedExternalIds(optional):
object FailedExternalIds
-
failedTags(optional):
object FailedTags
-
failedTaxonomies(optional):
object FailedTaxonomyCategories
-
items(optional):
array items
-
repositoryId(optional):
string
repositoryId
-
storageProvider(optional):
string
Allowed Values:
[ "docs", "kaltura" ]
source storageProvider of the externalIds -
tags(optional):
array tags
Add tags to items
-
taxonomies(optional):
array taxonomies
taxonomies
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
isExtendedWorkflow(optional):
boolean
If workflow is extended or not after approve in OIC
-
items(optional):
array items
-
value(optional):
boolean
value
object
-
failedItems(optional):
array failedItems
conversion failed items list
-
items(optional):
array items
conversion completed items list
-
setItems(optional):
array setItems
List of items to be converted
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
value(optional):
boolean
value
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
items on which the action is applied
-
provider(optional):
object Provider
Provider
object
-
channels(optional):
object ChannelsInCopy
-
collections(optional):
object CollectionsInCopy
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
message(optional):
array message
message
-
targetRepository(optional):
object RepositoryId
RepositoryId
object
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
value(optional):
boolean
value
object
-
taskId(optional):
string
The group id that is going to be executed
-
taskType(optional):
string
The type of the task
object
-
dependencies(optional):
boolean
dependencies to be included or not
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
items on which the action is applied
-
translations(optional):
object LockTranslations
object
-
channels(optional):
array channels
List of publish channels. If channels is not empty, items in the q are published to the given channels. If the channels is empty, all the items as per q are published to their respective targeted channels.
-
ids(optional):
array ids
links of the detailed published item ids.
-
ignoredItems(optional):
array ignoredItems
-
items(optional):
array items
-
itemVersions(optional):
object itemVersions
Additional Properties Allowed: additionalProperties
-
options(optional):
object PublishOptions
-
validation(optional):
object PublishValidation
PublishValidation
object
-
autoSubmit(optional):
boolean
-
failedItems(optional):
array failedItems
items on which the action failed
-
id(optional):
string
Workflow to which items are submitted for approval
-
includeDependencies(optional):
boolean
If dependencies are included or not during submission of items to workflow.
-
items(optional):
array items
-
itemWorkflows(optional):
array itemWorkflows
Items to be submitted to the specified workflows
object
-
dependencies(optional):
boolean
dependencies to be included or not
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
items on which the action is applied
-
translations(optional):
object UnlockTranslations
object
-
allowUnpublishFromActiveSite(optional):
boolean
whether to allow active site items to be unpublished.(defaults to false)
-
channels(optional):
array channels
List of unpublish channels. If channels is not empty, items in the q are unpublished to the given channels. If the channels is empty, all the items as per q are unpublished to their respective targeted channels.
-
ids(optional):
array ids
links of the detailed unpublished item ids.
-
items(optional):
array items
object
-
channels(optional):
array channels
List of channels to be validated for publish. If channels is not empty, items in the q are validated for publish against the given channels. If the channels is empty, all the items as per q are validated for publish against their respective targeted channels.
-
missingItems(optional):
array missingItems
-
validation(optional):
object PublishValidation
PublishValidation
-
validationResults(optional):
array validationResults
object
-
comments(optional):
string
comments related to the action taken
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
tasks(optional):
array tasks
Item to tasks mapping
-
value(optional):
string
action applied on the items
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
array
-
Array of:
object Link
Link of the resource.
object
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
array
-
Array of:
object CollectionId
CollectionId
object
-
language:
string
language of the tag.
-
links(optional):
array links
Links
-
name:
string
Name of the tag.
array
-
Array of:
object CollectionId
CollectionId
array
-
Array of:
object Item
Discriminator:
typeCategory
Item
object
-
channels(optional):
array channels
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
object
-
collections(optional):
array collections
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
object
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
object
-
items(optional):
object items
Additional Properties Allowed: additionalProperties
-
tags(optional):
array tags
object
-
items(optional):
object items
Additional Properties Allowed: additionalPropertiesItems that failed to be categorizes.
-
taxonomies(optional):
array taxonomies
List of taxonomies and categories not assigned to the requested items
array
-
Array of:
object Item
Discriminator:
typeCategory
Item
object
typeCategory
-
changes(optional):
object ItemSubResourceListChangesInfo
Item SubResource.
-
channels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
collections(optional):
object ItemSubResourceListCollectionId
Item SubResource.
-
connectorFileInfo(optional):
object ItemSubResourceConnectorFileInfo
Item SubResource.
-
connectorId(optional):
string
Connector Id of the item.
-
connectorSyncEnabled(optional):
boolean
Connector Sync Enabled flag of the item.
-
createdBy(optional):
string
Created by.
-
createdByUser(optional):
object User
User object
-
createdDate(optional):
object date
date
-
description(optional):
string
description of the item
-
fields(optional):
object fields
Read Only:
true
Additional Properties Allowed: additionalPropertiesUser-defined fields data. Map. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request. -
fileExtension(optional):
string
Extension of the file.
-
id(optional):
string
id of the item. It is a required property in the get response and put request whereas it is not required in the post request.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
language(optional):
string
Language of the item.
-
languageIsMaster(optional):
boolean
Whether the item is master.
-
links(optional):
array links
Links
-
lockInfo(optional):
object ItemSubResourceLockInfo
Item SubResource.
-
metadata(optional):
object ItemMetadataInfo
ItemMetadataInfo
-
name(optional):
string
Name of the item. It is a required property in the get response and post/put request.
-
permissions(optional):
object ItemSubResourceListAction
Item SubResource.
-
publishedChannels(optional):
object ItemSubResourceListChannelId
Item SubResource.
-
publishInfo(optional):
object ItemSubResourceListPublishInfo
Item SubResource.
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
-
relationships(optional):
object ItemSubResourceRelationships
Item SubResource.
-
repositoryId(optional):
string
Repository of the item. It is a required property in the get response and post/put request.
-
scheduled(optional):
boolean
-
slug(optional):
string
URL slug of the item.
-
sourceId(optional):
string
Source Id.
-
status(optional):
string
Current status of the item.
-
suggestedTaxonomies(optional):
object ItemSubResourceListSuggestedTaxonomyInfo
Item SubResource.
-
tags(optional):
object ItemSubResourceListTag
Item SubResource.
-
taxonomies(optional):
object ItemSubResourceListTaxonomyInfo
Item SubResource.
-
translatable(optional):
boolean
Whether the item is translatable.
-
type(optional):
string
Name of the type. It is a required property in the get response and post/put request.
-
typeCategory(optional):
string
Read Only:
true
-
updatedBy(optional):
string
Updated by.
-
updatedByUser(optional):
object User
User object
-
updatedDate(optional):
object date
date
-
variations(optional):
object ItemSubResourceListVariationsInfo
Item SubResource.
-
version(optional):
string
The current revision version of this item.
-
versionInfo(optional):
object ItemSubResourceListVersionInfo
Item SubResource.
-
video(optional):
object VideoBean
VideoBean
-
workflowInstances(optional):
object WorkflowField
All mapped workflow fields
-
workflows(optional):
object ItemSubResourceListWorkflowInfo
Item SubResource.
object
-
displayName(optional):
string
Read Only:
true
display name of the user. -
email(optional):
string
Read Only:
true
email of the user. -
userID(optional):
integer(int64)
Read Only:
true
id of the user. -
userName(optional):
string
Read Only:
true
name of the user.
object
true
object
-
exif(optional):
object EXIFMetadata
EXIF Metadata
-
links(optional):
array links
Links
-
transcripts(optional):
object VideoTranscriptMetadata
Video Transcription Metadata
object
-
isAccessible(optional):
boolean
Whether the item is accessible.
object
-
duration(optional):
string
Read Only:
true
The duration of the video in ISO 8601 format. -
isFormatSupported(optional):
boolean
Read Only:
true
A boolean expressing if the video file format is supported. -
playback(optional):
object PlaybackBean
PlaybackBean
-
processing(optional):
object ProcessingBean
ProcessingBean
-
strip(optional):
object StripBean
StripBean
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
links(optional):
array links
-
source(optional):
string
Sub-resource associated to this item which is source of this change.
-
type(optional):
string
Type of change tracked for the given source.
-
value(optional):
boolean
True indicates a change. False indicates no current changes for this source/type.
object
-
connectorId(optional):
string
Connector id.
-
id(optional):
string
File id.
-
inUse(optional):
boolean
Represents whether the latest version of asset is using the file content.
-
version(optional):
integer(int32)
File version
object
object
-
isLocked(optional):
boolean
Represents whether the item is locked or not.
-
lockedBy(optional):
string
Locked by user
-
lockedDate(optional):
object date
date
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
object
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
array
-
Array of:
object ItemExtractedExifBean
ItemExtractedExifBean
array
-
Array of:
object Link
Link of the resource.
array
object
-
floatValue(optional):
number(float)
The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision.
-
handle(optional):
string
The handle or EXIF field name. This value is not translatable.
-
integerValue(optional):
integer(int32)
The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point.
-
links(optional):
array links
Links
-
rawId(optional):
string
The ID of the EXIF field. Uniquely identifies one EXIF field.
-
rawValue(optional):
string
The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value.
-
stringValue(optional):
string
The text value of the EXIF field. This value will be a text representation of the EXIF field value.
-
type(optional):
string
The data type of the EXIF field. (date, integer, float, string).
-
value(optional):
string
The display value of the EXIF field. This value will be a text representation of the actual type value of the EXIF field (date, int, float, string).
array
-
Array of:
object Videotranscript
Video transcript
array
-
Array of:
object Link
Link of the resource.
array
object
-
end(optional):
string
End of each transcript node.
-
id(optional):
string
Id of each transcript node.
-
links(optional):
array links
Links
-
start(optional):
string
Start of each transcript node.
-
text(optional):
string
Text of each transcript node.
object
-
action(optional):
string
Allowed Values:
[ "view", "update", "create", "delete" ]
action is allowed on the resource
object
-
channel(optional):
string
Target name
-
links(optional):
array links
Links
-
publishedBy(optional):
string
Published by
-
publishedDate(optional):
object date
date
-
slug(optional):
string
Published slug
-
version(optional):
string
Published version
object
-
referencedBy(optional):
array referencedBy
Referenced by ids
-
referencedBySitePlan(optional):
object Siteplanreference
Site plan reference
-
referencedBySites(optional):
array referencedBySites
Referenced by sites
-
references(optional):
array references
Reference ids
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the site plan.
-
links(optional):
array links
array
-
Array of:
object ReferencedBySites
ReferencedBySites
array
-
Array of:
object References
References
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
-
reference(optional):
object ItemReferenceInfo
ItemReferenceInfo
object
-
component(optional):
string
Component of the item
-
pageId(optional):
string
Page the item added to
-
site(optional):
string
Site the item added to
array
-
Array of:
object SuggestedTaxonomyInfo
SuggestedTaxonomyInfo
object
-
categories(optional):
array categories
Categories in the Suggested Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
array
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
isRejected(optional):
boolean
Status of the Suggested Category for the Item.
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
-
order(optional):
integer(int32)
Probability order of the Suggested Category across all the Taxonomies assigned to the repository.
object
-
apiName(optional):
string
The apiName of the Category node.
-
id(optional):
string
The id of the Category node.
-
name(optional):
string
The name of the Category node.
object
-
categories(optional):
array categories
Categories in the Taxonomy the item belongs to.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
shortName(optional):
string
object
-
apiName(optional):
string
The apiName of the category assigned to the item.
-
id(optional):
string
-
links(optional):
array links
-
name(optional):
string
-
nodes(optional):
array nodes
Nodes in the category assigned to the item.
object
-
items(optional):
array items
Content item variations.
-
links(optional):
array links
-
masterItem(optional):
string
Master item.
-
setId(optional):
string
Variation set id.
-
varType(optional):
string
Variation type name.
array
-
Array of:
object Language
LanguageItem
object
-
id(optional):
string
id of the item.
-
isPublished(optional):
boolean
Whether the item is ever published.
-
links(optional):
array links
-
name(optional):
string
name of the item.
-
status(optional):
string
status of item
-
value(optional):
string
Language value
object
-
latestVersion(optional):
string
Latest version
-
publishedVersion(optional):
string
Published version
object
-
adaptiveStreams(optional):
object AdaptiveStreamsBean
AdaptiveStreamsBean
object
-
progress(optional):
string
Read Only:
true
The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.
object
-
frame(optional):
object StripFrameBean
StripFrameBean
object
-
dash(optional):
object PlaybackBean
PlaybackBean
-
hls(optional):
object PlaybackBean
PlaybackBean
object
-
count(optional):
integer(int32)
Read Only:
true
The number of frames in the strip image. -
height(optional):
integer(int32)
Read Only:
true
The height of the strip image. -
width(optional):
integer(int32)
Read Only:
true
The width of the strip image.
array
-
Array of:
object WorkflowInfo
WorkflowInfo.
array
-
Array of:
object Link
Link of the resource.
array
object
-
id(optional):
string
Workflow id.
-
instanceId:
string
Workflow instance id.
-
isCompleted(optional):
boolean
If workflow instance is completed or not in OIC.
-
links(optional):
array links
Links
-
name(optional):
string
Workflow name.
-
status(optional):
string
Workflow status.
-
submittedBy(optional):
string
Submitted by user
-
submittedDate(optional):
object date
date
object
array
object
-
categories(optional):
array categories
Categories to be assigned
-
id(optional):
string
The id of the Taxonomy.
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
message(optional):
string
failed item message.
-
name(optional):
string
name of the item.
array
-
Array of:
object Link
Link of the resource.
array
-
Array of:
object ChangeTypeItemBean
set information for change type
object
-
fields(optional):
object fields
Additional Properties Allowed: additionalPropertiesfields to be added as part of type conversion
-
id(optional):
string
id of the item
-
type(optional):
string
target type name
object
object
object
-
targetToChannel(optional):
array targetToChannel
targetToChannel
object
-
collectionName(optional):
string
Name of the collection to be created
object
-
id(optional):
string
-
name(optional):
string
Name of the repository. It is a required property in the get response and post/put request.
array
-
Array of:
object ChannelId
ChannelId
object
-
id(optional):
string
id of the copied item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
-
originalId(optional):
string
id of the original item.
array
-
Array of:
object Link
Link of the resource.
object
-
compiledAt(optional):
string
Date and time of this status message in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
-
compiledTime(optional):
string(date-time)
-
jobId(optional):
string
Content item rendition compilation job id.
-
progress(optional):
number(double)
Compilation job status progress percentage.
-
status(optional):
string
Compilation job status.
array
-
Array of:
object ContentItemRenditions
Content Rendition of a item
array
-
Array of:
object ContentRenditionFormat
Content Rendition Format
object
-
lockAll(optional):
boolean
lock all the translations in a set or a specific translation
array
-
Array of:
object ChannelId
ChannelId
array
-
Array of:
object Link
Link of the resource.
object
-
unlockAfterPublish(optional):
boolean
Unlock the items owned by user after successful publish
object
-
languageOnly(optional):
boolean
-
testOnly(optional):
boolean
-
verbosity(optional):
string
Allowed Values:
[ "none", "terse", "normal", "verbose" ]
object
-
channels(optional):
array channels
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
message(optional):
string
ignored item message.
-
name(optional):
string
name of the item.
array
-
Array of:
object Link
Link of the resource.
array
-
Array of:
object ItemWorkflows
ItemWorkflows
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
-
workflowInstanceId(optional):
string
workflow Instance Id to which an item is submitted for review.
array
-
Array of:
object Link
Link of the resource.
object
-
itemId(optional):
string
Item id
-
workflowId(optional):
string
Workflow id
object
-
unlockAll(optional):
boolean
Unlock all the translations in a set or a specific translation
array
-
Array of:
object ChannelId
ChannelId
array
-
Array of:
object Link
Link of the resource.
array
-
Array of:
object ChannelId
ChannelId
array
-
Array of:
object PublishValidationResult
Publish validation result for publishing items to channels
object
-
error(optional):
string
-
policyValidation(optional):
object PolicyValidationResult
PolicyValidationResult
object
-
dependencies(optional):
array dependencies
-
dependencyStatus(optional):
string
-
fileId(optional):
string
-
id(optional):
string
-
language(optional):
string
-
name(optional):
string
-
optionalDependency(optional):
string
-
primaryChannelId(optional):
string
-
type(optional):
string
-
validations(optional):
array validations
-
version(optional):
string
array
-
Array of:
object TaskItemMapping
TaskItemMapping
object
-
itemId(optional):
string
id of the item.
-
taskId(optional):
string
id of the workflow task.
202 Response
400 Response
403 Response
404 Response
409 Response
500 Response
Examples
The following example shows how to perform bulk items operations.
curl -i -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/bulkItemsOperations'
Example 1
The following example adds items to collections in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here O394B74B4B4764724341243AFB45934FF146514DB273 and OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE are ids of the collections. Replace payload with your own data.
/content/management/api/v1.1/bulkItemsOperations
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "addCollections": { "collections": [ { "id": "O394B74B4B4764724341243AFB45934FF146514DB273" }, { "id": "OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE" } ] } } }
Example 2
The following example adds items to collections in an asynchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here O394B74B4B4764724341243AFB45934FF146514DB273 and OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE are ids of the collections. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "addCollections": { "collections": [ { "id": "O394B74B4B4764724341243AFB45934FF146514DB273" }, { "id": "OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE" } ] } } }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065EDBD1BED1" }
Example 3
The following example removes items from collections in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here O394B74B4B4764724341243AFB45934FF146514DB273 and OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE are ids of the collections. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "removeCollections": { "collections": [ { "id": "O394B74B4B4764724341243AFB45934FF146514DB273" }, { "id": "OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE" } ] } } }
Example 4
The following example removes items from collections in an asynchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here O394B74B4B4764724341243AFB45934FF146514DB273 and OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE are ids of the collections. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "removeCollections": { "collections": [ { "id": "O394B74B4B4764724341243AFB45934FF146514DB273" }, { "id": "OCB02E4B485F4EE7FD1B5BCEDA1E411E23E3A682AFCE" } ] } } }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/535A92EAEEBD46E8AEF6065FDBB0DFB1" }
Example 5
The following example adds items to channels in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524 and CCA285F4809904B29E7235E5C35455027AB65D12495F are ids of the channels. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "addChannels": { "channels": [ { "id": "CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524" }, { "id": "CCA285F4809904B29E7235E5C35455027AB65D12495F" } ] } } }
Example 6
The following example adds items to channels in an asynchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524 and CCA285F4809904B29E7235E5C35455027AB65D12495F are ids of the collections. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "addChannels": { "channels": [ { "id": "CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524" }, { "id": "CCA285F4809904B29E7235E5C35455027AB65D12495F" } ] } } }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/305D91EAEEDD46E8AEF6061FDBB2BFF7" }
Example 7
The following example removes items from channels in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524 and CCA285F4809904B29E7235E5C35455027AB65D12495F are ids of the channels. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "addChannels": { "channels": [ { "id": "CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524" }, { "id": "CCA285F4809904B29E7235E5C35455027AB65D12495F" } ] } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 8
The following example removes items from channels in an asynchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Here CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524 and CCA285F4809904B29E7235E5C35455027AB65D12495F are ids of the collections. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "addChannels": { "channels": [ { "id": "CCD7CC4DD2100FE4D1F8B07D040EB639FE020DA7A524" }, { "id": "CCA285F4809904B29E7235E5C35455027AB65D12495F" } ] } } }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/535E51EABCDE01E8AEF6065FDBB0EEB1" }
Example 9
The following example makes items translatable in a synchronous way. If language is not set, this operation sets the repository default language as item language. Here CORE733F7C78E9484A67A4232DA5D32955FF, COREABC539EB32B746509FFC33806BBC4251 and CONTABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\" OR id eq \"CONTABC539EB32B746509FFC33806BBC4251\"", "operations": { "makeTranslatable": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 10
The following example makes items translatable in an asynchronous way. If language is not set, this operation sets the repository default language as item language. Here CORE733F7C78E9484A67A4232DA5D32955FF, COREABC539EB32B746509FFC33806BBC4251 and CONTABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\" OR id eq \"CONTABC539EB32B746509FFC33806BBC4251\"", "operations": { "makeTranslatable": { "value": "true" } } }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/805D91EAEEDD46E8AEF6065FDFD51EB1" }
Example 11
The following example makes items non-translatable in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data..
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\" OR id eq \"CONTABC539EB32B746509FFC33806BBC4251\"", "operations": { "makeTranslatable": { "value": "false" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 12
The following example makes items non-translatable in an asynchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.of a asynchronous operation in JSON format.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\" OR id eq \"CONTABC539EB32B746509FFC33806BBC4251\"", "operations": { "makeTranslatable": { "value": "false" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065FDBB0FDCB3" }
Example 13
The following example submits items for approval in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "submitForApproval": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 14
The following example submits items for approval in an asynchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "submitForApproval": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/225C91EAEEDD46E8AEF6065FDBB0DDFF4" }
Example 15
The following example submits items to a workflow in a synchronous way. Here CONT9AFC8CA4219D4AD2BE6F10DD989FBE03 and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CONT9AFC8CA4219D4AD2BE6F10DD989FBE03\"", "operations": { "submitToWorkflow": { "id": "CEE645FAB10C4A96B17CBF3C5964216E" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Response Body
{ "q": "id eq \"CONT9AFC8CA4219D4AD2BE6F10DD989FBE03\"", "operations": { "submitToWorkflow": { "id": "CEE645FAB10C4A96B17CBF3C5964216E", "items": [ { "id": "CONT9AFC8CA4219D4AD2BE6F10DD989FBE03", "name": "item1.JPG", "workflowInstanceId": "190077" } ], "failedItems": [ { "id": "COREABC539EB32B746509FFC33806BBC4251", "message": "item not found" } ] } }, "links": [ { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/bulkItemsOperations", "rel": "self", "method": "POST", "mediaType": "application/json" }, { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/bulkItemsOperations", "rel": "canonical", "method": "POST", "mediaType": "application/json" }, { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/metadata-catalog/bulkItemsOperations", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }
Example 16
The following example approves submitted items for approval in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "approve": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 17
The following example approves submitted items for approval though workflow in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "approve": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 18
The following example rejects submitted items for approval in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "approve": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 19
The following example rejects submitted items for approval through workflow in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and COREABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\"", "operations": { "approve": { "value": "false" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 20
The following example deletes translatable item with all its variations in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and CONT733F7C78E9484A67A4232DA5D32955FF are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"CONT733F7C78E9484A67A4232DA5D32955FF\"", "operations": { "deleteItems": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 21
The following example sets non-master translatable items as translated in an asynchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF, COREABC539EB32B746509FFC33806BBC4251 and CONTABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\" OR id eq \"CONTABC539EB32B746509FFC33806BBC4251\"", "operations": { "setAsTranslated": { "value": "true" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EABDDD46E1AEF6065FDBB0AZG1" }
Example 22
The following example sets non-master translatable items as non-translated in a synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF, COREABC539EB32B746509FFC33806BBC4251 and CONTABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"COREABC539EB32B746509FFC33806BBC4251\" OR id eq \"CONTABC539EB32B746509FFC33806BBC4251\"", "operations": { "setAsTranslated": { "value": "false" } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 23
The following example adds Digital Assets to repository in an asynchronous way. Here FD9C1E8B716572ED60822E50323438A5BC777EB4F78E is id of the repository. Here DCBE9E27FD70AC8245A998263EB1BDE1AB509295541B and D2DD8A6D2F4404D50471DA0269D2C29D9364C232D1FE are ids of the Digital Asset. Replace payload with your own data.
Request Payload
{ "operations": { "addToRepository": { "storageProvider": "docs", "repositoryId": "FD9C1E8B716572ED60822E50323438A5BC777EB4F78E", "externalIds": [ "DCBE9E27FD70AC8245A998263EB1BDE1AB509295541B", "D2DD8A6D2F4404D50471DA0269D2C29D9364C232D1FE" ], "tags": [ { "name": "manualTag1" } ], "collections": [ { "id": "7544D2E17A7F4DB3B21033F48FD061131" } ], "channels": [ { "id": "7DBE9BB8542C45AA92306B2E0874EA88" } ] } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065EDBD1BED1" }
Example 24
The following example validates items for publish in a synchronous way. Here CORED5710B874C0E459D9C5C87193FD7C36A and CONT86B1B61854A747D9BB4901903A98D2DF are ids of the items. Here CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929 and CC66DC0B9245E2F3712BC8B0211DC4BED717C60B6927 are ids of the channels. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORED5710B874C0E459D9C5C87193FD7C36A\" OR id eq \"CONT86B1B61854A747D9BB4901903A98D2DF\"", "operations": { "validatePublish": { "channels": [ { "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929" }, { "id": "CC66DC0B9245E2F3712BC8B0211DC4BED717C60B6927" } ], "validation": { "verbosity": "normal", "testOnly": false } } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 25
The following example publishes items in an asynchronous way. Here CORED5710B874C0E459D9C5C87193FD7C36A and CONT86B1B61854A747D9BB4901903A98D2DF are ids of the items. Here CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929 and CC66DC0B9245E2F3712BC8B0211DC4BED717C60B6927 are ids of the channels. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORED5710B874C0E459D9C5C87193FD7C36A\" OR id eq \"CONT86B1B61854A747D9BB4901903A98D2DF\"", "operations": { "publish": { "channels": [ { "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929" }, { "id": "CC66DC0B9245E2F3712BC8B0211DC4BED717C60B6927" } ] } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065FDBB0BEB3" }
Example 26
The following example unlocks all the items locked by user after successful Publish in an asynchronous way. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORED5710B874C0E459D9C5C87193FD7C36A\" OR id eq \"CONT86B1B61854A747D9BB4901903A98D2DF\"", "operations": { "publish": { "channels": [ { "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929" } ], "options": { "unlockAfterPublish": true } } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065FDBB0BEB3" }
Example 27
The following example unpublish items in an asynchronous way. Here CORED5710B874C0E459D9C5C87193FD7C36A and CONT86B1B61854A747D9BB4901903A98D2DF are ids of the items. Here CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929 and CC66DC0B9245E2F3712BC8B0211DC4BED717C60B6927 are ids of the channels. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORED5710B874C0E459D9C5C87193FD7C36A\" OR id eq \"CONT86B1B61854A747D9BB4901903A98D2DF\"", "operations": { "unpublish": { "channels": [ { "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929" }, { "id": "CC66DC0B9245E2F3712BC8B0211DC4BED717C60B6927" } ] } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065FDBB0BEB4" }
Example 28
The following example converts seeded type assets to Digital types in asynchronous way. Synchronous interaction is not supported for this api. Here CONT2ED74433CAE6492B9CD6722A06D654EC and CONT2B1CB3F5CB054993A921FF6B61187F82 are ids of the items. CDT1 is target type name. Replace payload with your own data.
Request Payload
{ "operations": { "changeTypeByItems": { "setItems": [ { "id": "CONT2ED74433CAE6492B9CD6722A06D654EC", "type": "CDT1", "fields": { "field1": "value1" } }, { "id": "CONT2B1CB3F5CB054993A921FF6B61187F82", "type": "CDT1", "fields": { "field1": "value2" } } ] } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location" :"https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065EDBD1BED1" }
Example 29
The following example adds Digital Asset to repository as translation of a non-file shared asset in an asynchronous way. Here 61BB60A5F7144F298499B36E14BE5122 is id of the repository. Here DE4FBC3E20BC943E4433C889733CFDF0E6C0564DDEE9 is the id of the Digital Asset. Replace payload with your own data.
Request Payload
{ "operations": { "addToRepository": { "repositoryId": "61BB60A5F7144F298499B36E14BE5122", "connectorId": "Documents", "externalItems": [ { "externalId": "DE4FBC3E20BC943E4433C889733CFDF0E6C0564DDEE9", "type": "CDTType", "language": "fr", "sourceId": "CONT17CEABD6DD2D49F587DCE0AB4AA3A5D3", "fields": { "field1": "<p>Nature Image</p>\n", "field2": "Twilight scene" }, "translatable": true } ] } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest", "Prefer": "respond-async" }
Response Headers
{ "Location": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/205D91EAEEDD46E8AEF6065EDBD1BED1" }
Example 30
The following example submit items along with dependencies to a workflow in a synchronous way. Here CONT9AFC8CA4219D4AD2BE6F10DD989FBE03 is id of the item and COREABC539EB32B746509FFC33806BBC4251 is its dependent asset. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CONT9AFC8CA4219D4AD2BE6F10DD989FBE03\"", "operations": { "submitToWorkflow": { "id": "CEE645FAB10C4A96B17CBF3C5964216E", "includeDependencies": true } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Response Body
{ "q": "id eq \"CONT9AFC8CA4219D4AD2BE6F10DD989FBE03\"", "operations": { "submitToWorkflow": { "id": "CEE645FAB10C4A96B17CBF3C5964216E", "includeDependencies": true, "items": [ { "id": "COREABC539EB32B746509FFC33806BBC4251", "name": "item1", "workflowInstanceId": "190077" }, { "id": "CONT9AFC8CA4219D4AD2BE6F10DD989FBE03", "name": "Image1.JPG", "workflowInstanceId": "190077" } ] } }, "links": [ { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/bulkItemsOperations", "rel": "self", "method": "POST", "mediaType": "application/json" }, { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/bulkItemsOperations", "rel": "canonical", "method": "POST", "mediaType": "application/json" }, { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/metadata-catalog/bulkItemsOperations", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }
Example 31
The following example lock items along with its dependencies in synchronous way. Here CORE733F7C78E9484A67A4232DA5D32955FF and CONTABC539EB32B746509FFC33806BBC4251 are ids of the items. Replace payload with your own data.
Request Payload
{ "q": "id eq \"CORE733F7C78E9484A67A4232DA5D32955FF\" OR id eq \"CONTABC539EB32B746509FFC33806BBC4251\"", "operations": { "lock": { "dependencies": true } } }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Response Body
{ "q": "id eq \"CONT9AFC8CA4219D4AD2BE6F10DD989FBE03\"", "operations": { "submitToWorkflow": { "id": "CEE645FAB10C4A96B17CBF3C5964216E", "includeDependencies": true, "items": [ { "id": "COREABC539EB32B746509FFC33806BBC4251", "name": "item1", "workflowInstanceId": "190077" }, { "id": "CONT9AFC8CA4219D4AD2BE6F10DD989FBE03", "name": "Image1.JPG", "workflowInstanceId": "190077" } ] } }, "links": [ { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/bulkItemsOperations", "rel": "self", "method": "POST", "mediaType": "application/json" }, { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/bulkItemsOperations", "rel": "canonical", "method": "POST", "mediaType": "application/json" }, { "href": "http://swebcli-oracle.testec.cec.oraclecorp.com:8080/content/management/api/v1.1/metadata-catalog/bulkItemsOperations", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }