Create a Repository
/content/management/api/v1.1/repositories
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
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
object
-
advancedVideoEnabled(optional):
boolean
Whether advanced video is enabled for the repository.
-
autoTagEnabled(optional):
boolean
Whether auto tagging is enabled for the repository.
-
channels(optional):
array channels
Channels associated with the repository.
-
configuredLanguages(optional):
array configuredLanguages
Configured Languages of the repository.
-
connectors(optional):
array connectors
Connectors associated with the repository.
-
contentTypes(optional):
array contentTypes
Types associated with the repository.
-
createdBy(optional):
string
createdBy user of the Repository.
-
createdDate(optional):
object date
date
-
customDigitalAssetsEnabled(optional):
boolean
Whether custom digital assets is enabled for the repository.
-
defaultLanguage(optional):
string
Default language of the repository. It is a required property in the get response and post/put request.
-
description(optional):
string
Description of the repository.
-
editorialRoles(optional):
array editorialRoles
Editorial roles associated with the repository.
-
id(optional):
string
id of the repository. It is a required property in the get response and put request whereas it is not required in the post request.
-
languageOptions(optional):
array languageOptions
Language options for the repository.
-
links(optional):
array links
Links
-
name(optional):
string
Name of the repository. It is a required property in the get response and post/put request.
-
notReadyEnabled(optional):
boolean
Whether not ready assets are enabled for the repository.
-
repositoryType(optional):
string
Allowed Values:
[ "Standard", "Business" ]
Type of the repository. It can have values Standard, Business. Default value is Standard. -
roleName(optional):
string
Name of the user's role on the repository.
-
taxonomies(optional):
array taxonomies
Taxonomies associated with the repository.
-
typeWorkflows(optional):
object TypeWorkflowsBean
TypeWorkflowsBean
-
updatedBy(optional):
string
updatedBy user of the Repository.
-
updatedDate(optional):
object date
date
-
viewAllCollectionsEnabled(optional):
boolean
Whether view all collections is enabled for the repository.
-
workflows(optional):
array workflows
Workflows associated with the repository.
array
-
Array of:
object ChannelBeanInRepository
ChannelBeanInRepository
array
-
Array of:
object Connector
Connector
array
-
Array of:
object EditorialRoleId
EditorialRoleId
array
-
Array of:
object TaxonomyId
TaxonomyId
object
-
allTypes(optional):
object WorkflowsOnAllAssetTypes
Workflows on all asset types.
-
types(optional):
array types
Specific asset types.
array
-
Array of:
object WorkflowId
WorkflowId
object
-
defaultLanguage(optional):
string
Default Language.
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
isSiteChannel(optional):
boolean
Checks whether the channel is site channel.
-
isSitePlanChannel(optional):
boolean
-
links(optional):
array links
Links
-
localizationPolicy(optional):
string
The localization policy of the channel.
-
name(optional):
string
-
optionalLanguages(optional):
array optionalLanguages
Optional Languages.
-
primaryChannelSupported(optional):
boolean
Primary channel supported.
-
requiredLanguages(optional):
array requiredLanguages
Required Languages.
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
-
connectorId(optional):
string
Id of the connector. It is a required property in the get response.
-
connectorName(optional):
string
Name of the connector. It is a required property in the get response.
-
connectorType(optional):
string
Type of the connector. It is a required property in the get response.
-
isDigitalContentConnector(optional):
boolean
Read Only:
true
True for Digital asset connectors, otherwise false -
supportedContentTypes(optional):
array supportedContentTypes
Supported content types of the connector.
array
object
-
name(optional):
string
-
typeCategory(optional):
string
typeCategory of the asset type.
object
-
description(optional):
string
Description of a custom editorial role.
-
id:
string
ID of a custom editorial role.
-
name(optional):
string
Name of a custom editorial role.
object
-
default(optional):
array default
Manual start.
-
required(optional):
boolean
Required or not.
-
startOnCreate(optional):
array startOnCreate
Automatic start on create.
array
-
Array of:
object WorkflowsOnSpecificAssetTypes
Workflows on specific asset types.
array
-
Array of:
object WorkflowBean
WorkflowBean
array
-
Array of:
object WorkflowBean
WorkflowBean
object
-
id(optional):
string
id of the Workflow.
object
-
default(optional):
array default
Manual start.
-
id(optional):
string
Id of the asset type.
-
name(optional):
string
Name of the asset type.
-
required(optional):
boolean
Required or not.
-
startOnCreate(optional):
array startOnCreate
Automatic start on create.
array
-
Array of:
object WorkflowBean
WorkflowBean
array
-
Array of:
object WorkflowBean
WorkflowBean
object
-
id(optional):
string
id of the Workflow.
-
isEnabled(optional):
boolean
If workflow is enabled or disabled in OCE.This is a read only field.
-
name(optional):
string
Name of the Workflow.This is a read only field.
Response
- application/json
201 Response
object
-
advancedVideoEnabled(optional):
boolean
Whether advanced video is enabled for the repository.
-
autoTagEnabled(optional):
boolean
Whether auto tagging is enabled for the repository.
-
channels(optional):
array channels
Channels associated with the repository.
-
configuredLanguages(optional):
array configuredLanguages
Configured Languages of the repository.
-
connectors(optional):
array connectors
Connectors associated with the repository.
-
contentTypes(optional):
array contentTypes
Types associated with the repository.
-
createdBy(optional):
string
createdBy user of the Repository.
-
createdDate(optional):
object date
date
-
customDigitalAssetsEnabled(optional):
boolean
Whether custom digital assets is enabled for the repository.
-
defaultLanguage(optional):
string
Default language of the repository. It is a required property in the get response and post/put request.
-
description(optional):
string
Description of the repository.
-
editorialRoles(optional):
array editorialRoles
Editorial roles associated with the repository.
-
id(optional):
string
id of the repository. It is a required property in the get response and put request whereas it is not required in the post request.
-
languageOptions(optional):
array languageOptions
Language options for the repository.
-
links(optional):
array links
Links
-
name(optional):
string
Name of the repository. It is a required property in the get response and post/put request.
-
notReadyEnabled(optional):
boolean
Whether not ready assets are enabled for the repository.
-
repositoryType(optional):
string
Allowed Values:
[ "Standard", "Business" ]
Type of the repository. It can have values Standard, Business. Default value is Standard. -
roleName(optional):
string
Name of the user's role on the repository.
-
taxonomies(optional):
array taxonomies
Taxonomies associated with the repository.
-
typeWorkflows(optional):
object TypeWorkflowsBean
TypeWorkflowsBean
-
updatedBy(optional):
string
updatedBy user of the Repository.
-
updatedDate(optional):
object date
date
-
viewAllCollectionsEnabled(optional):
boolean
Whether view all collections is enabled for the repository.
-
workflows(optional):
array workflows
Workflows associated with the repository.
array
-
Array of:
object ChannelBeanInRepository
ChannelBeanInRepository
array
-
Array of:
object Connector
Connector
array
-
Array of:
object EditorialRoleId
EditorialRoleId
array
-
Array of:
object TaxonomyId
TaxonomyId
object
-
allTypes(optional):
object WorkflowsOnAllAssetTypes
Workflows on all asset types.
-
types(optional):
array types
Specific asset types.
array
-
Array of:
object WorkflowId
WorkflowId
object
-
defaultLanguage(optional):
string
Default Language.
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
isSiteChannel(optional):
boolean
Checks whether the channel is site channel.
-
isSitePlanChannel(optional):
boolean
-
links(optional):
array links
Links
-
localizationPolicy(optional):
string
The localization policy of the channel.
-
name(optional):
string
-
optionalLanguages(optional):
array optionalLanguages
Optional Languages.
-
primaryChannelSupported(optional):
boolean
Primary channel supported.
-
requiredLanguages(optional):
array requiredLanguages
Required Languages.
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
-
connectorId(optional):
string
Id of the connector. It is a required property in the get response.
-
connectorName(optional):
string
Name of the connector. It is a required property in the get response.
-
connectorType(optional):
string
Type of the connector. It is a required property in the get response.
-
isDigitalContentConnector(optional):
boolean
Read Only:
true
True for Digital asset connectors, otherwise false -
supportedContentTypes(optional):
array supportedContentTypes
Supported content types of the connector.
array
object
-
name(optional):
string
-
typeCategory(optional):
string
typeCategory of the asset type.
object
-
description(optional):
string
Description of a custom editorial role.
-
id:
string
ID of a custom editorial role.
-
name(optional):
string
Name of a custom editorial role.
object
-
default(optional):
array default
Manual start.
-
required(optional):
boolean
Required or not.
-
startOnCreate(optional):
array startOnCreate
Automatic start on create.
array
-
Array of:
object WorkflowsOnSpecificAssetTypes
Workflows on specific asset types.
array
-
Array of:
object WorkflowBean
WorkflowBean
array
-
Array of:
object WorkflowBean
WorkflowBean
object
-
id(optional):
string
id of the Workflow.
object
-
default(optional):
array default
Manual start.
-
id(optional):
string
Id of the asset type.
-
name(optional):
string
Name of the asset type.
-
required(optional):
boolean
Required or not.
-
startOnCreate(optional):
array startOnCreate
Automatic start on create.
array
-
Array of:
object WorkflowBean
WorkflowBean
array
-
Array of:
object WorkflowBean
WorkflowBean
object
-
id(optional):
string
id of the Workflow.
-
isEnabled(optional):
boolean
If workflow is enabled or disabled in OCE.This is a read only field.
-
name(optional):
string
Name of the Workflow.This is a read only field.
400 Response
403 Response
404 Response
500 Response
Examples
The following example shows how to create a repository by submitting a POST request on the REST resource using cURL.
curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/repositories'
Example 1:
This creates a simple repository with name, description and default language, where en-IN is language code. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository1", "description": "repository1 description.", "defaultLanguage": "en-IN" }
Example 2:
This creates a simple Business repository with name, description, default language and list of optional languages associated with it, where en-US, en and de are language codes. Replace payload with your own data..
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository1", "description": "repository1 description.", "repositoryType": "Business", "defaultLanguage": "en-US", "languageOptions": [ "en", "de" ] }
Example 3:
This creates a Standard repository with default language and list of optional languages associated with it, where en-US, en and de are language codes. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository2", "description": "repository2 description.", "defaultLanguage": "en-US", "repositoryType": "Standard", "languageOptions": [ "en", "de" ] }
Example 4:
This creates a repository with default language and a list of types associated with it. Where en-US is language code and Type1, Type2 are names of already existing types. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository3", "description": "repository3 description.", "contentTypes": [ { "name": "Type1" }, { "name": "Type2" } ], "defaultLanguage": "en-US" }
Example 5:
This creates a repository with default language and list of channels associated with it. Where en-US is language code and CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6, CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2 are id's of existing channels. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository4", "description": "repository4 description.", "channels": [ { "id": "CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6" }, { "id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2" } ], "defaultLanguage": "en-US" }
Example 6:
This creates a Business repository with list of types associated with it. Where Type1, Type2 are names of existing types. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository5", "description": "repository5 description.", "contentTypes": [ { "name": "Type1", "typeCategory": "ContentType" }, { "name": "Type2", "typeCategory": "ContentType" }, { "name": "myImage", "typeCategory": "DigitalAssetType" }, { "name": "Image", "typeCategory": "DigitalAssetType" } ], "defaultLanguage": "en-US", "repositoryType": "Business" }
Example 7:
This creates a repository with defaultlanguage, list of optional languages, list of types and list of channels associated with it. Where en-US, en, de are language codes, CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6, CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2 are id's of already existing channels and Type1, Type2 are names of existing types. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository5", "description": "repository5 description.", "contentTypes": [ { "name": "Type1", "typeCategory": "ContentType" }, { "name": "Type2", "typeCategory": "ContentType" }, { "name": "myImage", "typeCategory": "DigitalAssetType" }, { "name": "Image", "typeCategory": "DigitalAssetType" } ], "channels": [ { "id": "CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6" }, { "id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2" } ], "defaultLanguage": "en-US", "languageOptions": [ "en", "de" ] }
Example 8:
This creates a repository with list of types, list of workflows associated. Where Type1, Type2 are names of existing types and D7D268693C094189A6377E805482C991, B8D268693C094189A6377E805482C673 are existing workflow id's. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository5", "description": "repository5 description.", "contentTypes": [ { "name": "Type1" }, { "name": "Type2" } ], "workflows": [ { "id": "D7D268693C094189A6377E805482C991" }, { "id": "E8D268693C094189A6377E805482C954" } ] }
Example 9:
This creates a repository with list of types, list of workflows and associates workflows to the asset types. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository5", "description": "repository5 description.", "contentTypes": [ { "name": "Type1" }, { "name": "Type2" } ], "workflows": [ { "id": "D7D268693C094189A6377E805482C991" }, { "id": "E8D268693C094189A6377E805482C954" }, { "id": "D217A8693C094189A6377E8056ER2346" } ], "typeWorkflows": { "allTypes": { "startOnCreate": [ { "id": "D7D268693C094189A6377E805482C991" } ], "default": [ { "id": "E8D268693C094189A6377E805482C954" } ], "required": false }, "types": [ { "id": "9B8395177F204AF79A6E2A0DD37CF616", "name": "type1", "startOnCreate": [ { "id": "E8D268693C094189A6377E805482C954" } ], "default": [ { "id": "D7D268693C094189A6377E805482C991" } ], "required": true }, { "id": "D7E395177F204AF79A6E2A0DD3723F5E", "name": "type2", "startOnCreate": [ { "id": "D217A8693C094189A6377E8056ER2346" } ], "default": [ { "id": "E8D268693C094189A6377E805482C954" } ], "required": false } ] } }
Example 10:
This creates a repository with default language and a list of connectors associated with it. where 1000 and 1002 are id's of already enabled connectors. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository6", "description": "repository6 description.", "contentTypes": [ ], "channels": [ ], "defaultLanguage": "en-US", "connectors": [ { "connectorId": "10000" }, { "connectorId": "10002" } ] }
Example 11:
This creates a simple repository with name, description, default language and supporting advanced video as Video-Plus is assigned in types, where en-US is language code. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "Video repository", "description": "repository supports advanced video.", "defaultLanguage": "en-US", "contentTypes": [ { "name": "Video-Plus" } ] }
Example 12:
Creating a Business repository with name, description, default language and Video-Plus assigned in types will fail since Advanced videos not supported in Business repository.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "Video repository", "description": "Business repository supporting advanced video.", "defaultLanguage": "en-US", "contentTypes": [ { "name": "Video-Plus" } ] }
Example 13:
Creating a Business repository with list of channels associated with it will fail since channels are not supported in Business repository.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository2", "description": "repository2 description.", "defaultLanguage": "en-US", "repositoryType": "Business", "channels": [ { "id": "CC1E1B4619A093A53A5378F8777746FB9E2ACCDF37A6" }, { "id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2" } ] }
Example 14:
This creates a repository with list of types and list of custom editorial roles associated. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository7", "description": "repository7 description.", "repositoryType": "Standard", "contentTypes": [ { "name": "Type1" }, { "name": "Type2" } ], "editorialRoles": [ { "id": "2C8E850048FB4DB4AAE317FA74751454" }, { "id": "7EFD29110FE041ADAC888CCFAEE2923B" } ], "defaultLanguage": "en-US" }
Example 15:
This creates a standard repository with name, description and default language settings, auto tagging (aka smart content) is enabled, and view all collections is disabled. Replace payload with your own data.
/content/management/api/v1.1/repositories
Request Payload
{ "name": "repository1", "description": "repository1 description.", "repositoryType": "Standard", "defaultLanguage": "en-US", "autoTagEnabled": true, "viewAllCollectionsEnabled": false }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Response Code
201