Jump to

• Request
• Response
• Examples

Read a category

get

/content/management/api/v1.1/taxonomies/{id}/categories/{categoryId}

Read a specific category by taxonomy id, category id and status. The status should be provided in the query parameter.

Request

Path Parameters

• categoryId: string
  Unique identifier (id) for a category.
• id: string
  id of the taxonomy.

Query Parameters

• default(optional): string
  Default search query expression.
• expand(optional): string
  Expand parameter provides the option of getting child resources (referenced items) inline with the category's response. Accepts a comma-separated list of field names or all. Field names are case-sensitive. When expand is specified as all (with all in lower case), all the fields of the requested category are expanded. When expand is not specified, the category response contains links to the referenced children. Expansion of this form is supported for one level only. When the expand parameter contains a nonexistent field as per category definition, the resource produces HTTP 400.
  
  Example : expand=children
  Returns children categories sorted by their respective position ascending. This sort order cannot be changed in this request.
  Example : expand=all
  Returns child resources (children) available for this category. Only the first 1000 children categories will be expanded.
• fields(optional): string
  This parameter is used to control the returned fields for a category. This parameter accepts a comma-separated list of field names or all. These fields will be returned for each category in the list. As all the field names are case-sensitive, users must provide the correct field names in the query. Each category has both standard fields (id, name, description, position, parentId) and additional fields (namePath, idPath, isSiteCategory, synonyms, keywords, relatedCategories, customProperties, roleName). When fields is specified as all (case-insensitive), all the standard and additional fields are returned. The standard fields are always returned in the response and cannot be filtered out. Users can only filter out the additional fields. This parameter is optional in the query and by default results shows only standard fields in the response. Any incorrect or invalid field name given in the query will result in an error.
  
  Example: ?fields=namePath
  This returns all standard fields along with the namedPath additional field for the category.
  Example: ?fields=all
  This will return all standard fields and all additional fields for the category.
  
• 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
• q(optional): string
  This parameter accepts a query expression condition that matches the field values. Many query conditions can be joined using AND/OR operators and grouped with parentheses. The value of the query condition follows the format of {fieldName} {operator} "{fieldValue}". The only field names supported are status and version. If no value is provided for status it defaults to "promoted". The field version is currently ignored. The only value allowed in the operator is eq (Equals).
  
  When updating a category the query parameter should always be provided with status set to "draft" as the default status is "promoted" and a promoted category cannot be modified.
  
  Example:
  https://{cecsdomain}/content/management/api/v1.1/taxonomies/{id}/categories?q=(status eq "draft")
  Example:
  https://{cecsdomain}/content/management/api/v1.1/taxonomies/{id}/categories?q=(status eq "promoted")

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : CategoryInformation

Type: object

Category Information

Show Source

• ancestors(optional): array ancestors
  The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.
• apiName(optional): string
  The apiName of the Category. This property uniquely identify a category across taxonomies and it will be automatically generated if not provided on creation or updates. This is an optional property in get and post requests.
• children(optional): object CollectionPropertiesCategoryInCollection
  CollectionProperties.
• customProperties(optional): object customProperties
  Additional Properties Allowed: CustomPropertyValuesBean

  The custom properties' values of the Category.
• description(optional): string
  The description of the Category.
• id(optional): string
  The id of the Category. This is a required property in the get response and ignored in post/put requests.
• idPath(optional): string
  Full id path from the root category to this category separated by '/'. This is an optional property in get requests and ignored in post/put requests.
• isSiteCategory(optional): boolean
  Whether the Category is a site category. (defaults to false)
• keywords(optional): array keywords
  The keywords of the Category.
• links(optional): array links
  Links
• name: string
  The name of the Category. It is a required property in the get response and cannot be empty in post / put requests.
• namePath(optional): string
  Full name path from the root category to this category separated by '/'. This is an optional property in get requests and ignored in post/put requests.
• parent(optional): object CategoryAncestorBean
• parentId(optional): string
  The parentId of the Category. This is a required property in get and post requests. When it is provided in a put request it can be used to move a category and the tree below it to another parent category in the taxonomy.
• position(optional): integer(int32)
  Minimum Value: 0

  The position of the Category among its siblings. This is a required property in the get response.
• relatedCategories(optional): array relatedCategories
  The related categories of the Category.
• roleName(optional): string
  name of the role on the resource.
• status(optional): string
  Allowed Values: [ "draft", "promoted" ]

  The status of the Category. This is a required property in the get response and ignored in post/put requests.
• suggestedItems(optional): object ItemSubResourceListItem
  Item SubResource.
• synonyms(optional): array synonyms
  The synonyms of the Category.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category. This is a required property in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category. It is a required property in the get response and cannot be empty in post / put requests."
        },
        "description":{
            "type":"string",
            "description":"The description of the Category."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category. This property uniquely identify a category across taxonomies and it will be automatically generated if not provided on creation or updates. This is an optional property in get and post requests."
        },
        "position":{
            "type":"integer",
            "format":"int32",
            "description":"The position of the Category among its siblings. This is a required property in the get response.",
            "minimum":0
        },
        "parent":{
            "description":"The parent of the Category.",
            "$ref":"#/definitions/CategoryAncestorBean"
        },
        "ancestors":{
            "type":"array",
            "description":"The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.",
            "items":{
                "$ref":"#/definitions/CategoryAncestorBean"
            }
        },
        "parentId":{
            "type":"string",
            "description":"The parentId of the Category. This is a required property in get and post requests. When it is provided in a put request it can be used to move a category and the tree below it to another parent category in the taxonomy."
        },
        "isSiteCategory":{
            "type":"boolean",
            "description":"Whether the Category is a site category. (defaults to false)"
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource."
        },
        "namePath":{
            "type":"string",
            "description":"Full name path from the root category to this category separated by '/'. This is an optional property in get requests and ignored in post/put requests."
        },
        "idPath":{
            "type":"string",
            "description":"Full id path from the root category to this category separated by '/'. This is an optional property in get requests and ignored in post/put requests."
        },
        "children":{
            "description":"Direct children of the Category. This is an expandable property if requested in the expand parameter. Children categories are sorted by position starting from lowest to highest value. Only the first 1000 children categories will be expanded.",
            "$ref":"#/definitions/CollectionPropertiesCategoryInCollection"
        },
        "keywords":{
            "type":"array",
            "description":"The keywords of the Category.",
            "items":{
                "type":"string"
            }
        },
        "synonyms":{
            "type":"array",
            "description":"The synonyms of the Category.",
            "items":{
                "type":"string"
            }
        },
        "relatedCategories":{
            "type":"array",
            "description":"The related categories of the Category.",
            "items":{
                "$ref":"#/definitions/RelatedCategory"
            }
        },
        "customProperties":{
            "type":"object",
            "description":"The custom properties' values of the Category.",
            "additionalProperties":{
                "$ref":"#/definitions/CustomPropertyValuesBean"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "status":{
            "type":"string",
            "description":"The status of the Category. This is a required property in the get response and ignored in post/put requests.",
            "enum":[
                "draft",
                "promoted"
            ]
        },
        "suggestedItems":{
            "description":"The suggested items for this Category.",
            "$ref":"#/definitions/ItemSubResourceListItem"
        }
    },
    "description":"Category Information"
}

Nested Schema : ancestors

Type: array

The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.

Show Source

• Array of: object CategoryAncestorBean

{
    "type":"array",
    "description":"The ancestors of the Category. First element represents the root category and the last element represents the immediate parent of the category.",
    "items":{
        "$ref":"#/definitions/CategoryAncestorBean"
    }
}

Nested Schema : CollectionPropertiesCategoryInCollection

Type: object

CollectionProperties.

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/CategoryInCollection"
            }
        },
        "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":"CollectionProperties."
}

Nested Schema : customProperties

Type: object

Additional Properties Allowed

Show Source

• object CustomPropertyValuesBean

{
    "type":"object",
    "description":"The custom properties' values of the Category.",
    "additionalProperties":{
        "$ref":"#/definitions/CustomPropertyValuesBean"
    }
}

The custom properties' values of the Category.

Nested Schema : keywords

Type: array

The keywords of the Category.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The keywords of the Category.",
    "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 : CategoryAncestorBean

Type: object

Show Source

• apiName(optional): string
  The apiName of the Category ancestor
• id(optional): string
  The id of the Category ancestor.
• name(optional): string
  The name of the Category ancestor.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category ancestor."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category ancestor."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category ancestor"
        }
    }
}

Nested Schema : relatedCategories

Type: array

The related categories of the Category.

Show Source

• Array of: object RelatedCategory
  Related Category

{
    "type":"array",
    "description":"The related categories of the Category.",
    "items":{
        "$ref":"#/definitions/RelatedCategory"
    }
}

Nested Schema : ItemSubResourceListItem

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : synonyms

Type: array

The synonyms of the Category.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The synonyms of the Category.",
    "items":{
        "type":"string"
    }
}

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 CategoryInCollection
  Category in Collection Response

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

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

Type: object

Category in Collection Response

Show Source

• apiName(optional): string
  The apiName of the Category. This property uniquely identify a category across taxonomies and it will be automatically generated if not provided on creation or updates. This is an optional property in get and post requests.
• customProperties(optional): object customProperties
  Additional Properties Allowed: CustomPropertyValuesBean

  The custom properties' values of the Category.
• description(optional): string
  The description of the Category.
• id(optional): string
  The id of the Category. This is a required property in the get response and ignored in post/put requests.
• isSiteCategory(optional): boolean
  Whether the Category is a site category. (defaults to false)
• keywords(optional): array keywords
  The keywords of the Category.
• links(optional): array links
  Links
• name: string
  The name of the Category. It is a required property in the get response and cannot be empty in post / put requests.
• parentId(optional): string
  The parentId of the Category. This is a required property in get and post requests. When it is provided in a put request it can be used to move a category and the tree below it to another parent category in the taxonomy.
• position(optional): integer(int32)
  Minimum Value: 0

  The position of the Category among its siblings. This is a required property in the get response.
• relatedCategories(optional): array relatedCategories
  The related categories of the Category.
• roleName(optional): string
  name of the role on the resource.
• status(optional): string
  Allowed Values: [ "draft", "promoted" ]

  The status of the Category. This is a required property in the get response and ignored in post/put requests.
• suggestedItems(optional): object ItemSubResourceListItem
  Item SubResource.
• synonyms(optional): array synonyms
  The synonyms of the Category.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category. This is a required property in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category. It is a required property in the get response and cannot be empty in post / put requests."
        },
        "description":{
            "type":"string",
            "description":"The description of the Category."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category. This property uniquely identify a category across taxonomies and it will be automatically generated if not provided on creation or updates. This is an optional property in get and post requests."
        },
        "status":{
            "type":"string",
            "description":"The status of the Category. This is a required property in the get response and ignored in post/put requests.",
            "enum":[
                "draft",
                "promoted"
            ]
        },
        "position":{
            "type":"integer",
            "format":"int32",
            "description":"The position of the Category among its siblings. This is a required property in the get response.",
            "minimum":0
        },
        "parentId":{
            "type":"string",
            "description":"The parentId of the Category. This is a required property in get and post requests. When it is provided in a put request it can be used to move a category and the tree below it to another parent category in the taxonomy."
        },
        "isSiteCategory":{
            "type":"boolean",
            "description":"Whether the Category is a site category. (defaults to false)"
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource."
        },
        "suggestedItems":{
            "description":"The suggested items for this Category.",
            "$ref":"#/definitions/ItemSubResourceListItem"
        },
        "keywords":{
            "type":"array",
            "description":"The keywords of the Category.",
            "items":{
                "type":"string"
            }
        },
        "synonyms":{
            "type":"array",
            "description":"The synonyms of the Category.",
            "items":{
                "type":"string"
            }
        },
        "relatedCategories":{
            "type":"array",
            "description":"The related categories of the Category.",
            "items":{
                "$ref":"#/definitions/RelatedCategory"
            }
        },
        "customProperties":{
            "type":"object",
            "description":"The custom properties' values of the Category.",
            "additionalProperties":{
                "$ref":"#/definitions/CustomPropertyValuesBean"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Category in Collection Response"
}

Nested Schema : customProperties

Type: object

Additional Properties Allowed

Show Source

• object CustomPropertyValuesBean

{
    "type":"object",
    "description":"The custom properties' values of the Category.",
    "additionalProperties":{
        "$ref":"#/definitions/CustomPropertyValuesBean"
    }
}

The custom properties' values of the Category.

Nested Schema : keywords

Type: array

The keywords of the Category.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The keywords of the Category.",
    "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 : relatedCategories

Type: array

The related categories of the Category.

Show Source

• Array of: object RelatedCategory
  Related Category

{
    "type":"array",
    "description":"The related categories of the Category.",
    "items":{
        "$ref":"#/definitions/RelatedCategory"
    }
}

Nested Schema : synonyms

Type: array

The synonyms of the Category.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The synonyms of the Category.",
    "items":{
        "type":"string"
    }
}

Nested Schema : CustomPropertyValuesBean

Type: object

Show Source

• values(optional): array values
  The list of values of the custom property.

{
    "type":"object",
    "properties":{
        "values":{
            "type":"array",
            "description":"The list of values of the custom property.",
            "items":{
                "$ref":"#/definitions/CustomPropertyValue"
            }
        }
    }
}

Nested Schema : values

Type: array

The list of values of the custom property.

Show Source

• Array of: object CustomPropertyValue

{
    "type":"array",
    "description":"The list of values of the custom property.",
    "items":{
        "$ref":"#/definitions/CustomPropertyValue"
    }
}

Nested Schema : CustomPropertyValue

Type: object

Show Source

• id(optional): string
  Read Only: true

  The id of the custom property value.
• value(optional): string
  The value of the custom property.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the custom property value.",
            "readOnly":true
        },
        "value":{
            "type":"string",
            "description":"The value of the custom property."
        }
    }
}

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

Type: object

Related Category

Show Source

• apiName(optional): string
  The apiName of the category.
• id(optional): string
  The id of the category.
• name(optional): string
  The name of the category.
• nodes(optional): array nodes
  The path of the category.
• taxonomy(optional): object RelatedTaxonomyBean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the category."
        },
        "name":{
            "type":"string",
            "description":"The name of the category."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category."
        },
        "taxonomy":{
            "description":"The taxonomy of the category.",
            "$ref":"#/definitions/RelatedTaxonomyBean"
        },
        "nodes":{
            "type":"array",
            "description":"The path of the category.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        }
    },
    "description":"Related Category"
}

Nested Schema : nodes

Type: array

The path of the category.

Show Source

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"The path of the category.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : RelatedTaxonomyBean

Type: object

Show Source

• id(optional): string
  The id of the taxonomy.
• name(optional): string
  The name of the taxonomy.
• shortName(optional): string
  The short name of the taxonomy.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "name":{
            "type":"string",
            "description":"The name of the taxonomy."
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the taxonomy."
        }
    }
}

Nested Schema : CategoryNodeBean

Type: object

Show Source

• apiName(optional): string
  The apiName of the Category node.
• id(optional): string
  The id of the Category node.
• name(optional): string
  The name of the Category node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object Item
  Discriminator: typeCategory

  Item

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Item

Type: object

Discriminator: typeCategory

Item

Show Source

• changes(optional): object ItemSubResourceListChangesInfo
  Item SubResource.
• channels(optional): object ItemSubResourceListChannelId
  Item SubResource.
• collections(optional): object ItemSubResourceListCollectionId
  Item SubResource.
• connectorFileInfo(optional): object ItemSubResourceConnectorFileInfo
  Item SubResource.
• connectorId(optional): string
  Connector Id of the item.
• connectorSyncEnabled(optional): boolean
  Connector Sync Enabled flag of the item.
• createdBy(optional): string
  Created by.
• createdByUser(optional): object User
  User object
• createdDate(optional): object date
  date
• description(optional): string
  description of the item
• fields(optional): object fields
  Read Only: true

  Additional Properties Allowed: additionalProperties

  User-defined fields data. Map. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.
• fileExtension(optional): string
  Extension of the file.
• id(optional): string
  id of the item. It is a required property in the get response and put request whereas it is not required in the post request.
• isPublished(optional): boolean
  Whether the item is ever published.
• language(optional): string
  Language of the item.
• languageIsMaster(optional): boolean
  Whether the item is master.
• links(optional): array links
  Links
• lockInfo(optional): object ItemSubResourceLockInfo
  Item SubResource.
• metadata(optional): object ItemMetadataInfo
  ItemMetadataInfo
• name(optional): string
  Name of the item. It is a required property in the get response and post/put request.
• permissions(optional): object ItemSubResourceListAction
  Item SubResource.
• publishedChannels(optional): object ItemSubResourceListChannelId
  Item SubResource.
• publishInfo(optional): object ItemSubResourceListPublishInfo
  Item SubResource.
• reference(optional): object ItemReferenceInfo
  ItemReferenceInfo
• relationships(optional): object ItemSubResourceRelationships
  Item SubResource.
• repositoryId(optional): string
  Repository of the item. It is a required property in the get response and post/put request.
• scheduled(optional): boolean
• slug(optional): string
  URL slug of the item.
• sourceId(optional): string
  Source Id.
• status(optional): string
  Current status of the item.
• suggestedTaxonomies(optional): object ItemSubResourceListSuggestedTaxonomyInfo
  Item SubResource.
• tags(optional): object ItemSubResourceListTag
  Item SubResource.
• taxonomies(optional): object ItemSubResourceListTaxonomyInfo
  Item SubResource.
• translatable(optional): boolean
  Whether the item is translatable.
• type(optional): string
  Name of the type. It is a required property in the get response and post/put request.
• typeCategory(optional): string
  Read Only: true
• updatedBy(optional): string
  Updated by.
• updatedByUser(optional): object User
  User object
• updatedDate(optional): object date
  date
• variations(optional): object ItemSubResourceListVariationsInfo
  Item SubResource.
• version(optional): string
  The current revision version of this item.
• versionInfo(optional): object ItemSubResourceListVersionInfo
  Item SubResource.
• video(optional): object VideoBean
  VideoBean
• workflowInstances(optional): object WorkflowField
  All mapped workflow fields
• workflows(optional): object ItemSubResourceListWorkflowInfo
  Item SubResource.

{
    "type":"object",
    "discriminator":"typeCategory",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "type":{
            "type":"string",
            "description":"Name of the type. It is a required property in the get response and post/put request."
        },
        "typeCategory":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the item. It is a required property in the get response and post/put request."
        },
        "description":{
            "type":"string",
            "description":"description of the item"
        },
        "createdBy":{
            "type":"string",
            "description":"Created by."
        },
        "createdByUser":{
            "description":"Created by.",
            "$ref":"#/definitions/User"
        },
        "createdDate":{
            "description":"date and time Item createdAt",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated by."
        },
        "updatedByUser":{
            "description":"Updated by.",
            "$ref":"#/definitions/User"
        },
        "updatedDate":{
            "description":"date and time Item updatedAt",
            "$ref":"#/definitions/date"
        },
        "slug":{
            "type":"string",
            "description":"URL slug of the item."
        },
        "repositoryId":{
            "type":"string",
            "description":"Repository of the item. It is a required property in the get response and post/put request."
        },
        "language":{
            "type":"string",
            "description":"Language of the item."
        },
        "translatable":{
            "type":"boolean",
            "description":"Whether the item is translatable."
        },
        "status":{
            "type":"string",
            "description":"Current status of the item."
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the item is ever published."
        },
        "languageIsMaster":{
            "type":"boolean",
            "description":"Whether the item is master."
        },
        "version":{
            "type":"string",
            "description":"The current revision version of this item."
        },
        "fileExtension":{
            "type":"string",
            "description":"Extension of the file."
        },
        "scheduled":{
            "type":"boolean"
        },
        "tags":{
            "description":"Tags of the item.",
            "$ref":"#/definitions/ItemSubResourceListTag"
        },
        "fields":{
            "type":"object",
            "description":"User-defined fields data. Map<String,Object>. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.",
            "readOnly":true,
            "additionalProperties":{
                "type":"object"
            }
        },
        "variations":{
            "description":"Item variations.",
            "$ref":"#/definitions/ItemSubResourceListVariationsInfo"
        },
        "versionInfo":{
            "description":"Item version info.",
            "$ref":"#/definitions/ItemSubResourceListVersionInfo"
        },
        "publishInfo":{
            "description":"All targets publish info.",
            "$ref":"#/definitions/ItemSubResourceListPublishInfo"
        },
        "lockInfo":{
            "$ref":"#/definitions/ItemSubResourceLockInfo"
        },
        "connectorFileInfo":{
            "$ref":"#/definitions/ItemSubResourceConnectorFileInfo"
        },
        "channels":{
            "$ref":"#/definitions/ItemSubResourceListChannelId"
        },
        "publishedChannels":{
            "$ref":"#/definitions/ItemSubResourceListChannelId"
        },
        "collections":{
            "$ref":"#/definitions/ItemSubResourceListCollectionId"
        },
        "relationships":{
            "$ref":"#/definitions/ItemSubResourceRelationships"
        },
        "taxonomies":{
            "$ref":"#/definitions/ItemSubResourceListTaxonomyInfo"
        },
        "suggestedTaxonomies":{
            "$ref":"#/definitions/ItemSubResourceListSuggestedTaxonomyInfo"
        },
        "workflows":{
            "$ref":"#/definitions/ItemSubResourceListWorkflowInfo"
        },
        "workflowInstances":{
            "$ref":"#/definitions/WorkflowField"
        },
        "changes":{
            "$ref":"#/definitions/ItemSubResourceListChangesInfo"
        },
        "metadata":{
            "$ref":"#/definitions/ItemMetadataInfo"
        },
        "video":{
            "$ref":"#/definitions/VideoBean"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "connectorId":{
            "type":"string",
            "description":"Connector Id of the item."
        },
        "connectorSyncEnabled":{
            "type":"boolean",
            "description":"Connector Sync Enabled flag of the item."
        },
        "sourceId":{
            "type":"string",
            "description":"Source Id."
        },
        "permissions":{
            "$ref":"#/definitions/ItemSubResourceListAction"
        },
        "reference":{
            "description":"Access information of the Referenced Item.",
            "$ref":"#/definitions/ItemReferenceInfo"
        }
    },
    "description":"Item"
}

Nested Schema : ItemSubResourceListChangesInfo

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChangesInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListChannelId

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListCollectionId

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CollectionId"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceConnectorFileInfo

Type: object

Item SubResource.

Show Source

• data(optional): object ConnectorFileInfo
  ConnectorFileInfo
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/ConnectorFileInfo"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : User

Type: object

User object

Show Source

• displayName(optional): string
  Read Only: true

  display name of the user.
• email(optional): string
  Read Only: true

  email of the user.
• userID(optional): integer(int64)
  Read Only: true

  id of the user.
• userName(optional): string
  Read Only: true

  name of the user.

{
    "type":"object",
    "properties":{
        "userID":{
            "type":"integer",
            "format":"int64",
            "description":"id of the user.",
            "readOnly":true
        },
        "userName":{
            "type":"string",
            "description":"name of the user.",
            "readOnly":true
        },
        "displayName":{
            "type":"string",
            "description":"display name of the user.",
            "readOnly":true
        },
        "email":{
            "type":"string",
            "description":"email of the user.",
            "readOnly":true
        }
    },
    "description":"User object"
}

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

Type: object

Read Only: true

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"User-defined fields data. Map<String,Object>. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.",
    "readOnly":true,
    "additionalProperties":{
        "type":"object"
    }
}

User-defined fields data. Map. All the user-defined fields required in the type definition must be provided under this property in PUT and POST request.

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

Type: object

Item SubResource.

Show Source

• data(optional): object LockInfo
  LockInfo
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/LockInfo"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemMetadataInfo

Type: object

ItemMetadataInfo

Show Source

• exif(optional): object EXIFMetadata
  EXIF Metadata
• links(optional): array links
  Links
• transcripts(optional): object VideoTranscriptMetadata
  Video Transcription Metadata

{
    "type":"object",
    "properties":{
        "exif":{
            "$ref":"#/definitions/EXIFMetadata"
        },
        "transcripts":{
            "$ref":"#/definitions/VideoTranscriptMetadata"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemMetadataInfo"
}

Nested Schema : ItemSubResourceListAction

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Action"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListPublishInfo

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemReferenceInfo

Type: object

ItemReferenceInfo

Show Source

• isAccessible(optional): boolean
  Whether the item is accessible.

{
    "type":"object",
    "properties":{
        "isAccessible":{
            "type":"boolean",
            "description":"Whether the item is accessible."
        }
    },
    "description":"ItemReferenceInfo"
}

Nested Schema : ItemSubResourceRelationships

Type: object

Item SubResource.

Show Source

• data(optional): object Relationships
  Relationships
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/Relationships"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListSuggestedTaxonomyInfo

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuggestedTaxonomyInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListTag

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Tag"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListTaxonomyInfo

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaxonomyInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListVariationsInfo

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VariationsInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : ItemSubResourceListVersionInfo

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/VersionInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : VideoBean

Type: object

VideoBean

Show Source

• duration(optional): string
  Read Only: true

  The duration of the video in ISO 8601 format.
• isFormatSupported(optional): boolean
  Read Only: true

  A boolean expressing if the video file format is supported.
• playback(optional): object PlaybackBean
  PlaybackBean
• processing(optional): object ProcessingBean
  ProcessingBean
• strip(optional): object StripBean
  StripBean

{
    "type":"object",
    "properties":{
        "strip":{
            "description":"Data about the video strip image.",
            "readOnly":true,
            "$ref":"#/definitions/StripBean"
        },
        "duration":{
            "type":"string",
            "description":"The duration of the video in ISO 8601 format.",
            "readOnly":true
        },
        "isFormatSupported":{
            "type":"boolean",
            "description":"A boolean expressing if the video file format is supported.",
            "readOnly":true
        },
        "playback":{
            "description":"Video playback data.",
            "readOnly":true,
            "$ref":"#/definitions/PlaybackBean"
        },
        "processing":{
            "description":"Data about the video background process.",
            "readOnly":true,
            "$ref":"#/definitions/ProcessingBean"
        }
    },
    "description":"VideoBean"
}

Nested Schema : WorkflowField

Type: object

All mapped workflow fields

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/WorkflowInfo"
            }
        },
        "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":"All mapped workflow fields"
}

Nested Schema : ItemSubResourceListWorkflowInfo

Type: object

Item SubResource.

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkflowInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

Nested Schema : data

Type: array

Show Source

• Array of: object ChangesInfo
  ChangesInfo

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : ChangesInfo

Type: object

ChangesInfo

Show Source

• links(optional): array links
• source(optional): string
  Sub-resource associated to this item which is source of this change.
• type(optional): string
  Type of change tracked for the given source.
• value(optional): boolean
  True indicates a change. False indicates no current changes for this source/type.

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string",
            "description":"Sub-resource associated to this item which is source of this change."
        },
        "type":{
            "type":"string",
            "description":"Type of change tracked for the given source."
        },
        "value":{
            "type":"boolean",
            "description":"True indicates a change. False indicates no current changes for this source/type."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChangesInfo"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : data

Type: array

Show Source

• Array of: object ChannelId
  ChannelId

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "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 : data

Type: array

Show Source

• Array of: object CollectionId
  CollectionId

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : CollectionId

Type: object

CollectionId

Show Source

• id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    },
    "description":"CollectionId"
}

Nested Schema : ConnectorFileInfo

Type: object

ConnectorFileInfo

Show Source

• connectorId(optional): string
  Connector id.
• id(optional): string
  File id.
• inUse(optional): boolean
  Represents whether the latest version of asset is using the file content.
• version(optional): integer(int32)
  File version

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"Connector id."
        },
        "id":{
            "type":"string",
            "description":"File id."
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"File version"
        },
        "inUse":{
            "type":"boolean",
            "description":"Represents whether the latest version of asset is using the file content."
        }
    },
    "description":"ConnectorFileInfo"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : additionalProperties

Type: object

Nested Schema : LockInfo

Type: object

LockInfo

Show Source

• isLocked(optional): boolean
  Represents whether the item is locked or not.
• lockedBy(optional): string
  Locked by user
• lockedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "isLocked":{
            "type":"boolean",
            "description":"Represents whether the item is locked or not."
        },
        "lockedBy":{
            "type":"string",
            "description":"Locked by user"
        },
        "lockedDate":{
            "description":"Locked date and time",
            "$ref":"#/definitions/date"
        }
    },
    "description":"LockInfo"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : EXIFMetadata

Type: object

EXIF Metadata

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/ItemExtractedExifBean"
            }
        },
        "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":"EXIF Metadata"
}

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

Type: object

Video Transcription Metadata

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/Videotranscript"
            }
        },
        "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":"Video Transcription Metadata"
}

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 ItemExtractedExifBean
  ItemExtractedExifBean

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

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

Type: object

ItemExtractedExifBean

Show Source

• floatValue(optional): number(float)
  The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision.
• handle(optional): string
  The handle or EXIF field name. This value is not translatable.
• integerValue(optional): integer(int32)
  The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point.
• links(optional): array links
  Links
• rawId(optional): string
  The ID of the EXIF field. Uniquely identifies one EXIF field.
• rawValue(optional): string
  The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value.
• stringValue(optional): string
  The text value of the EXIF field. This value will be a text representation of the EXIF field value.
• type(optional): string
  The data type of the EXIF field. (date, integer, float, string).
• value(optional): string
  The display value of the EXIF field. This value will be a text representation of the actual type value of the EXIF field (date, int, float, string).

{
    "type":"object",
    "properties":{
        "rawId":{
            "type":"string",
            "description":"The ID of the EXIF field. Uniquely identifies one EXIF field."
        },
        "handle":{
            "type":"string",
            "description":"The handle or EXIF field name. This value is not translatable."
        },
        "rawValue":{
            "type":"string",
            "description":"The raw EXIF field value. This value can be a numeric value out of a predefined value list or a text value."
        },
        "value":{
            "type":"string",
            "description":"The display value of the EXIF field. This value will be a text representation of the actual type value of the EXIF field (date, int, float, string)."
        },
        "type":{
            "type":"string",
            "description":"The data type of the EXIF field. (date, integer, float, string)."
        },
        "stringValue":{
            "type":"string",
            "description":"The text value of the EXIF field. This value will be a text representation of the EXIF field value."
        },
        "integerValue":{
            "type":"integer",
            "format":"int32",
            "description":"The integer value of the EXIF field. This value will be a numeric representation of the EXIF field value without a decimal point."
        },
        "floatValue":{
            "type":"number",
            "format":"float",
            "description":"The float value of the EXIF field. This value will be a numeric representation of the EXIF field value with decimal precision."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemExtractedExifBean"
}

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 : 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 Videotranscript
  Video transcript

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

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

Type: object

Video transcript

Show Source

• end(optional): string
  End of each transcript node.
• id(optional): string
  Id of each transcript node.
• links(optional): array links
  Links
• start(optional): string
  Start of each transcript node.
• text(optional): string
  Text of each transcript node.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of each transcript node."
        },
        "start":{
            "type":"string",
            "description":"Start of each transcript node."
        },
        "end":{
            "type":"string",
            "description":"End of each transcript node."
        },
        "text":{
            "type":"string",
            "description":"Text of each transcript node."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Video transcript"
}

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

Type: array

Show Source

• Array of: object Action
  Action

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Action

Type: object

Action

Show Source

• action(optional): string
  Allowed Values: [ "view", "update", "create", "delete" ]

  action is allowed on the resource

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"action is allowed on the resource",
            "enum":[
                "view",
                "update",
                "create",
                "delete"
            ]
        }
    },
    "description":"Action"
}

Nested Schema : data

Type: array

Show Source

• Array of: object PublishInfo
  PublishInfo

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : PublishInfo

Type: object

PublishInfo

Show Source

• channel(optional): string
  Target name
• links(optional): array links
  Links
• publishedBy(optional): string
  Published by
• publishedDate(optional): object date
  date
• slug(optional): string
  Published slug
• version(optional): string
  Published version

{
    "type":"object",
    "properties":{
        "channel":{
            "type":"string",
            "description":"Target name"
        },
        "publishedBy":{
            "type":"string",
            "description":"Published by"
        },
        "version":{
            "type":"string",
            "description":"Published version"
        },
        "publishedDate":{
            "description":"date and time Item publishedAt.",
            "$ref":"#/definitions/date"
        },
        "slug":{
            "type":"string",
            "description":"Published slug"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PublishInfo"
}

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

Type: object

Relationships

Show Source

• referencedBy(optional): array referencedBy
  Referenced by ids
• referencedBySitePlan(optional): object Siteplanreference
  Site plan reference
• referencedBySites(optional): array referencedBySites
  Referenced by sites
• references(optional): array references
  Reference ids

{
    "type":"object",
    "properties":{
        "references":{
            "type":"array",
            "description":"Reference ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBy":{
            "type":"array",
            "description":"Referenced by ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBySites":{
            "type":"array",
            "description":"Referenced by sites",
            "items":{
                "$ref":"#/definitions/ReferencedBySites"
            }
        },
        "referencedBySitePlan":{
            "$ref":"#/definitions/Siteplanreference"
        }
    },
    "description":"Relationships"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : referencedBy

Type: array

Referenced by ids

Show Source

• Array of: object References
  References

{
    "type":"array",
    "description":"Referenced by ids",
    "items":{
        "$ref":"#/definitions/References"
    }
}

Nested Schema : Siteplanreference

Type: object

Site plan reference

Show Source

• id(optional): string
  id of the site plan.
• links(optional): array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the site plan."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Site plan reference"
}

Nested Schema : referencedBySites

Type: array

Referenced by sites

Show Source

• Array of: object ReferencedBySites
  ReferencedBySites

{
    "type":"array",
    "description":"Referenced by sites",
    "items":{
        "$ref":"#/definitions/ReferencedBySites"
    }
}

Nested Schema : references

Type: array

Reference ids

Show Source

• Array of: object References
  References

{
    "type":"array",
    "description":"Reference ids",
    "items":{
        "$ref":"#/definitions/References"
    }
}

Nested Schema : References

Type: object

References

Show Source

• id(optional): string
  id of the item.
• links(optional): array links
• reference(optional): object ItemReferenceInfo
  ItemReferenceInfo

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "reference":{
            "description":"Access information of the Referenced Item.",
            "$ref":"#/definitions/ItemReferenceInfo"
        }
    },
    "description":"References"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : ReferencedBySites

Type: object

ReferencedBySites

Show Source

• component(optional): string
  Component of the item
• pageId(optional): string
  Page the item added to
• site(optional): string
  Site the item added to

{
    "type":"object",
    "properties":{
        "site":{
            "type":"string",
            "description":"Site the item added to"
        },
        "pageId":{
            "type":"string",
            "description":"Page the item added to"
        },
        "component":{
            "type":"string",
            "description":"Component of the item"
        }
    },
    "description":"ReferencedBySites"
}

Nested Schema : data

Type: array

Show Source

• Array of: object SuggestedTaxonomyInfo
  SuggestedTaxonomyInfo

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : SuggestedTaxonomyInfo

Type: object

SuggestedTaxonomyInfo

Show Source

• categories(optional): array categories
  Categories in the Suggested Taxonomy the item belongs to.
• id(optional): string
• links(optional): array links
• name(optional): string
• shortName(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "categories":{
            "type":"array",
            "description":"Categories in the Suggested Taxonomy the item belongs to.",
            "items":{
                "$ref":"#/definitions/ItemSuggestedCategoryInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"SuggestedTaxonomyInfo"
}

Nested Schema : categories

Type: array

Categories in the Suggested Taxonomy the item belongs to.

Show Source

• Array of: object ItemSuggestedCategoryInfo

{
    "type":"array",
    "description":"Categories in the Suggested Taxonomy the item belongs to.",
    "items":{
        "$ref":"#/definitions/ItemSuggestedCategoryInfo"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : ItemSuggestedCategoryInfo

Type: object

Show Source

• apiName(optional): string
  The apiName of the category assigned to the item.
• id(optional): string
• isRejected(optional): boolean
  Status of the Suggested Category for the Item.
• links(optional): array links
• name(optional): string
• nodes(optional): array nodes
  Nodes in the category assigned to the item.
• order(optional): integer(int32)
  Probability order of the Suggested Category across all the Taxonomies assigned to the repository.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category assigned to the item."
        },
        "isRejected":{
            "type":"boolean",
            "description":"Status of the Suggested Category for the Item."
        },
        "order":{
            "type":"integer",
            "format":"int32",
            "description":"Probability order of the Suggested Category across all the Taxonomies assigned to the repository."
        },
        "nodes":{
            "type":"array",
            "description":"Nodes in the category assigned to the item.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : nodes

Type: array

Nodes in the category assigned to the item.

Show Source

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"Nodes in the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object Tag
  Tag.

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Tag

Type: object

Tag.

Show Source

• language: string
  language of the tag.
• links(optional): array links
  Links
• name: string
  Name of the tag.

{
    "type":"object",
    "required":[
        "language",
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the tag."
        },
        "language":{
            "type":"string",
            "description":"language of the tag."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Tag."
}

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

Type: array

Show Source

• Array of: object TaxonomyInfo
  TaxonomyInfo

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : TaxonomyInfo

Type: object

TaxonomyInfo

Show Source

• categories(optional): array categories
  Categories in the Taxonomy the item belongs to.
• id(optional): string
• links(optional): array links
• name(optional): string
• shortName(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "categories":{
            "type":"array",
            "description":"Categories in the Taxonomy the item belongs to.",
            "items":{
                "$ref":"#/definitions/ItemCategoryInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"TaxonomyInfo"
}

Nested Schema : categories

Type: array

Categories in the Taxonomy the item belongs to.

Show Source

• Array of: object ItemCategoryInfo

{
    "type":"array",
    "description":"Categories in the Taxonomy the item belongs to.",
    "items":{
        "$ref":"#/definitions/ItemCategoryInfo"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : ItemCategoryInfo

Type: object

Show Source

• apiName(optional): string
  The apiName of the category assigned to the item.
• id(optional): string
• links(optional): array links
• name(optional): string
• nodes(optional): array nodes
  Nodes in the category assigned to the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category assigned to the item."
        },
        "nodes":{
            "type":"array",
            "description":"Nodes in the category assigned to the item.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : nodes

Type: array

Nodes in the category assigned to the item.

Show Source

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"Nodes in the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object VariationsInfo
  Variations Info.

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : VariationsInfo

Type: object

Variations Info.

Show Source

• items(optional): array items
  Content item variations.
• links(optional): array links
• masterItem(optional): string
  Master item.
• setId(optional): string
  Variation set id.
• varType(optional): string
  Variation type name.

{
    "type":"object",
    "properties":{
        "setId":{
            "type":"string",
            "description":"Variation set id."
        },
        "varType":{
            "type":"string",
            "description":"Variation type name."
        },
        "masterItem":{
            "type":"string",
            "description":"Master item."
        },
        "items":{
            "type":"array",
            "description":"Content item variations.",
            "items":{
                "$ref":"#/definitions/Language"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Variations Info."
}

Nested Schema : items

Type: array

Content item variations.

Show Source

• Array of: object Language
  LanguageItem

{
    "type":"array",
    "description":"Content item variations.",
    "items":{
        "$ref":"#/definitions/Language"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : Language

Type: object

LanguageItem

Show Source

• id(optional): string
  id of the item.
• isPublished(optional): boolean
  Whether the item is ever published.
• links(optional): array links
• name(optional): string
  name of the item.
• status(optional): string
  status of item
• value(optional): string
  Language value

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "value":{
            "type":"string",
            "description":"Language value"
        },
        "status":{
            "type":"string",
            "description":"status of item"
        },
        "isPublished":{
            "type":"boolean",
            "description":"Whether the item is ever published."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"LanguageItem"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : data

Type: array

Show Source

• Array of: object VersionInfo
  VersionInfo

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : VersionInfo

Type: object

VersionInfo

Show Source

• latestVersion(optional): string
  Latest version
• publishedVersion(optional): string
  Published version

{
    "type":"object",
    "properties":{
        "latestVersion":{
            "type":"string",
            "description":"Latest version"
        },
        "publishedVersion":{
            "type":"string",
            "description":"Published version"
        }
    },
    "description":"VersionInfo"
}

Nested Schema : PlaybackBean

Type: object

PlaybackBean

Show Source

• adaptiveStreams(optional): object AdaptiveStreamsBean
  AdaptiveStreamsBean

{
    "type":"object",
    "properties":{
        "adaptiveStreams":{
            "description":"The available adaptive streams.",
            "readOnly":true,
            "$ref":"#/definitions/AdaptiveStreamsBean"
        }
    },
    "description":"PlaybackBean"
}

Nested Schema : ProcessingBean

Type: object

ProcessingBean

Show Source

• progress(optional): string
  Read Only: true

  The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.

{
    "type":"object",
    "properties":{
        "progress":{
            "type":"string",
            "description":"The progress of the background process. The value of this field will be one of PENDING, SUCCEEDED or FAILED.",
            "readOnly":true
        }
    },
    "description":"ProcessingBean"
}

Nested Schema : StripBean

Type: object

StripBean

Show Source

• frame(optional): object StripFrameBean
  StripFrameBean

{
    "type":"object",
    "properties":{
        "frame":{
            "description":"The frame data about the strip image.",
            "readOnly":true,
            "$ref":"#/definitions/StripFrameBean"
        }
    },
    "description":"StripBean"
}

Nested Schema : AdaptiveStreamsBean

Type: object

AdaptiveStreamsBean

Show Source

• dash(optional): object PlaybackBean
  PlaybackBean
• hls(optional): object PlaybackBean
  PlaybackBean

{
    "type":"object",
    "properties":{
        "hls":{
            "description":"The HLS adaptive stream data.",
            "readOnly":true,
            "$ref":"#/definitions/PlaybackBean"
        },
        "dash":{
            "description":"The DASH adaptive stream data.",
            "readOnly":true,
            "$ref":"#/definitions/PlaybackBean"
        }
    },
    "description":"AdaptiveStreamsBean"
}

Nested Schema : StripFrameBean

Type: object

StripFrameBean

Show Source

• count(optional): integer(int32)
  Read Only: true

  The number of frames in the strip image.
• height(optional): integer(int32)
  Read Only: true

  The height of the strip image.
• width(optional): integer(int32)
  Read Only: true

  The width of the strip image.

{
    "type":"object",
    "properties":{
        "width":{
            "type":"integer",
            "format":"int32",
            "description":"The width of the strip image.",
            "readOnly":true
        },
        "height":{
            "type":"integer",
            "format":"int32",
            "description":"The height of the strip image.",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of frames in the strip image.",
            "readOnly":true
        }
    },
    "description":"StripFrameBean"
}

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

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

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

Type: object

WorkflowInfo.

Show Source

• id(optional): string
  Workflow id.
• instanceId: string
  Workflow instance id.
• isCompleted(optional): boolean
  If workflow instance is completed or not in OIC.
• links(optional): array links
  Links
• name(optional): string
  Workflow name.
• status(optional): string
  Workflow status.
• submittedBy(optional): string
  Submitted by user
• submittedDate(optional): object date
  date

{
    "type":"object",
    "required":[
        "instanceId"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Workflow id."
        },
        "instanceId":{
            "type":"string",
            "description":"Workflow instance id."
        },
        "name":{
            "type":"string",
            "description":"Workflow name."
        },
        "status":{
            "type":"string",
            "description":"Workflow status."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        },
        "isCompleted":{
            "type":"boolean",
            "description":"If workflow instance is completed or not in OIC."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowInfo."
}

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

Type: array

Show Source

• Array of: object WorkflowInfo
  WorkflowInfo.

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Taxonomy not found. The requested resource not found.

500 Response

Internal server error.

Back to Top

Examples

The following examples show how to retrieve a specific taxonomy category by submission of a GET request using cURL:

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

Example 1:

Retrieves a category identified by the category ID B0A39B47122C4CE88A6CD52B90C15263 from the draft taxonomy with ID D7969D6CA0D144AEA9CCA88BA6D2CF81.

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?q=(status eq \"draft\")

Response Body

{
  "id": "B0A39B47122C4CE88A6CD52B90C15263",
  "name": "C4",
  "description": "",
  "parentId": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
  "children": {
    "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories?q=( parentId eq \"B0A39B47122C4CE88A6CD52B90C15263\" and  status eq \"draft\" )"
  },
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?q=(status eq \"draft\")",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?q=(status eq \"draft\")",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ],
  "status": "draft",
  "position": 3
} 

Example 2:

Shows how to retrieve a category and add the optional field namePath.

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?q=(status eq \"draft\")&fields=namePath

Response Body

{
  "id": "B0A39B47122C4CE88A6CD52B90C15263",
  "name": "C4",
  "description": "",
  "parentId": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
  "namePath": "/C4",
  "children": {
    "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories?fields=namePath&q=( parentId eq \"B0A39B47122C4CE88A6CD52B90C15263\" and  status eq \"draft\" )"
  },
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?fields=namePath&q=(status eq \"draft\")",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?fields=namePath&q=(status eq \"draft\")",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ],
  "status": "draft",
  "position": 3
}
 

Example 3:

Shows how to fetch the category and the optional fields namePath and idPath.

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?q=(status eq \"draft\")&fields=namePath,idPath

Response Body

{
  "id": "B0A39B47122C4CE88A6CD52B90C15263",
  "name": "C4",
  "description": "",
  "parentId": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
  "namePath": "/C4",
  "idPath": "/B0A39B47122C4CE88A6CD52B90C15263",
  "children": {
    "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories?fields=namePath,idPath&q=( parentId eq \"B0A39B47122C4CE88A6CD52B90C15263\" and  status eq \"draft\" )"
  },
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?fields=namePath,idPath&q=(status eq \"draft\")",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263?fields=namePath,idPath&q=(status eq \"draft\")",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/B0A39B47122C4CE88A6CD52B90C15263",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ],
  "status": "draft",
  "position": 3
}  

Example 4:

Shows how to retrieve the category and expand the field children. It expands inline a list of the category's direct children up to a maximum count of 10.

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/35B41502F9A94113AC493C244794D2AC?q=(status eq \"draft\")&expand=children

Response Body

{
  "id": "35B41502F9A94113AC493C244794D2AC",
  "name": "C1",
  "description": "",
  "parentId": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
  "children": {
    "hasMore": false,
    "offset": 0,
    "count": 3,
    "limit": 10,
    "items": [
      {
        "id": "C52EE14C1CB34A95ACC9CDC3CF8BE289",
        "name": "C1.1",
        "description": "",
        "status": "draft",
        "position": 0,
        "parentId": "35B41502F9A94113AC493C244794D2AC",
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/C52EE14C1CB34A95ACC9CDC3CF8BE289?q=( status eq \"draft\" )",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      {
        "id": "36C51840F39A436B8F64A6DC5BC4C3B7",
        "name": "C1.2",
        "description": "",
        "status": "draft",
        "position": 1,
        "parentId": "35B41502F9A94113AC493C244794D2AC",
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/36C51840F39A436B8F64A6DC5BC4C3B7?q=( status eq \"draft\" )",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      },
      {
        "id": "D1C7F6E13A4A4AF4ABBF211635D6CB43",
        "name": "C1.3",
        "description": "",
        "status": "draft",
        "position": 2,
        "parentId": "35B41502F9A94113AC493C244794D2AC",
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/D1C7F6E13A4A4AF4ABBF211635D6CB43?q=( status eq \"draft\" )",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }
    ],
    "links": [
      {
        "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories?q=( parentId eq \"35B41502F9A94113AC493C244794D2AC\" and  status eq \"draft\" )",
        "rel": "self",
        "method": "GET",
        "mediaType": "application/json"
      },
      {
        "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories?q=( parentId eq \"35B41502F9A94113AC493C244794D2AC\" and  status eq \"draft\" )",
        "rel": "canonical",
        "method": "GET",
        "mediaType": "application/json"
      },
      {
        "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories",
        "rel": "describedby",
        "method": "GET",
        "mediaType": "application/schema+json"
      },
      {
        "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories?offset=0&q=( parentId eq \"35B41502F9A94113AC493C244794D2AC\" and  status eq \"draft\" )",
        "rel": "first",
        "method": "GET",
        "mediaType": "application/json"
      },
      {
        "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories?offset=0&q=( parentId eq \"35B41502F9A94113AC493C244794D2AC\" and  status eq \"draft\" )",
        "rel": "last",
        "method": "GET",
        "mediaType": "application/json"
      }
    ]
  },
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/35B41502F9A94113AC493C244794D2AC?q=(status eq \"draft\")&expand=children",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/35B41502F9A94113AC493C244794D2AC?q=(status eq \"draft\")&expand=children",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories/35B41502F9A94113AC493C244794D2AC",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ],
  "status": "draft",
  "position": 0
}  

Example 5:

Retrieves the category identified by the category id 4136D8D1FD5C4241A3E08A42765D615C with default plus isSiteCategory fields from taxonomy with id AF6B75DBBCA244FC93166610EA2BA62A.

/content/management/api/v1.1/taxonomies/AF6B75DBBCA244FC93166610EA2BA62A/categories/4136D8D1FD5C4241A3E08A42765D615C?fields=isSiteCategory

Response Body

{
  "id": "4136D8D1FD5C4241A3E08A42765D615C",
  "name": "Site1_site_category",
  "description": "site category for site: Site1",
  "apiName": "sst-o-t-s",
  "position": 0,
  "parentId": "F54C934D081B4768B3A93A45C0E6955C",
  "isSiteCategory": true,
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/taxonomies/AF6B75DBBCA244FC93166610EA2BA62A/categories/4136D8D1FD5C4241A3E08A42765D615C?fields=isSiteCategory",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/taxonomies/AF6B75DBBCA244FC93166610EA2BA62A/categories/4136D8D1FD5C4241A3E08A42765D615C?fields=isSiteCategory",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/AF6B75DBBCA244FC93166610EA2BA62A/categories/4136D8D1FD5C4241A3E08A42765D615C",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/json"
    }
  ],
  "status": "promoted"
}

Back to Top