1. REST API for Content Management
  2. Tasks
  3. Repositories

Update a Repository

put

/content/management/api/v1.1/repositories/{id}

Updates a repository with the given payload.

Request

Supported Media Types
Path Parameters
Query Parameters
Header Parameters
Body ()
Updates a repository with the given information in the payload. The fields createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.
Root Schema : Repository
Type: object
Repository
Show Source
Nested Schema : channels
Type: array
Channels associated with the repository.
Show Source
Nested Schema : configuredLanguages
Type: array
Configured Languages of the repository.
Show Source
Nested Schema : connectors
Type: array
Connectors associated with the repository.
Show Source
Nested Schema : contentTypes
Type: array
Types associated with the repository.
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : editorialRoles
Type: array
Editorial roles associated with the repository.
Show Source
Nested Schema : languageOptions
Type: array
Language options for the repository.
Show Source
Nested Schema : taxonomies
Type: array
Taxonomies associated with the repository.
Show Source
Nested Schema : TypeWorkflowsBean
Type: object
TypeWorkflowsBean
Show Source
Nested Schema : workflows
Type: array
Workflows associated with the repository.
Show Source
Nested Schema : ChannelBeanInRepository
Type: object
ChannelBeanInRepository
Show Source
Nested Schema : optionalLanguages
Type: array
Optional Languages.
Show Source
Nested Schema : requiredLanguages
Type: array
Required Languages.
Show Source
Nested Schema : Connector
Type: object
Connector
Show Source
Nested Schema : supportedContentTypes
Type: array
Supported content types of the connector.
Show Source
Nested Schema : ContentTypeId
Type: object
Show Source
Nested Schema : EditorialRoleId
Type: object
EditorialRoleId
Show Source
Nested Schema : TaxonomyId
Type: object
TaxonomyId
Show Source
Nested Schema : WorkflowsOnAllAssetTypes
Type: object
Workflows on all asset types.
Show Source
Nested Schema : types
Type: array
Specific asset types.
Show Source
Nested Schema : default
Type: array
Manual start.
Show Source
Nested Schema : startOnCreate
Type: array
Automatic start on create.
Show Source
Nested Schema : WorkflowBean
Type: object
WorkflowBean
Show Source
Nested Schema : WorkflowsOnSpecificAssetTypes
Type: object
Workflows on specific asset types.
Show Source
Nested Schema : default
Type: array
Manual start.
Show Source
Nested Schema : startOnCreate
Type: array
Automatic start on create.
Show Source
Nested Schema : WorkflowId
Type: object
WorkflowId
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : Repository
Type: object
Repository
Show Source
Nested Schema : channels
Type: array
Channels associated with the repository.
Show Source
Nested Schema : configuredLanguages
Type: array
Configured Languages of the repository.
Show Source
Nested Schema : connectors
Type: array
Connectors associated with the repository.
Show Source
Nested Schema : contentTypes
Type: array
Types associated with the repository.
Show Source
Nested Schema : date
Type: object
date
Show Source
Nested Schema : editorialRoles
Type: array
Editorial roles associated with the repository.
Show Source
Nested Schema : languageOptions
Type: array
Language options for the repository.
Show Source
Nested Schema : taxonomies
Type: array
Taxonomies associated with the repository.
Show Source
Nested Schema : TypeWorkflowsBean
Type: object
TypeWorkflowsBean
Show Source
Nested Schema : workflows
Type: array
Workflows associated with the repository.
Show Source
Nested Schema : ChannelBeanInRepository
Type: object
ChannelBeanInRepository
Show Source
Nested Schema : optionalLanguages
Type: array
Optional Languages.
Show Source
Nested Schema : requiredLanguages
Type: array
Required Languages.
Show Source
Nested Schema : Connector
Type: object
Connector
Show Source
Nested Schema : supportedContentTypes
Type: array
Supported content types of the connector.
Show Source
Nested Schema : ContentTypeId
Type: object
Show Source
Nested Schema : EditorialRoleId
Type: object
EditorialRoleId
Show Source
Nested Schema : TaxonomyId
Type: object
TaxonomyId
Show Source
Nested Schema : WorkflowsOnAllAssetTypes
Type: object
Workflows on all asset types.
Show Source
Nested Schema : types
Type: array
Specific asset types.
Show Source
Nested Schema : default
Type: array
Manual start.
Show Source
Nested Schema : startOnCreate
Type: array
Automatic start on create.
Show Source
Nested Schema : WorkflowBean
Type: object
WorkflowBean
Show Source
Nested Schema : WorkflowsOnSpecificAssetTypes
Type: object
Workflows on specific asset types.
Show Source
Nested Schema : default
Type: array
Manual start.
Show Source
Nested Schema : startOnCreate
Type: array
Automatic start on create.
Show Source
Nested Schema : WorkflowId
Type: object
WorkflowId
Show Source

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.
Back to Top

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"
}
Back to Top