All REST Endpoints
Archive
The resource to manage archived assets
- Cancel the item scheduled for restore
- Method: putPath:
/content/management/api/v1.1/archive/items/{id}/cancelRestore
- Schedule an item for restore
- Method: putPath:
/content/management/api/v1.1/archive/items/{id}/restore
- Delete an Archived Item
- Method: deletePath:
/content/management/api/v1.1/archive/items/{id}
- List all Taxonomies and Categories of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/taxonomies
- List Channels of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/channels
- List Collections of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/collections
- List Permissions of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/permissions
- List Published Channels of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/publishedChannels
- List Relationships of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/relationships
- List Tags of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/tags
- List Variations of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/variations
- Read a type of metadata of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/metadata/{metadataType}
- Read an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}
- Read Lock Info of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/lockInfo
- Read Publish Info of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/publishInfo
- Read the Metadata of a Given Archived Item.
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/metadata
- Read Version Info of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/versionInfo
- Read Workflow Instances of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/workflowInstances
- Read Workflows of an Archived Item
- Method: getPath:
/content/management/api/v1.1/archive/items/{id}/workflows
Archive Bulk Operations
The resource to manage bulk operations on archived assets
- Performs Bulk Delete Archive Items Operation
- Method: postPath:
/content/management/api/v1.1/archive/items/.bulk/delete
- Performs Bulk Items CancelRestore Operation
- Method: postPath:
/content/management/api/v1.1/archive/items/.bulk/cancelRestore
- Performs Bulk Items Restore Operation
- Method: postPath:
/content/management/api/v1.1/archive/items/.bulk/restore
- Read Archived Items Bulk CancelRestore Operation Status
- Method: getPath:
/content/management/api/v1.1/archive/items/.bulk/cancelRestore/{statusId}
- Read Archived Items Bulk Delete Operation Status
- Method: getPath:
/content/management/api/v1.1/archive/items/.bulk/delete/{statusId}
- Read Archived Items Bulk Restore Operation Status
- Method: getPath:
/content/management/api/v1.1/archive/items/.bulk/restore/{statusId}
Archive Items Search
The resource to manage archived items search
- Query Archived Items
- Method: getPath:
/content/management/api/v1.1/archive/items
Asset Refresh Bulk Operations
The resource to manage bulk operations for asset refresh.
- Performs Bulk Items Asset Refresh Operation
- Method: postPath:
/content/management/api/v1.1/items/.bulk/assetRefresh
- Performs Bulk Items Asset Refresh Validation Operation
- Method: postPath:
/content/management/api/v1.1/items/.bulk/validateAssetRefresh
- Read Bulk Items Asset Refresh Operation Status
- Method: getPath:
/content/management/api/v1.1/items/.bulk/assetRefresh/{statusId}
- Read Bulk Items Asset Refresh Validation Operation Status
- Method: getPath:
/content/management/api/v1.1/items/.bulk/validateAssetRefresh/{statusId}
Assign Primary Channel to Asset Bulk Operations
The resource to manage bulk operations for assigning primary channel.
- Performs Bulk Items Assign Primary Channel Operation
- Method: postPath:
/content/management/api/v1.1/items/.bulk/assignPrimaryChannel
- Read Bulk Items Assign Primary Channel Operation Status
- Method: getPath:
/content/management/api/v1.1/items/.bulk/assignPrimaryChannel/{statusId}
AutoSuggestions
The operations from the AutoSuggestions category.
- Suggest item keywords for auto-completion of default search
- Method: getPath:
/content/management/api/v1.1/items/suggest
Channel Secret
The operations from the Channel Secret category.
- Delete the channel secret
- Method: deletePath:
/content/management/api/v1.1/channels/{id}/channelSecret
- Generate a channel secret
- Method: postPath:
/content/management/api/v1.1/channels/{id}/channelSecret
- Refresh channel secret
- Method: putPath:
/content/management/api/v1.1/channels/{id}/channelSecret
Channels
The resources to manage channels.
- Create a Channel
- Method: postPath:
/content/management/api/v1.1/channels
- Delete a Channel
- Method: deletePath:
/content/management/api/v1.1/channels/{id}
- List All Channels
- Method: getPath:
/content/management/api/v1.1/channels
- List All Permissions on a Channel
- Method: getPath:
/content/management/api/v1.1/channels/{id}/permissions
- Read a Channel
- Method: getPath:
/content/management/api/v1.1/channels/{id}
- Update a Channel
- Method: putPath:
/content/management/api/v1.1/channels/{id}
Collections
The resources to manage collections.
- Create a Collection
- Method: postPath:
/content/management/api/v1.1/repositories/{id}/collections
- Delete a Collection
- Method: deletePath:
/content/management/api/v1.1/repositories/{id}/collections/{collectionId}
- List All Collections in a Repository
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/collections
- List All Permissions on a Collection
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/collections/{collectionId}/permissions
- Read a Collection
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/collections/{collectionId}
- Update a Collection
- Method: putPath:
/content/management/api/v1.1/repositories/{id}/collections/{collectionId}
Connectors
The operations from the Connectors category.
- List All Connectors
- Method: getPath:
/content/management/api/v1.1/connectors
Digital Item Renditions
The resources to manage digital item renditions.
- Get Digital Item Native File
- Method: getPath:
/content/management/api/v1.1/assets/{id}/native
- Get Digital Item Native File with Filename
- Method: getPath:
/content/management/api/v1.1/assets/{id}/native/{filename}
- Get Rendition of a Digital Item
- Method: getPath:
/content/management/api/v1.1/assets/{id}/{rendition}
- Get Rendition of a Digital Item with Filename
- Method: getPath:
/content/management/api/v1.1/assets/{id}/versions/{version}/{rendition}/{filename}
- Get Rendition of a Digital Item with Filename
- Method: getPath:
/content/management/api/v1.1/assets/{id}/{rendition}/{filename}
Digital Item Renditions by slug
The resources to manage digital item renditions by slug.
- Get Digital Item Native File by Slug
- Method: getPath:
/content/management/api/v1.1/assets/.by.slug/{slug}/native
- Get Digital Item Native File by Slug with Filename
- Method: getPath:
/content/management/api/v1.1/assets/.by.slug/{slug}/native/{filename}
- Get Rendition of a Digital Item by Slug
- Method: getPath:
/content/management/api/v1.1/assets/.by.slug/{slug}/{rendition}
- Get Rendition of a Digital Item by Slug with Filename
- Method: getPath:
/content/management/api/v1.1/assets/.by.slug/{slug}/{rendition}/{filename}
- Get Rendition of a Digital Item Version by Slug with Filename
- Method: getPath:
/content/management/api/v1.1/assets/.by.slug/{slug}/versions/{version}/{rendition}/{filename}
Editorial Roles
The operations from the Editorial Roles category.
- Copy Editorial Role
- Method: postPath:
/content/management/api/v1.1/editorialRoles/{roleId}/copy
- Create Editorial Role
- Method: postPath:
/content/management/api/v1.1/editorialRoles
- Delete Editorial Role
- Method: deletePath:
/content/management/api/v1.1/editorialRoles/{roleId}
- List All Permissions on an Editorial Role
- Method: getPath:
/content/management/api/v1.1/editorialRoles/{roleId}/permissions
- List Editorial Role Referenced By Repositories
- Method: getPath:
/content/management/api/v1.1/editorialRoles/{roleId}/referencedByRepositories
- List Editorial Roles
- Method: getPath:
/content/management/api/v1.1/editorialRoles
- Read Editorial Role
- Method: getPath:
/content/management/api/v1.1/editorialRoles/{roleId}
- Update Editorial Role
- Method: putPath:
/content/management/api/v1.1/editorialRoles/{roleId}
File Extensions
The operations from the File Extensions category.
- List File Extensions
- Method: getPath:
/content/management/api/v1.1/fileExtensions
- Read a File Extension
- Method: getPath:
/content/management/api/v1.1/fileExtensions/{fileExtension}
Item Revisions
The operations from the Item Revisions category.
- List item revisions
- Method: getPath:
/content/management/api/v1.1/items/{guid}/versions
- List item revisions by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/versions
- Read an item revision
- Method: getPath:
/content/management/api/v1.1/items/{guid}/versions/{version}
- Read an item revision by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/versions/{version}
Item Variations
The resources to manage items variations.
- List All Item Variations of a Variation Type
- Method: getPath:
/content/management/api/v1.1/items/{id}/variations/{variationType}
- Read Item Variation of a Variation Type Value
- Method: getPath:
/content/management/api/v1.1/items/{id}/variations/{variationType}/{variationValue}
- Read Item Variations by Variation Type
- Method: getPath:
/content/management/api/v1.1/items/{id}/variations/{variationType}/master
- Update Master Item of an Item Variations Set
- Method: putPath:
/content/management/api/v1.1/items/{id}/variations/{variationType}/master
Items
The resources to manage items.
- Archive an item
- Method: postPath:
/content/management/api/v1.1/items/{id}/archive
- Add rendition to a given item.
- Method: postPath:
/content/management/api/v1.1/items/{id}/renditions
- Bulk Transcript Operations.
- Method: postPath:
/content/management/api/v1.1/items/{id}/metadata/transcripts/.bulk
- Complete an Item Workflow Instance
- Method: putPath:
/content/management/api/v1.1/items/{id}/completeWorkflowInstance
- Create a Digital Item
- Method: postPath:
/content/management/api/v1.1/items/
- Creates a transcript with the given information in the payload.
- Method: postPath:
/content/management/api/v1.1/items/{id}/metadata/{metadataType}
- Creates an Item
- Method: postPath:
/content/management/api/v1.1/items
- Delete a transcript node.
- Method: deletePath:
/content/management/api/v1.1/items/{id}/metadata/transcripts/{transcriptId}
- Delete a type of metadata of an Item
- Method: deletePath:
/content/management/api/v1.1/items/{id}/metadata/{metadataType}
- Delete an Item
- Method: deletePath:
/content/management/api/v1.1/items/{id}
- Generate Taxonomy suggestions for the content items OnDemand
- Method: postPath:
/content/management/api/v1.1/items/{id}/generateTaxonomySuggestions
- Get add rendition status on a item
- Method: getPath:
/content/management/api/v1.1/items/{id}/renditions/.status/{statusId}
- Get all the mapped EXIF Metadata fields.
- Method: getPath:
/content/management/api/v1.1/items/metadata/exif
- Get item bulk transcript operations status.
- Method: getPath:
/content/management/api/v1.1/items/{id}/metadata/transcripts/.bulk/.status/{statusId}
- Get the item workflow instance details.
- Method: getPath:
/content/management/api/v1.1/items/{id}/workflows/{instanceId}
- List all Suggested Taxonomies and Categories of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/suggestedTaxonomies
- List all Taxonomies and Categories of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/taxonomies
- List All Time Zones
- Method: getPath:
/content/management/api/v1.1/timeZones
- List Channels of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/channels
- List Collections of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/collections
- List Permissions of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/permissions
- List Published Channels of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/publishedChannels
- List Relationships of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/relationships
- List Tags of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/tags
- List Variations of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/variations
- Patches a transcript node.
- Method: patchPath:
/content/management/api/v1.1/items/{id}/metadata/transcripts/{transcriptId}
- Read a type of metadata of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/metadata/{metadataType}
- Read an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}
- Read Lock Info of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/lockInfo
- Read OnDemand Taxonomy Suggestion Operations Status
- Method: getPath:
/content/management/api/v1.1/items/{id}/generateTaxonomySuggestions/{jobId}
- Read Publish Info of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/publishInfo
- Read the ConnectorFileInfo of a given item.
- Method: getPath:
/content/management/api/v1.1/items/{id}/connectorFileInfo
- Read the Metadata of a given item.
- Method: getPath:
/content/management/api/v1.1/items/{id}/metadata
- Read transcript node of the item transcripts
- Method: getPath:
/content/management/api/v1.1/items/{id}/metadata/transcripts/{transcriptId}
- Read Version Info of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/versionInfo
- Read Workflow Instances of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/workflowInstances
- Read Workflows of an Item
- Method: getPath:
/content/management/api/v1.1/items/{id}/workflows
- Restores the auto generated subtitles.
- Method: putPath:
/content/management/api/v1.1/items/{id}/metadata/transcripts/restore
- Submit an Item to Workflow
- Method: postPath:
/content/management/api/v1.1/items/{id}/submitToWorkflow
- Take Action on a Workflow Task.
- Method: postPath:
/content/management/api/v1.1/items/{id}/workflowAction
- Terminate the item workflow instance.
- Method: deletePath:
/content/management/api/v1.1/items/{id}/workflows/{instanceId}
- Update a Digital Item with new File
- Method: putPath:
/content/management/api/v1.1/items/{id}/
- Update an Item
- Method: putPath:
/content/management/api/v1.1/items/{id}
- Update Lock status of an Item
- Method: putPath:
/content/management/api/v1.1/items/{id}/lockInfo
Items Bulk Download
The operations from the Items Bulk Download category.
- Abort the specified bulk download job
- Method: deletePath:
/content/management/api/v1.1/items/_download/{jobId}
- Download the zip file for the specified bulk download job.
- Method: getPath:
/content/management/api/v1.1/items/_download/{jobId}/package
- Get the status of the specified bulk download job.
- Method: getPath:
/content/management/api/v1.1/items/_download/{jobId}
- Request a bulk download for a set of assets.
- Method: postPath:
/content/management/api/v1.1/items/_download
Items Bulk Operations
The resources to manage bulk items operations.
- Performs Bulk Items Archive Operation
- Method: postPath:
/content/management/api/v1.1/bulkItemsOperations/archive
- Performs Bulk Items Operations
- Method: postPath:
/content/management/api/v1.1/bulkItemsOperations
- Read Items Bulk Archive Operation Status
- Method: getPath:
/content/management/api/v1.1/bulkItemsOperations/archive/{statusId}
- Read Items Bulk Operations Publish Item ids
- Method: getPath:
/content/management/api/v1.1/bulkItemsOperations/publish/{statusId}/ids
- Read Items Bulk Operations Status
- Method: getPath:
/content/management/api/v1.1/bulkItemsOperations/{statusId}
Items Search
The resources to manage items search.
- Get Similar Items Job Status
- Method: getPath:
/content/management/api/v1.1/items/{id}/similarItems/_status/{statusId}
- Query Items
- Method: getPath:
/content/management/api/v1.1/items
- Query Similar Items
- Method: getPath:
/content/management/api/v1.1/items/{id}/similarItems
Items by slug
The resources to manage items by slug.
- List all Item Variations of a Variation Type by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/variations/{variationType}
- List Channels of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/channels
- List Collections of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/collections
- List Lock Info of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/lockInfo
- List Permissions of an Item
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/permissions
- List Publish Info of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/publishInfo
- List Published Channels of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/publishedChannels
- List Relationships of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/relationships
- List Tags of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/tags
- List Taxonomies of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/taxonomies
- List Variations of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/variations
- List Version Info of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/versionInfo
- List Workflow Info of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/workflows
- List Workflow Instances of an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/workflowInstances
- Read an Item by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}
- Read Item Variation of a Variation Type Value by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/variations/{variationType}/{variationValue}
- Read master of an Item Variation set by slug
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/variations/{variationType}/master
- Read the ConnectorFileInfo of a given item by slug.
- Method: getPath:
/content/management/api/v1.1/items/.by.slug/{slug}/connectorFileInfo
Language codes
The resources to manage language codes
- Create a Custom Language Code
- Method: postPath:
/content/management/api/v1.1/l10n/languageCodes
- Delete a Language code
- Method: deletePath:
/content/management/api/v1.1/l10n/languageCodes/{code}
- List all valid language codes
- Method: getPath:
/content/management/api/v1.1/l10n/languageCodes
- Read a language code
- Method: getPath:
/content/management/api/v1.1/l10n/languageCodes/{code}
- Update a Language Code
- Method: putPath:
/content/management/api/v1.1/l10n/languageCodes/{code}
Languages
The resources to manage languages.
- Read Language
- Method: getPath:
/content/management/api/v1.1/languageCodes
Localization Policies
The resources to manage localization policies.
- Create a Localization Policy
- Method: postPath:
/content/management/api/v1.1/localizationPolicies
- Delete a Localization Policy
- Method: deletePath:
/content/management/api/v1.1/localizationPolicies/{id}
- List All Localization Policies
- Method: getPath:
/content/management/api/v1.1/localizationPolicies
- Read a Localization Policy
- Method: getPath:
/content/management/api/v1.1/localizationPolicies/{id}
- Update a Localization Policy
- Method: putPath:
/content/management/api/v1.1/localizationPolicies/{id}
OAuth Tokens
The operations from the OAuth Tokens category.
- Generate an OAuth Token
- Method: postPath:
/content/management/api/v1.1/channels/{id}/oauthToken
Permission Operations
The operations from the Permission Operations category.
- Performs Permission Operations on resource
- Method: postPath:
/content/management/api/v1.1/permissionOperations
- Read Permission Operations Status
- Method: getPath:
/content/management/api/v1.1/permissionOperations/{statusId}
Permission Sets
The operations from the Permission Sets category.
- Convert a Permission Set.
- Method: postPath:
/content/management/api/v1.1/repositories/{id}/permissionSets/{permissionSetId}/convertToEditorialRole
- Create a Permission Set
- Method: postPath:
/content/management/api/v1.1/repositories/{id}/permissionSets
- Delete a Permission Set.
- Method: deletePath:
/content/management/api/v1.1/repositories/{id}/permissionSets/{permissionSetId}
- List Permission Sets
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/permissionSets
- Read a Permission Set
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/permissionSets/{permissionSetId}
- Update a Permission Set.
- Method: putPath:
/content/management/api/v1.1/repositories/{id}/permissionSets/{permissionSetId}
Provider Tokens
The operations from the Provider Tokens category.
- Generate a provider token
- Method: postPath:
/content/management/api/v1.1/items/{id}/versions/{version}/providerTokens
Recommendations
The resource to manage recommendations.
- Approve or reject a recommendation.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendations/{id}/approve
- Create a new Recommendation.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendations
- Create an Audience Attributes.
- Method: postPath:
/content/management/api/v1.1/personalization/audienceAttributes
- Delete a Recommendation.
- Method: deletePath:
/content/management/api/v1.1/personalization/recommendations/{id}
- Delete an audience attribute by id.
- Method: deletePath:
/content/management/api/v1.1/personalization/audienceAttributes/{id}
- List all Audience Attributes.
- Method: getPath:
/content/management/api/v1.1/personalization/audienceAttributes
- List all recommendations
- Method: getPath:
/content/management/api/v1.1/personalization/recommendations
- Obtain the results from the recommendation by apiName.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendationResults/{apiName}
- Obtain the results from the recommendation by id.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendationResults/.by.id/{id}
- Publish a Recommendation.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendations/{id}/publish
- Read a specific audience attributes by id.
- Method: getPath:
/content/management/api/v1.1/personalization/audienceAttributes/{id}
- Read a specific category by id.
- Method: getPath:
/content/management/api/v1.1/personalization/categories/{id}
- Read a specific Recommendation by id.
- Method: getPath:
/content/management/api/v1.1/personalization/recommendations/{id}
- Read publish job status.
- Method: getPath:
/content/management/api/v1.1/personalization/recommendations/{id}/publish/{statusId}
- Read the Recommendation's published Item ids
- Method: getPath:
/content/management/api/v1.1/personalization/recommendations/{id}/publish/{statusId}/ids
- Read the Recommendation's unpublished Item ids
- Method: getPath:
/content/management/api/v1.1/personalization/recommendations/{id}/unpublish/{statusId}/ids
- Read unpublish job status.
- Method: getPath:
/content/management/api/v1.1/personalization/recommendations/{id}/unpublish/{statusId}
- Submit a recommendation for approval.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendations/{id}/submitForApproval
- This resource returns a list of available attribute categories.
- Method: getPath:
/content/management/api/v1.1/personalization/categories
- Unpublish a Recommendation.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendations/{id}/unpublish
- Update a Recommendation.
- Method: putPath:
/content/management/api/v1.1/personalization/recommendations/{id}
- Update an Audience Attribute.
- Method: putPath:
/content/management/api/v1.1/personalization/audienceAttributes/{id}
- Validate a recommendation.
- Method: postPath:
/content/management/api/v1.1/personalization/recommendations/{id}/validatePublish
Repositories
The resources to manage repositories.
- Create a Repository
- Method: postPath:
/content/management/api/v1.1/repositories
- Delete a Repository
- Method: deletePath:
/content/management/api/v1.1/repositories/{id}
- List All Permissions on a Repository
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/permissions
- List All Repositories
- Method: getPath:
/content/management/api/v1.1/repositories
- List Repository Assigned Taxonomies
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/assignedTaxonomies
- List Repository Assigned Taxonomy's categories
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/assignedTaxonomies/{taxonomyId}/categories
- List Repository Assigned Types
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/assignedTypes
- List Repository Editorial Roles
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/editorialRoles
- Read a Repository
- Method: getPath:
/content/management/api/v1.1/repositories/{id}
- Read Repository Assigned Taxonomy's category
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/assignedTaxonomies/{taxonomyId}/categories/{categoryId}
- Read Repository Editorial Role
- Method: getPath:
/content/management/api/v1.1/repositories/{id}/editorialRoles/{roleId}
- Update a Repository
- Method: putPath:
/content/management/api/v1.1/repositories/{id}
- Validate Editorial Role
- Method: postPath:
/content/management/api/v1.1/repositories/{id}/assignRoleValidate
Scheduled Jobs
The operations from the Scheduled Jobs category.
- Create a scheduled publish job
- Method: postPath:
/content/management/api/v1.1/publish/scheduledJobs
- List permissions for a scheduled publish job.
- Method: getPath:
/content/management/api/v1.1/publish/scheduledJobs/{id}/permissions
- List scheduled publish jobs
- Method: getPath:
/content/management/api/v1.1/publish/scheduledJobs
- Read a scheduled publish job
- Method: getPath:
/content/management/api/v1.1/publish/scheduledJobs/{id}
- Read a scheduled publish job's validation results
- Method: getPath:
/content/management/api/v1.1/publish/scheduledJobs/{id}/validationResults
- Update a scheduled publish job
- Method: putPath:
/content/management/api/v1.1/publish/scheduledJobs
- Update a scheduled publish job
- Method: putPath:
/content/management/api/v1.1/publish/scheduledJobs/{id}
Taxonomies
Management taxonomies resources provides access to management taxonomies and categories.
- Add a permission to a taxonomy
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/permissions
- Batch taxonomy permission operations
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/permissions/.batch
- Copy a category
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}/copy
- Create a category
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/categories
- Create a category property
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/categoryProperties
- Create a new draft version
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/createDraft
- Create a taxonomy
- Method: postPath:
/content/management/api/v1.1/taxonomies
- Delete a category
- Method: deletePath:
/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}
- Delete a category property
- Method: deletePath:
/content/management/api/v1.1/taxonomies/{id}/categoryProperties/{propertyId}
- Delete a taxonomy
- Method: deletePath:
/content/management/api/v1.1/taxonomies/{id}
- Get batch taxonomy permission operations result.
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/permissions/.batch/{jobId}/results
- List all permissions on a taxonomy
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/permissions
- List all Suggested Items of a Category
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}/suggestedItems
- List taxonomies
- Method: getPath:
/content/management/api/v1.1/taxonomies
- List taxonomy category properties
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/categoryProperties
- Patch a category property definition
- Method: patchPath:
/content/management/api/v1.1/taxonomies/{id}/categoryProperties/{propertyId}
- Patch a permission on a taxonomy
- Method: patchPath:
/content/management/api/v1.1/taxonomies/{id}/permissions/{permissionId}
- Promote a taxonomy
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/promote
- Propagate default values
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/categoryProperties/{propertyId}/propagateDefaultValues
- Publish a taxonomy
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/publish
- Read a category
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}
- Read a category property
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/categoryProperties/{propertyId}
- Read a permission on a taxonomy
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/permissions/{permissionId}
- Read a taxonomy
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}
- Read copy category status
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}/copy/{jobTokenId}
- Read draft creation status
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/createDraft/{jobTokenId}
- Read promote status
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/promote/{jobTokenId}
- Read propagate default values status
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/categoryProperties/{propertyId}/propagateDefaultValues/{jobTokenId}
- Read publish job status
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/publish/{jobTokenId}
- Read unpublish status
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/unpublish/{jobTokenId}
- Remove a permission from a taxonomy
- Method: deletePath:
/content/management/api/v1.1/taxonomies/{id}/permissions/{permissionId}
- Search categories
- Method: getPath:
/content/management/api/v1.1/taxonomies/{id}/categories
- Unpublish a taxonomy
- Method: postPath:
/content/management/api/v1.1/taxonomies/{id}/unpublish
- Update a category
- Method: putPath:
/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}
- Update a taxonomy
- Method: putPath:
/content/management/api/v1.1/taxonomies/{id}
Tokens
The resource to read token.
- Read a CSRF Token
- Method: getPath:
/content/management/api/v1.1/token
Types
The resources to manage types.
- Create a Type
- Method: postPath:
/content/management/api/v1.1/types
- Delete a Type
- Method: deletePath:
/content/management/api/v1.1/types/{name}
- List All Archived fields of a Type
- Method: getPath:
/content/management/api/v1.1/types/{name}/archivedFields
- List All Data Types
- Method: getPath:
/content/management/api/v1.1/dataTypes
- List All Inplace Previews of a Type
- Method: getPath:
/content/management/api/v1.1/types/{name}/inplacePreview
- List All Layout Mappings of a Type
- Method: getPath:
/content/management/api/v1.1/types/{name}/layoutMapping
- List All Permissions on a Type
- Method: getPath:
/content/management/api/v1.1/types/{name}/permissions
- List All relationships for a type
- Method: getPath:
/content/management/api/v1.1/types/{name}/relationships
- List All Types
- Method: getPath:
/content/management/api/v1.1/types
- Read a Type
- Method: getPath:
/content/management/api/v1.1/types/{name}
- Read Type Update Operations Status
- Method: getPath:
/content/management/api/v1.1/types/{name}/updateType/.status/{statusId}
- Update a Type
- Method: putPath:
/content/management/api/v1.1/types/{name}
Workflow Roles
The resources to manage workflow roles.
- Add members to Process role
- Method: postPath:
/content/management/api/v1.1/workflowRoles/{id}/members
- Get details of a given role
- Method: getPath:
/content/management/api/v1.1/workflowRoles/{id}
- Get Members of a Process Role
- Method: getPath:
/content/management/api/v1.1/workflowRoles/{id}/members
- List Roles of all registered Workflows
- Method: getPath:
/content/management/api/v1.1/workflowRoles
- Removes a member from a Process Role
- Method: deletePath:
/content/management/api/v1.1/workflowRoles/{id}/members/{memberID}
Workflow Tasks
The resources to manage workflow tasks.
- List workflow tasks assigned to the current user
- Method: getPath:
/content/management/api/v1.1/workflowTasks
- Read a workflow task
- Method: getPath:
/content/management/api/v1.1/workflowTasks/{taskId}
Workflows
The resources to manage workflows.
- Deregister a Workflow
- Method: deletePath:
/content/management/api/v1.1/workflows/{id}
- List All Permissions on a Workflow
- Method: getPath:
/content/management/api/v1.1/workflows/{id}/permissions
- List All Workflows
- Method: getPath:
/content/management/api/v1.1/workflows
- Read a Workflow
- Method: getPath:
/content/management/api/v1.1/workflows/{id}
- Register a Workflow
- Method: postPath:
/content/management/api/v1.1/workflows
- Update a Workflow
- Method: putPath:
/content/management/api/v1.1/workflows/{id}