Jump to

• Request
• Response
• Examples

Read a Repository

get

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

Read a repository.

Request

Path Parameters

• id: string
  id of the repository.

Query Parameters

• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : Repository

Type: object

Repository

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"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."
        },
        "name":{
            "type":"string",
            "description":"Name of the repository. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the repository."
        },
        "repositoryType":{
            "type":"string",
            "description":"Type of the repository. It can have values Standard, Business. Default value is Standard.",
            "enum":[
                "Standard",
                "Business"
            ]
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the Repository."
        },
        "createdDate":{
            "description":"date and time Repository createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the Repository."
        },
        "updatedDate":{
            "description":"date and time Repository updatedAt.",
            "$ref":"#/definitions/date"
        },
        "autoTagEnabled":{
            "type":"boolean",
            "description":"Whether auto tagging is enabled for the repository."
        },
        "notReadyEnabled":{
            "type":"boolean",
            "description":"Whether not ready assets are enabled for the repository."
        },
        "contentTypes":{
            "type":"array",
            "description":"Types associated with the repository.",
            "items":{
                "$ref":"#/definitions/ContentTypeId"
            }
        },
        "channels":{
            "type":"array",
            "description":"Channels associated with the repository.",
            "items":{
                "$ref":"#/definitions/ChannelBeanInRepository"
            }
        },
        "taxonomies":{
            "type":"array",
            "description":"Taxonomies associated with the repository.",
            "items":{
                "$ref":"#/definitions/TaxonomyId"
            }
        },
        "workflows":{
            "type":"array",
            "description":"Workflows associated with the repository.",
            "items":{
                "$ref":"#/definitions/WorkflowId"
            }
        },
        "typeWorkflows":{
            "description":"Mappings between asset types and workflows within the repository.",
            "$ref":"#/definitions/TypeWorkflowsBean"
        },
        "connectors":{
            "type":"array",
            "description":"Connectors associated with the repository.",
            "items":{
                "$ref":"#/definitions/Connector"
            }
        },
        "editorialRoles":{
            "type":"array",
            "description":"Editorial roles associated with the repository.",
            "items":{
                "$ref":"#/definitions/EditorialRoleId"
            }
        },
        "defaultLanguage":{
            "type":"string",
            "description":"Default language of the repository. It is a required property in the get response and post/put request."
        },
        "languageOptions":{
            "type":"array",
            "description":"Language options for the repository.",
            "items":{
                "type":"string"
            }
        },
        "configuredLanguages":{
            "type":"array",
            "description":"Configured Languages of the repository.",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the repository."
        },
        "advancedVideoEnabled":{
            "type":"boolean",
            "description":"Whether advanced video is enabled for the repository."
        },
        "customDigitalAssetsEnabled":{
            "type":"boolean",
            "description":"Whether custom digital assets is enabled for the repository."
        },
        "viewAllCollectionsEnabled":{
            "type":"boolean",
            "description":"Whether view all collections is enabled for the repository."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Repository"
}

Nested Schema : channels

Type: array

Channels associated with the repository.

Show Source

• Array of: object ChannelBeanInRepository
  ChannelBeanInRepository

{
    "type":"array",
    "description":"Channels associated with the repository.",
    "items":{
        "$ref":"#/definitions/ChannelBeanInRepository"
    }
}

Nested Schema : configuredLanguages

Type: array

Configured Languages of the repository.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Configured Languages of the repository.",
    "items":{
        "type":"string"
    }
}

Nested Schema : connectors

Type: array

Connectors associated with the repository.

Show Source

• Array of: object Connector
  Connector

{
    "type":"array",
    "description":"Connectors associated with the repository.",
    "items":{
        "$ref":"#/definitions/Connector"
    }
}

Nested Schema : contentTypes

Type: array

Types associated with the repository.

Show Source

• Array of: object ContentTypeId

{
    "type":"array",
    "description":"Types associated with the repository.",
    "items":{
        "$ref":"#/definitions/ContentTypeId"
    }
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : editorialRoles

Type: array

Editorial roles associated with the repository.

Show Source

• Array of: object EditorialRoleId
  EditorialRoleId

{
    "type":"array",
    "description":"Editorial roles associated with the repository.",
    "items":{
        "$ref":"#/definitions/EditorialRoleId"
    }
}

Nested Schema : languageOptions

Type: array

Language options for the repository.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Language options for the repository.",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : taxonomies

Type: array

Taxonomies associated with the repository.

Show Source

• Array of: object TaxonomyId
  TaxonomyId

{
    "type":"array",
    "description":"Taxonomies associated with the repository.",
    "items":{
        "$ref":"#/definitions/TaxonomyId"
    }
}

Nested Schema : TypeWorkflowsBean

Type: object

TypeWorkflowsBean

Show Source

• allTypes(optional): object WorkflowsOnAllAssetTypes
  Workflows on all asset types.
• types(optional): array types
  Specific asset types.

{
    "type":"object",
    "properties":{
        "allTypes":{
            "description":"All asset types.",
            "$ref":"#/definitions/WorkflowsOnAllAssetTypes"
        },
        "types":{
            "type":"array",
            "description":"Specific asset types.",
            "items":{
                "$ref":"#/definitions/WorkflowsOnSpecificAssetTypes"
            }
        }
    },
    "description":"TypeWorkflowsBean"
}

Nested Schema : workflows

Type: array

Workflows associated with the repository.

Show Source

• Array of: object WorkflowId
  WorkflowId

{
    "type":"array",
    "description":"Workflows associated with the repository.",
    "items":{
        "$ref":"#/definitions/WorkflowId"
    }
}

Nested Schema : ChannelBeanInRepository

Type: object

ChannelBeanInRepository

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isSiteChannel":{
            "type":"boolean",
            "description":"Checks whether the channel is site channel."
        },
        "isSitePlanChannel":{
            "type":"boolean"
        },
        "localizationPolicy":{
            "type":"string",
            "description":"The localization policy of the channel."
        },
        "defaultLanguage":{
            "type":"string",
            "description":"Default Language."
        },
        "requiredLanguages":{
            "type":"array",
            "description":"Required Languages.",
            "items":{
                "type":"string"
            }
        },
        "optionalLanguages":{
            "type":"array",
            "description":"Optional Languages.",
            "items":{
                "type":"string"
            }
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "primaryChannelSupported":{
            "type":"boolean",
            "description":"Primary channel supported."
        }
    },
    "description":"ChannelBeanInRepository"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : optionalLanguages

Type: array

Optional Languages.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Optional Languages.",
    "items":{
        "type":"string"
    }
}

Nested Schema : requiredLanguages

Type: array

Required Languages.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Required Languages.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Nested Schema : Connector

Type: object

Connector

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"Id of the connector. It is a required property in the get response."
        },
        "connectorName":{
            "type":"string",
            "description":"Name of the connector. It is a required property in the get response."
        },
        "connectorType":{
            "type":"string",
            "description":"Type of the connector. It is a required property in the get response."
        },
        "isDigitalContentConnector":{
            "type":"boolean",
            "description":"True for Digital asset connectors, otherwise false",
            "readOnly":true
        },
        "supportedContentTypes":{
            "type":"array",
            "description":"Supported content types of the connector.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Connector"
}

Nested Schema : supportedContentTypes

Type: array

Supported content types of the connector.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Supported content types of the connector.",
    "items":{
        "type":"string"
    }
}

Nested Schema : ContentTypeId

Type: object

Show Source

• name(optional): string
• typeCategory(optional): string
  typeCategory of the asset type.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "typeCategory":{
            "type":"string",
            "description":"typeCategory of the asset type."
        }
    }
}

Nested Schema : EditorialRoleId

Type: object

EditorialRoleId

Show Source

• 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.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of a custom editorial role."
        },
        "name":{
            "type":"string",
            "description":"Name of a custom editorial role."
        },
        "description":{
            "type":"string",
            "description":"Description of a custom editorial role."
        }
    },
    "description":"EditorialRoleId"
}

Nested Schema : TaxonomyId

Type: object

TaxonomyId

Show Source

• id(optional): string
• name(optional): string
• shortName(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        }
    },
    "description":"TaxonomyId"
}

Nested Schema : WorkflowsOnAllAssetTypes

Type: object

Workflows on all asset types.

Show Source

• default(optional): array default
  Manual start.
• required(optional): boolean
  Required or not.
• startOnCreate(optional): array startOnCreate
  Automatic start on create.

{
    "type":"object",
    "properties":{
        "startOnCreate":{
            "type":"array",
            "description":"Automatic start on create.",
            "items":{
                "$ref":"#/definitions/WorkflowBean"
            }
        },
        "default":{
            "type":"array",
            "description":"Manual start.",
            "items":{
                "$ref":"#/definitions/WorkflowBean"
            }
        },
        "required":{
            "type":"boolean",
            "description":"Required or not."
        }
    },
    "description":"Workflows on all asset types."
}

Nested Schema : types

Type: array

Specific asset types.

Show Source

• Array of: object WorkflowsOnSpecificAssetTypes
  Workflows on specific asset types.

{
    "type":"array",
    "description":"Specific asset types.",
    "items":{
        "$ref":"#/definitions/WorkflowsOnSpecificAssetTypes"
    }
}

Nested Schema : default

Type: array

Manual start.

Show Source

• Array of: object WorkflowBean
  WorkflowBean

{
    "type":"array",
    "description":"Manual start.",
    "items":{
        "$ref":"#/definitions/WorkflowBean"
    }
}

Nested Schema : startOnCreate

Type: array

Automatic start on create.

Show Source

• Array of: object WorkflowBean
  WorkflowBean

{
    "type":"array",
    "description":"Automatic start on create.",
    "items":{
        "$ref":"#/definitions/WorkflowBean"
    }
}

Nested Schema : WorkflowBean

Type: object

WorkflowBean

Show Source

• id(optional): string
  id of the Workflow.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        }
    },
    "description":"WorkflowBean"
}

Nested Schema : WorkflowsOnSpecificAssetTypes

Type: object

Workflows on specific asset types.

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the asset type."
        },
        "name":{
            "type":"string",
            "description":"Name of the asset type."
        },
        "startOnCreate":{
            "type":"array",
            "description":"Automatic start on create.",
            "items":{
                "$ref":"#/definitions/WorkflowBean"
            }
        },
        "default":{
            "type":"array",
            "description":"Manual start.",
            "items":{
                "$ref":"#/definitions/WorkflowBean"
            }
        },
        "required":{
            "type":"boolean",
            "description":"Required or not."
        }
    },
    "description":"Workflows on specific asset types."
}

Nested Schema : default

Type: array

Manual start.

Show Source

• Array of: object WorkflowBean
  WorkflowBean

{
    "type":"array",
    "description":"Manual start.",
    "items":{
        "$ref":"#/definitions/WorkflowBean"
    }
}

Nested Schema : startOnCreate

Type: array

Automatic start on create.

Show Source

• Array of: object WorkflowBean
  WorkflowBean

{
    "type":"array",
    "description":"Automatic start on create.",
    "items":{
        "$ref":"#/definitions/WorkflowBean"
    }
}

Nested Schema : WorkflowId

Type: object

WorkflowId

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        },
        "name":{
            "type":"string",
            "description":"Name of the Workflow.This is a read only field."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"If workflow is enabled or disabled in OCE.This is a read only field."
        }
    },
    "description":"WorkflowId"
}

304 Response

Not modified.

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 get the details of a repository based on repository ID by submitting a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/repositories/{id}'

Example:

/content/management/api/v1.1/repositories/F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95

Read repository with id: F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95.

Response Body

{
        "id": "F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95",
        "name": "Repo012",
        "description": "desc of Repo012",
        "repositoryType": "Standard",
        "createdBy": "cecusername",
        "createdDate": {
          "value": "2018-11-30T10:39:21.702Z",
          "timezone": "UTC"
        },
        "updatedBy": "cecusername",
        "updatedDate": {
          "value": "2018-11-30T10:39:21.702Z",
          "timezone": "UTC"
        },
        "autoTagEnabled": true,
        "notReadyEnabled": false,
        "contentTypes": [
          {
            "name": "Type1",
            "typeCategory": "ContentType"
          },
          {
            "name": "Type2",
            "typeCategory": "ContentType"
          },
          {
            "name": "Video",
            "typeCategory": "DigitalAssetType"
          },
          {
            "name": "Image",
            "typeCategory": "DigitalAssetType"
          }
        ],
        "channels": [
           {
            "id": "RCHANNELBAD7E5AEDF384006A664BD4DAD9E255F",
            "name": "MaxChannel",
            "isSiteChannel": false,
            "localizationPolicy": "9DC56AA295E86ED0E053F518C40AE7E3",
            "defaultLanguage": "en",
            "requiredLanguages": [
                "en",
                "fr"
            ],
            "optionalLanguages": []
          },
          {
            "id": "CHANNELF7A5C5C38DC4F4408137909520792A4E05729855AD33",
            "name": "BaySideCafe",
            "isSiteChannel": true,
            "localizationPolicy": "9DC56AA295E86ED0E053F518C40AE7E3",
            "defaultLanguage": "en",
            "requiredLanguages": [
                "en",
                "fr"
            ],
            "optionalLanguages": []
          }
        ],
        "workflows": [
          {
            "id": "D7D268693C094189A6377E805482C991",
            "name": "Workflow1",
            "isEnabled": true
          },
          {
            "id": "E8D268693C094189A6377E805482C954",
            "name": "Workflow2",
            "isEnabled": true
          }
        ],
        "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": "D7D268693C094189A6377E805482C991"
                }
              ],
              "default": [
                {
                  "id": "E8D268693C094189A6377E805482C954"
                }
              ],
              "required": false
            }
          ]
        },
        "connectors": [
          {
            "connectorId": "10000",
            "connectorName": "Google Drive",
            "connectorType": "content",
            "supportedContentTypes": []
         },
         {
            "connectorId": "20000",
            "connectorName": "LingoTek",
            "connectorType": "translation",
            "supportedContentTypes": []
         },
         {
            "connectorId": "10002",
            "connectorName": "Dropbox",
            "connectorType": "content",
            "supportedContentTypes": []
         }
        ],
        "editorialRoles": [
	        {
	            "id": "2C8E850048FB4DB4AAE317FA74751454",
	            "name": "Custom Editorial Role2"
	        },
	        {
	            "id": "7EFD29110FE041ADAC888CCFAEE2923B",
	            "name": "Custom Editorial Role3"
	        }
        ],
        "defaultLanguage": "en-US",
        "languageOptions": [
          "ar",
          "en-IN"
        ],
        "configuredLanguages": [
          "ar",
          "en-IN",
          "en-US"
        ],
        "roleName": "manager",
        "advancedVideoEnabled": false,
        "customDigitalAssetsEnabled": true,
        "viewAllCollectionsEnabled": true,
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/repositories/F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/repositories/F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/F999DF05B45E1F1715C71EBF2689A54ECEBE3AAC7D95",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Back to Top