REST API for Content Management

Read a Collection

get

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

Read a collection.

Request

Path Parameters

collectionId: string

id of the collection.
id: string

Repository id parameter for collections.

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

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : Collection

Type: object

Collection

Show Source

channels(optional): array channels

Channels associated with the collection.
createdBy(optional): string

createdBy user of the Collection.
createdDate(optional): object date

date
description(optional): string

Description of the collection.
id(optional): string

id of the collection. It is a required property in the get response and put request whereas it is not required in the post request.
isDynamic(optional): boolean

true
links(optional): array links

Links
name(optional): string

Name of the collection. It is a required property in the get response and post/put request.
repository(optional): object RepositoryIdentifier

RepositoryIdentifier
roleName(optional): string

Name of the user's role on the collection.
ruleGroups(optional): array ruleGroups
updatedBy(optional): string

updatedBy user of the Collection.
updatedDate(optional): object date

date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the collection. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "repository":{
            "description":"Information of the collection repository.",
            "$ref":"#/definitions/RepositoryIdentifier"
        },
        "name":{
            "type":"string",
            "description":"Name of the collection. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"Description of the collection."
        },
        "isDynamic":{
            "type":"boolean",
            "description":"true"
        },
        "ruleGroups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RuleGroup"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the Collection."
        },
        "createdDate":{
            "description":"date and time Collection createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the Collection."
        },
        "updatedDate":{
            "description":"date and time Collection updatedAt.",
            "$ref":"#/definitions/date"
        },
        "channels":{
            "type":"array",
            "description":"Channels associated with the collection.",
            "items":{
                "$ref":"#/definitions/ChannelInCollections"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the collection."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Collection"
}

Nested Schema : channels

Type: array

Channels associated with the collection.

Show Source

Array of: object ChannelInCollections

ChannelInCollections

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

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 : links

Type: array

Links

Show Source

Array of: object Link

Link of the resource.

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

Nested Schema : RepositoryIdentifier

Type: object

RepositoryIdentifier

Show Source

id(optional): string

id of the collection repository. It is a required property in the get response.
name(optional): string

Name of the collection repository. It is a required property in the get response.
role(optional): string

Role on the collection repository.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the collection repository. It is a required property in the get response."
        },
        "name":{
            "type":"string",
            "description":"Name of the collection repository. It is a required property in the get response."
        },
        "role":{
            "type":"string",
            "description":"Role on the collection repository."
        }
    },
    "description":"RepositoryIdentifier"
}

Nested Schema : ruleGroups

Type: array

Show Source

Array of: object RuleGroup

rule group definition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RuleGroup"
    }
}

Nested Schema : ChannelInCollections

Type: object

ChannelInCollections

Show Source

id(optional): string

id of the channel.
name(optional): string

Name of the channel.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel."
        }
    },
    "description":"ChannelInCollections"
}

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 : RuleGroup

Type: object

rule group definition

Show Source

assetType(optional): string

asset type associated with the rule group, all rules within the rule group are based on properties related to this asset type

Example: File
conjunction(optional): string

the operator to be used while joining this rule group with a previous group

Example: OR
ruleSet(optional): array ruleSet

set of rules associated with the rule group

{
    "type":"object",
    "properties":{
        "conjunction":{
            "type":"string",
            "example":"OR",
            "description":"the operator to be used while joining this rule group with a previous group"
        },
        "assetType":{
            "type":"string",
            "example":"File",
            "description":"asset type associated with the rule group, all rules within the rule group are based on properties related to this asset type"
        },
        "ruleSet":{
            "type":"array",
            "description":"set of rules associated with the rule group",
            "items":{
                "$ref":"#/definitions/RuleSet"
            }
        }
    },
    "description":"rule group definition"
}

Nested Schema : ruleSet

Type: array

set of rules associated with the rule group

Show Source

Array of: object RuleSet

Set of rules or conditions

{
    "type":"array",
    "description":"set of rules associated with the rule group",
    "items":{
        "$ref":"#/definitions/RuleSet"
    }
}

Nested Schema : RuleSet

Type: object

Set of rules or conditions

Show Source

conjunction(optional): string

The operator to be used when combining this rule set with an existing rule set

Example: and
rule(optional): object Rule
ruleSet(optional): array ruleSet

The child or sub rule set associated with the given rule set

{
    "type":"object",
    "properties":{
        "conjunction":{
            "type":"string",
            "example":"and",
            "description":"The operator to be used when combining this rule set with an existing rule set"
        },
        "rule":{
            "description":"The rule definition within the rule set",
            "$ref":"#/definitions/Rule"
        },
        "ruleSet":{
            "type":"array",
            "description":"The child or sub rule set associated with the given rule set",
            "items":{
                "$ref":"#/definitions/RuleSet"
            }
        }
    },
    "description":"Set of rules or conditions"
}

Nested Schema : Rule

Type: object

Show Source

fieldId(optional): string
fieldName(optional): string
fieldValue(optional): string
operator(optional): string

{
    "type":"object",
    "properties":{
        "fieldId":{
            "type":"string"
        },
        "fieldName":{
            "type":"string"
        },
        "operator":{
            "type":"string"
        },
        "fieldValue":{
            "type":"string"
        }
    }
}

Nested Schema : ruleSet

Type: array

The child or sub rule set associated with the given rule set

Show Source

Array of: object RuleSet

Set of rules or conditions

{
    "type":"array",
    "description":"The child or sub rule set associated with the given rule set",
    "items":{
        "$ref":"#/definitions/RuleSet"
    }
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Examples

The following example shows how to get a collection details with its 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}/collections/{collectionId}'

Example:

This reads a collection with id: O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407, exists in a repository with id: F264EF72737B35991E381047D5B43D87656640771B3C.

/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407

Response Body

{
    "id": "O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407",
    "repository": {
    "id": "F264EF72737B35991E381047D5B43D87656640771B3C",
    "name": "Repo12395550356833265"
    },
    "name": "Collection2",
    "description": "",
    "createdBy": "marketing.user",
    "createdDate": {
    "value": "2018-12-10T07:01:57.062Z",
    "timezone": "UTC"
    },
    "updatedBy": "marketing.user",
    "updatedDate": {
    "value": "2018-12-10T07:54:02.198Z",
    "timezone": "UTC"
    },
    "channels": [
    {
      "id": "CC03EC1531E0E39F6D6BA75CEE430DDBEA79EDD5F5B0",
      "name": "channel2"
    },
    {
      "id": "CCB59F44D5015819EBC0F86A2B3133B22638AF433F1E",
      "name": "channel1"
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/metadata-catalog/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/O9F1CD681C619D182B27A9FA3154E81BEEA1E8587407",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
    ]
    }