Jump to

• Request
• Response
• Examples

Read Items Bulk Operations Publish Item ids

get

/content/management/api/v1.1/bulkItemsOperations/publish/{statusId}/ids

Request

Path Parameters

• statusId: string
  status id of the bulk items publish operation.

Query Parameters

• limit(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the size of the result.

  Default Value: 100
• 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, first, last, prev, next
• offset(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the start index of the result.

  Default Value: 0
• totalResults(optional): boolean
  This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : PublishItemIds

Type: object

Publish Item ids.

Show Source

• aggregationResults(optional): array aggregationResults
  Aggregation results.
• count(optional): integer(int32)
  Total number of records in the current response.
• hasMore(optional): boolean
  Check whether there are more pages to fetch.
• items(optional): array items
  Singular resources contained in the collection.
• limit(optional): integer(int32)
  Actual page size used by the server. This might not be the same as what the client requests.
• links(optional): array links
  Links of the resource.
• offset(optional): integer(int32)
  The actual index from which the singular resources are returned.
• pinned(optional): array pinned
  Pinned items. Shows items pinned at the top of search list
• scrollId(optional): string
  scrollId if the search resolved to a scroll search.
• totalResults(optional): integer(int32)
  Total number of rows that satisfy the client request (excluding the paging parameters.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/PublishedItemId"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Publish Item ids."
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object PublishedItemId
  Publish Item Id

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/PublishedItemId"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : PublishedItemId

Type: object

Publish Item Id

Show Source

• channels(optional): array channels
  channels
• id(optional): string
• links(optional): array links
  Links
• slug(optional): string
• status(optional): string
  status
• type(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "slug":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"status"
        },
        "channels":{
            "type":"array",
            "description":"channels",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Publish Item Id"
}

Nested Schema : channels

Type: array

channels

Show Source

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"channels",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

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

Type: object

ChannelId

Show Source

• id(optional): string
• isPrimaryChannel(optional): boolean
  Indicates if channel is primary for an asset.
• links(optional): array links
  Links
• name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

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 : 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."
}

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 examples show how to get publish item IDs of an item bulk operation by submission of a GET request using cURL.

curl -i -X GET -H 'Accept:application/json' 'https://host:port/content/management/api/v1.1/bulkItemsOperations/publish/{statusId}/ids'

Example 1:

This reads publish item IDs of a successful item bulk operation with the operation ID: OPC12C04D0F3A84DC8974BF66BD7069EA1.

/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids

Response Body

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 2,
        "items": [
          {
            "id": "CORED5710B874C0E459D9C5C87193FD7C36A",
            "type": "Type1",
            "version": "1",
            "slug": "1481786051169-item1",
            "channels": [
              {
                "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CORED5710B874C0E459D9C5C87193FD7C36A?channelToken=ce83127a4a7b7438ec2d9400fafecf0a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          {
            "id": "CONT86B1B61854A747D9BB4901903A98D2DF",
            "type": "DigitalAsset",
            "version": "1",
            "channels": [
              {
                "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CONT86B1B61854A747D9BB4901903A98D2DF?channelToken=ce83127a4a7b7438ec2d9400fafecf0a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
}
  

Example 2:

This reads publish item IDs of a successful item bulk operation with operation ID starting from offset 1: OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1.

/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1

Response Body

{
        "hasMore": false,
        "offset": 1,
        "count": 1,
        "limit": 2,
        "items": [
          {
            "id": "CONT86B1B61854A747D9BB4901903A98D2DF",
            "type": "DigitalAsset",
            "version": "1",
            "channels": [
              {
                "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CONT86B1B61854A747D9BB4901903A98D2DF?channelToken=ce83127a4a7b7438ec2d9400fafecf0a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "prev",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
}
  

Back to Top