Update a Repository
/content/management/api/v1.1/repositories/{id}
Request
- application/json
-
id: string
id of the repository.
-
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
200 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 update a repository by submitting a PUT request on the REST resource using cURL.
curl -X PUT -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/repositories/{id}'
Example 1:
This updates repository for id: FF85449BBD06D17C2E7629CF1A280A31BE3E42C40741. Replace payload with your own data.
/content/management/api/v1.1/repositories/FF85449BBD06D17C2E7629CF1A280A31BE3E42C40741
Request Payload
{ "id": "FF85449BBD06D17C2E7629CF1A280A31BE3E42C40741", "name": "Repo1_updated", "description": "Repo1 updated description", "contentTypes": [ { "name": "Type1", "typeCategory": "ContentType" } ], "channels": [], "defaultLanguage": "en-US" }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 2:
This updates repository for id: F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95. Replace payload with your own data.
/content/management/api/v1.1/repositories/F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95
Request Payload
{ "id": "F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95", "name": "Repo2_updated", "description": "Repo2 description", "contentTypes": [ { "name": "Type2" } ], "channels": [ { "id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2" } ], "defaultLanguage": "fr-FR" }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Example 3:
This updates repository for id: F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95 by associating workflows. Replace payload with your own data.
/content/management/api/v1.1/repositories/F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95
Request Body
{ "id": "F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95", "name": "Repo2_updated", "description": "Repo2 description", "contentTypes": [ { "name": "Type2" } ], "defaultLanguage": "fr-FR", "workflows": [ { "id": "D7D268693C094189A6377E805482C991" } ] }
Example 4:
This updates repository for id: F4F3408C43BEC120D8EA7E8E3EE43130BB99C4823974 by adding connectors. Replace payload with your own data.
/content/management/api/v1.1/repositories/F4F3408C43BEC120D8EA7E8E3EE43130BB99C4823974
Request Body
{ "id": "F4F3408C43BEC120D8EA7E8E3EE43130BB99C4823974", "name": "Repo3_updated", "description": "Repo3 description", "contentTypes": [ ], "channels": [ ], "defaultLanguage": "fr-FR", "connectors": [ { "connectorId": "10000" }, { "connectorId": "10002" } ] }
Example 5:
This updates repository for id: B4F942C0C3FA4C889D0F531BA2C1648D by adding advanced video support. Replace payload with your own data.
/content/management/api/v1.1/repositories/B4F942C0C3FA4C889D0F531BA2C1648D
Request Body
{ "name": "Video Plus repository", "description": "updated repository supports new advanced video.", "defaultLanguage": "en-US", "contentTypes": [ { "name": "Video-Plus" } ] }
Example 6:
Updating Business repository for id: B4F942C0C3FA4C889D0F531BA2C1648D by adding some asset types.
/content/management/api/v1.1/repositories/B4F942C0C3FA4C889D0F531BA2C1648D
Request Body
{ "name": "Businessrepository", "description": "updated repository.", "defaultLanguage": "en-US", "repositoryType": "Business", "contentTypes": [ { "name": "Image" }, { "name": "ContentType1" } ] }
Example 7:
Updating Business repository for id: B4F942C0C3FA4C889D0F531BA2C1648D by adding advanced video support would fail.
/content/management/api/v1.1/repositories/B4F942C0C3FA4C889D0F531BA2C1648D
Request Body
{ "name": "Video Plus repository", "description": "updated repository supports new advanced video.", "defaultLanguage": "en-US", "repositoryType": "Business", "contentTypes": [ { "name": "Video-Plus" } ] }
Example 8:
Updating Business repository for id: B4F942C0C3FA4C889D0F531BA2C1648D by adding channels would fail.
/content/management/api/v1.1/repositories/B4F942C0C3FA4C889D0F531BA2C1648D
Request Body
{ "name": "Businessrepository", "description": "updating Business repo with channels", "defaultLanguage": "en-US", "repositoryType": "Business", "channels": [ { "id": "CCA47722BC777B16DC5FB1452A24C5FB6D9A33EF76A2" } ] }
Example 9:
Updating Standard repository for id: B4F942C0C3FA4C889D0F531BA2C1648D by making repositoryType as Business would fail.
/content/management/api/v1.1/repositories/B4F942C0C3FA4C889D0F531BA2C1648D
Request Body
{ "name": "Standardrepository", "description": "updated repository supports", "defaultLanguage": "en-US", "repositoryType": "Business" }
Example 10:
This updates asset type and workflow mappings for repository with id: F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95. Replace payload with your own data.
/content/management/api/v1.1/repositories/F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95
Request Body
{ "id": "F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95", "name": "Repo2_updated", "description": "Repo2 description", "defaultLanguage": "fr-FR", "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": true } ] } }
Example 11:
This updates repository with id E1F4F961C7224422B0998434E4F4572E by changing its associated types and custom editorial roles. Replace payload with your own data.
/content/management/api/v1.1/repositories/E1F4F961C7224422B0998434E4F4572E
Request Payload
{ "id": "E1F4F961C7224422B0998434E4F4572E", "name": "repository7", "description": "repository7 description.", "repositoryType": "Standard", "contentTypes": [ { "name": "Type1" }, { "name": "Image" } ], "editorialRoles": [ { "id": "2C8E850048FB4DB4AAE317FA74751454", "name": "Custom Editorial Role2" }, { "id": "94950193E96940D7980FA8BA47E73491", "name": "Custom Editorial Role3" } ], "defaultLanguage": "en-US" }
Example 12:
This updates repository for id: 8A3D058063E64779BC611CF2650B0720 to enable auto tagging (aka smart content) and view all collections.
/content/management/api/v1.1/repositories/8A3D058063E64779BC611CF2650B0720
Request Payload
{ "id": "8A3D058063E64779BC611CF2650B0720", "name": "Repository1", "description": "repository1 description", "repositoryType": "Standard", "defaultLanguage": "en-US", "autoTagEnabled": true, "viewAllCollectionsEnabled": true }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }