• completed(optional): boolean
  Whether the original request is completed or not
• completedPercentage(optional): integer(int32)
  A number between 0 and 100, capturing how much of the process has been completed.
• endTime(optional): object date
  date
• error(optional): object Error
  Error
• id(optional): string
  status id of the original request. It is a required property in the get response.
• links(optional): array links
  links of the status resource
• message(optional): string
  Human readable message about the current processing status
• progress(optional): string
  Allowed Values: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  The current progress of the original request. It is a required property in the get response.
• requestStatus(optional): integer(int32)
  HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed
• result(optional): object ResultBulkItemsOperations
  Result
• startTime(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"status id of the original request. It is a required property in the get response."
        },
        "startTime":{
            "description":"Time when the original request started",
            "$ref":"#/definitions/date"
        },
        "endTime":{
            "description":"Time when the original request ended",
            "$ref":"#/definitions/date"
        },
        "progress":{
            "type":"string",
            "description":"The current progress of the original request. It is a required property in the get response.",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"Whether the original request is completed or not"
        },
        "message":{
            "type":"string",
            "description":"Human readable message about the current processing status"
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "requestStatus":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed"
        },
        "result":{
            "description":"The response when the original async request finishes",
            "$ref":"#/definitions/ResultBulkItemsOperations"
        },
        "error":{
            "description":"contains error detail of the original request. This is only available when the original request is processed and failed",
            "$ref":"#/definitions/Error"
        },
        "links":{
            "type":"array",
            "description":"links of the status resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"BulkItemsOperationsStatus"
}

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

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

• detail(optional): string
  Detailed error message.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application specific error code.
• o:errorDetails(optional): object Error
  Error
• o:errorPath(optional): string
  XPath or JSON patch to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code.
• title(optional): string
  Summary error message. It is a required property in the get response.
• type(optional): string
  Link to HTTP error code page. It is a required property in the get response.

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Summary error message. It is a required property in the get response."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page. It is a required property in the get response."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application specific error code."
        },
        "o:errorDetails":{
            "description":"Drill down to the details. Multiple errors can be organized in a hierarchical structure.",
            "$ref":"#/definitions/Error"
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON patch to indicate where the error occurs."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        }
    },
    "description":"Error"
}

• Array of: object Link
  Link of the resource.

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

• body(optional): object BulkItemsOperations
  Item Bulk Operations
• headers(optional): array headers
  List of the HTTP headers of the response to the original async request
• status(optional): object ResultHTTPStatus
  ResultHTTPStatus

{
    "type":"object",
    "properties":{
        "status":{
            "description":"HTTP status line of the response to the original async request",
            "$ref":"#/definitions/ResultHTTPStatus"
        },
        "headers":{
            "type":"array",
            "description":"List of the HTTP headers of the response to the original async request",
            "items":{
                "$ref":"#/definitions/ResultHTTPHeader"
            }
        },
        "body":{
            "description":"HTTP body of the response to the original async request",
            "$ref":"#/definitions/BulkItemsOperations"
        }
    },
    "description":"Result"
}

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

• links(optional): array links
  Links of the bulk items operations resource.
• operations(optional): object BulkItemsOperationsActions
  Operations that can be performed. Currently only one operation at a time is supported.
• q(optional): string
  This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using OR operators. The value of query condition follows the format of id eq "{itemId}". Query condition on any item field other than id is not supported. Any operator other than eq (Equals) in the query condition is not supported.

  Example: id eq "COREBE1BDF66159849B790CC9ACE49BD2199" OR id eq "CONT22AA154CDD884D81A3678E1BD37333B7"

{
    "type":"object",
    "properties":{
        "q":{
            "type":"string",
            "example":"id eq \"COREBE1BDF66159849B790CC9ACE49BD2199\" OR id eq \"CONT22AA154CDD884D81A3678E1BD37333B7\"",
            "description":"This parameter accepts a query expression condition that matches the field values. Many such query conditions can be joined using OR operators. The value of query condition follows the format of <b><i>id eq \"{itemId}\"</i></b>. Query condition on any item field other than id is not supported. Any operator other than eq (Equals) in the query condition is not supported."
        },
        "operations":{
            "description":"Operations to perform. It is a required property in the post request.",
            "$ref":"#/definitions/BulkItemsOperationsActions"
        },
        "links":{
            "type":"array",
            "description":"Links of the bulk items operations resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item Bulk Operations"
}

• Array of: object ResultHTTPHeader
  ResultHTTPHeader

{
    "type":"array",
    "description":"List of the HTTP headers of the response to the original async request",
    "items":{
        "$ref":"#/definitions/ResultHTTPHeader"
    }
}

• code(optional): integer(int32)
  HTTP response status code
• reason(optional): string
  HTTP response reason phrase

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP response status code"
        },
        "reason":{
            "type":"string",
            "description":"HTTP response reason phrase"
        }
    },
    "description":"ResultHTTPStatus"
}

• Array of: object Link
  Link of the resource.

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

• addCategories(optional): object CategoryIds
  CategoryIds
• addChannels(optional): object ChannelIds
  ChannelIds
• addCollections(optional): object CollectionIds
  CollectionIds
• addTags(optional): object Tags
  Tags.
• addToRepository(optional): object AddToRepository
  AddToRepository
• approve(optional): object Approve
  Approve
• changeTypeByItems(optional): object ChangeTypeByItems
  Change asset type for assets
• completeWorkflowInstance(optional): object BooleanOperation
  BooleanOperation
• convertToAdvancedVideo(optional): object ConvertToAdvancedVideo
  ConvertToAdvancedVideo
• copy(optional): object CopyItems
  CopyItems
• deleteItems(optional): object DeleteItems
  DeleteItems
• executeScheduledTask(optional): object ExecuteScheduledTask
  ExecuteScheduledTask
• generateRenditions(optional): object GenerateRenditions
  Generate renditions for content types
• lock(optional): object LockAssets
  LockAssets
• makeTranslatable(optional): object BooleanOperation
  BooleanOperation
• publish(optional): object Publish
  Publish
• rejectSuggestedCategories(optional): object CategoryIds
  CategoryIds
• removeCategories(optional): object CategoryIds
  CategoryIds
• removeChannels(optional): object ChannelIds
  ChannelIds
• removeCollections(optional): object CollectionIds
  CollectionIds
• removeTags(optional): object Tags
  Tags.
• rollback(optional): object Rollback
  Rollback
• setAsTranslated(optional): object BooleanOperation
  BooleanOperation
• submitForApproval(optional): object BooleanOperation
  BooleanOperation
• submitToWorkflow(optional): object submitToWorkflow
  submitToWorkflow
• unlock(optional): object UnlockAssets
  UnlockAssets
• unpublish(optional): object Unpublish
  Unpublish
• validatePublish(optional): object ValidatePublish
  ValidatePublish
• workflowAction(optional): object WorkflowActionBean
  WorkflowActionBean

{
    "type":"object",
    "properties":{
        "addCollections":{
            "description":"Add items to collections.",
            "$ref":"#/definitions/CollectionIds"
        },
        "removeCollections":{
            "description":"Remove items from collections.",
            "$ref":"#/definitions/CollectionIds"
        },
        "addChannels":{
            "description":"Add channels to items.",
            "$ref":"#/definitions/ChannelIds"
        },
        "removeChannels":{
            "description":"Remove channels from items.",
            "$ref":"#/definitions/ChannelIds"
        },
        "addCategories":{
            "description":"add categories",
            "$ref":"#/definitions/CategoryIds"
        },
        "removeCategories":{
            "description":"remove categories",
            "$ref":"#/definitions/CategoryIds"
        },
        "rejectSuggestedCategories":{
            "description":"reject Suggested Categories",
            "$ref":"#/definitions/CategoryIds"
        },
        "makeTranslatable":{
            "description":"Make items as translatable/non-translatable.",
            "$ref":"#/definitions/BooleanOperation"
        },
        "setAsTranslated":{
            "description":"Set items as translated/non-translated.",
            "$ref":"#/definitions/BooleanOperation"
        },
        "submitForApproval":{
            "description":"Submit items for approval.",
            "$ref":"#/definitions/BooleanOperation"
        },
        "submitToWorkflow":{
            "description":"Submit items for approval to a Workflow.",
            "$ref":"#/definitions/submitToWorkflow"
        },
        "approve":{
            "description":"Approve/Reject items.",
            "$ref":"#/definitions/Approve"
        },
        "workflowAction":{
            "description":"Action to be taken on the items",
            "$ref":"#/definitions/WorkflowActionBean"
        },
        "completeWorkflowInstance":{
            "description":"Complete Workflow Instance Associated with the items.",
            "$ref":"#/definitions/BooleanOperation"
        },
        "deleteItems":{
            "description":"Delete item in bulk along with its existing translations. Only one item to be passed in q param.",
            "$ref":"#/definitions/DeleteItems"
        },
        "validatePublish":{
            "description":"Validate items for publish.",
            "$ref":"#/definitions/ValidatePublish"
        },
        "publish":{
            "description":"Publish items. It is a persisted operation and only asynchronous interaction is supported. It cannot be given with any other operation.",
            "$ref":"#/definitions/Publish"
        },
        "unpublish":{
            "description":"Unpublish items. It is a persisted operation and only asynchronous interaction is supported. It cannot be given with any other operation.",
            "$ref":"#/definitions/Unpublish"
        },
        "addToRepository":{
            "description":"Add Digital Assets to repository",
            "$ref":"#/definitions/AddToRepository"
        },
        "copy":{
            "description":"Copy items from one repository to another",
            "$ref":"#/definitions/CopyItems"
        },
        "rollback":{
            "description":"Roll back items to given date or versions",
            "$ref":"#/definitions/Rollback"
        },
        "executeScheduledTask":{
            "description":"Execute a scheduled task. It is a persisted operation and only asynchronous interaction is supported. It cannot be given with any other operation.",
            "$ref":"#/definitions/ExecuteScheduledTask"
        },
        "convertToAdvancedVideo":{
            "description":"Convert standard video assets to advanced video assets",
            "$ref":"#/definitions/ConvertToAdvancedVideo"
        },
        "lock":{
            "description":"Lock items in a repository",
            "$ref":"#/definitions/LockAssets"
        },
        "unlock":{
            "description":"Unlock items in a repository",
            "$ref":"#/definitions/UnlockAssets"
        },
        "generateRenditions":{
            "description":"Generate renditions for content types",
            "$ref":"#/definitions/GenerateRenditions"
        },
        "changeTypeByItems":{
            "description":"Change type for items",
            "$ref":"#/definitions/ChangeTypeByItems"
        },
        "addTags":{
            "description":"Add tags to items",
            "$ref":"#/definitions/Tags"
        },
        "removeTags":{
            "description":"Remove tags from items",
            "$ref":"#/definitions/Tags"
        }
    },
    "description":"Operations that can be performed. Currently only one operation at a time is supported."
}

• categories(optional): array categories
  categories
• items(optional): array items
• taxonomyId(optional): object TaxonomyId
  TaxonomyId

{
    "type":"object",
    "properties":{
        "categories":{
            "type":"array",
            "description":"categories",
            "items":{
                "$ref":"#/definitions/CategoryId"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "taxonomyId":{
            "$ref":"#/definitions/TaxonomyId"
        }
    },
    "description":"CategoryIds"
}

• channels(optional): array channels
  channels
• items(optional): array items

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

• collections(optional): array collections
  collections
• items(optional): array items

{
    "type":"object",
    "properties":{
        "collections":{
            "type":"array",
            "description":"collections",
            "items":{
                "$ref":"#/definitions/CollectionId"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        }
    },
    "description":"CollectionIds"
}

• items(optional): array items
• tags(optional): array tags
  Tags of the item.

{
    "type":"object",
    "properties":{
        "tags":{
            "type":"array",
            "description":"Tags of the item.",
            "items":{
                "$ref":"#/definitions/Tag"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        }
    },
    "description":"Tags."
}

• channels(optional): array channels
  Channels
• collections(optional): array collections
  Collections
• connectorId(optional): string
  connectorId
• externalIds(optional): array externalIds
  externalIds
• externalItems(optional): array externalItems
  externalItems
• failedChannels(optional): object FailedChannels
• failedCollections(optional): object FailedCollections
• failedExternalIds(optional): object FailedExternalIds
• failedTags(optional): object FailedTags
• failedTaxonomies(optional): object FailedTaxonomyCategories
• items(optional): array items
• repositoryId(optional): string
  repositoryId
• storageProvider(optional): string
  Allowed Values: [ "docs", "kaltura" ]

  source storageProvider of the externalIds
• tags(optional): array tags
  Add tags to items
• taxonomies(optional): array taxonomies
  taxonomies

{
    "type":"object",
    "properties":{
        "storageProvider":{
            "type":"string",
            "description":"source storageProvider of the externalIds",
            "enum":[
                "docs",
                "kaltura"
            ]
        },
        "repositoryId":{
            "type":"string",
            "description":"repositoryId"
        },
        "externalItems":{
            "type":"array",
            "description":"externalItems",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "externalIds":{
            "type":"array",
            "description":"externalIds",
            "items":{
                "type":"string"
            }
        },
        "channels":{
            "type":"array",
            "description":"Channels",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "collections":{
            "type":"array",
            "description":"Collections",
            "items":{
                "$ref":"#/definitions/CollectionId"
            }
        },
        "taxonomies":{
            "type":"array",
            "description":"taxonomies",
            "items":{
                "$ref":"#/definitions/TaxonomyCategories"
            }
        },
        "tags":{
            "type":"array",
            "description":"Add tags to items",
            "items":{
                "$ref":"#/definitions/Tag"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "failedExternalIds":{
            "description":"externalIds on which the action failed",
            "$ref":"#/definitions/FailedExternalIds"
        },
        "failedChannels":{
            "description":"Channels to which items are not added",
            "$ref":"#/definitions/FailedChannels"
        },
        "failedTaxonomies":{
            "description":"List of taxonomies and categories not assigned to the requested items",
            "$ref":"#/definitions/FailedTaxonomyCategories"
        },
        "connectorId":{
            "type":"string",
            "description":"connectorId"
        },
        "failedTags":{
            "description":"Tags which are not added to items",
            "$ref":"#/definitions/FailedTags"
        },
        "failedCollections":{
            "description":"Collections to which items are not added",
            "$ref":"#/definitions/FailedCollections"
        }
    },
    "description":"AddToRepository"
}

• failedItems(optional): array failedItems
  items on which the action failed
• isExtendedWorkflow(optional): boolean
  If workflow is extended or not after approve in OIC
• items(optional): array items
• value(optional): boolean
  value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"boolean",
            "description":"value"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "isExtendedWorkflow":{
            "type":"boolean",
            "description":"If workflow is extended or not after approve in OIC"
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"Approve"
}

• failedItems(optional): array failedItems
  conversion failed items list
• items(optional): array items
  conversion completed items list
• setItems(optional): array setItems
  List of items to be converted

{
    "type":"object",
    "properties":{
        "setItems":{
            "type":"array",
            "description":"List of items to be converted",
            "items":{
                "$ref":"#/definitions/ChangeTypeItemBean"
            }
        },
        "items":{
            "type":"array",
            "description":"conversion completed items list",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"conversion failed items list",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"Change asset type for assets"
}

• failedItems(optional): array failedItems
  items on which the action failed
• items(optional): array items
• value(optional): boolean
  value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"boolean",
            "description":"value"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"BooleanOperation"
}

• failedItems(optional): array failedItems
  items on which the action failed
• items(optional): array items
  items on which the action is applied
• provider(optional): object Provider
  Provider

{
    "type":"object",
    "properties":{
        "provider":{
            "description":"provider",
            "$ref":"#/definitions/Provider"
        },
        "items":{
            "type":"array",
            "description":"items on which the action is applied",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"ConvertToAdvancedVideo"
}

• channels(optional): object ChannelsInCopy
• collections(optional): object CollectionsInCopy
• failedItems(optional): array failedItems
  items on which the action failed
• items(optional): array items
• message(optional): array message
  message
• targetRepository(optional): object RepositoryId
  RepositoryId

{
    "type":"object",
    "properties":{
        "targetRepository":{
            "description":"target repository id",
            "$ref":"#/definitions/RepositoryId"
        },
        "collections":{
            "description":"Whether the collections itself to be copied or not",
            "$ref":"#/definitions/CollectionsInCopy"
        },
        "channels":{
            "description":"Whether items to be targeted to channels or not",
            "$ref":"#/definitions/ChannelsInCopy"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CopiedItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        },
        "message":{
            "type":"array",
            "description":"message",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"CopyItems"
}

• failedItems(optional): array failedItems
  items on which the action failed
• items(optional): array items
• value(optional): boolean
  value

{
    "type":"object",
    "properties":{
        "value":{
            "type":"boolean",
            "description":"value"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"DeleteItems"
}

• taskId(optional): string
  The group id that is going to be executed
• taskType(optional): string
  The type of the task

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"string",
            "description":"The group id that is going to be executed"
        },
        "taskType":{
            "type":"string",
            "description":"The type of the task"
        }
    },
    "description":"ExecuteScheduledTask"
}

• compilationStatus(optional): object CompilationJobStatus
  Compilation Job Status
• items(optional): array items
• jobId(optional): string
• publishJobId(optional): string
• repositories(optional): array repositories

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "compilationStatus":{
            "$ref":"#/definitions/CompilationJobStatus"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentItemRenditions"
            }
        },
        "publishJobId":{
            "type":"string"
        },
        "repositories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RepositoryId"
            }
        }
    },
    "description":"Generate renditions for content types"
}

• dependencies(optional): boolean
  dependencies to be included or not
• failedItems(optional): array failedItems
  items on which the action failed
• items(optional): array items
  items on which the action is applied
• translations(optional): object LockTranslations

{
    "type":"object",
    "properties":{
        "dependencies":{
            "type":"boolean",
            "description":"dependencies to be included or not"
        },
        "translations":{
            "description":"translations to be included",
            "$ref":"#/definitions/LockTranslations"
        },
        "items":{
            "type":"array",
            "description":"items on which the action is applied",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"LockAssets"
}

• channels(optional): array channels
  List of publish channels. If channels is not empty, items in the q are published to the given channels. If the channels is empty, all the items as per q are published to their respective targeted channels.
• ids(optional): array ids
  links of the detailed published item ids.
• ignoredItems(optional): array ignoredItems
• items(optional): array items
• itemVersions(optional): object itemVersions
  Additional Properties Allowed: additionalProperties
• options(optional): object PublishOptions
• validation(optional): object PublishValidation
  PublishValidation

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "description":"List of publish channels. If channels is not empty, items in the q are published to the given channels. If the channels is empty, all the items as per q are published to their respective targeted channels.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "validation":{
            "$ref":"#/definitions/PublishValidation"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "itemVersions":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "ignoredItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IgnoredItemId"
            }
        },
        "options":{
            "$ref":"#/definitions/PublishOptions"
        },
        "ids":{
            "type":"array",
            "description":"links of the detailed published item ids.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Publish"
}

• items(optional): array items
• toDate(optional): string

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemRollBackBean"
            }
        },
        "toDate":{
            "type":"string"
        }
    },
    "description":"Rollback"
}

• autoSubmit(optional): boolean
• failedItems(optional): array failedItems
  items on which the action failed
• id(optional): string
  Workflow to which items are submitted for approval
• includeDependencies(optional): boolean
  If dependencies are included or not during submission of items to workflow.
• items(optional): array items
• itemWorkflows(optional): array itemWorkflows
  Items to be submitted to the specified workflows

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Workflow to which items are submitted for approval"
        },
        "itemWorkflows":{
            "type":"array",
            "description":"Items to be submitted to the specified workflows",
            "items":{
                "$ref":"#/definitions/ItemWorkflows"
            }
        },
        "includeDependencies":{
            "type":"boolean",
            "description":"If dependencies are included or not during submission of items to workflow."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkflowItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        },
        "autoSubmit":{
            "type":"boolean"
        }
    },
    "description":"submitToWorkflow"
}

• dependencies(optional): boolean
  dependencies to be included or not
• failedItems(optional): array failedItems
  items on which the action failed
• items(optional): array items
  items on which the action is applied
• translations(optional): object UnlockTranslations

{
    "type":"object",
    "properties":{
        "dependencies":{
            "type":"boolean",
            "description":"dependencies to be included or not"
        },
        "translations":{
            "description":"translations to be included",
            "$ref":"#/definitions/UnlockTranslations"
        },
        "items":{
            "type":"array",
            "description":"items on which the action is applied",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"UnlockAssets"
}

• allowUnpublishFromActiveSite(optional): boolean
  whether to allow active site items to be unpublished.(defaults to false)
• channels(optional): array channels
  List of unpublish channels. If channels is not empty, items in the q are unpublished to the given channels. If the channels is empty, all the items as per q are unpublished to their respective targeted channels.
• ids(optional): array ids
  links of the detailed unpublished item ids.
• items(optional): array items

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "description":"List of unpublish channels. If channels is not empty, items in the q are unpublished to the given channels. If the channels is empty, all the items as per q are unpublished to their respective targeted channels.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "allowUnpublishFromActiveSite":{
            "type":"boolean",
            "description":"whether to allow active site items to be unpublished.(defaults to false)"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "ids":{
            "type":"array",
            "description":"links of the detailed unpublished item ids.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Unpublish"
}

• channels(optional): array channels
  List of channels to be validated for publish. If channels is not empty, items in the q are validated for publish against the given channels. If the channels is empty, all the items as per q are validated for publish against their respective targeted channels.
• missingItems(optional): array missingItems
• validation(optional): object PublishValidation
  PublishValidation
• validationResults(optional): array validationResults

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "description":"List of channels to be validated for publish. If channels is not empty, items in the q are validated for publish against the given channels. If the channels is empty, all the items as per q are validated for publish against their respective targeted channels.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "validation":{
            "$ref":"#/definitions/PublishValidation"
        },
        "validationResults":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishValidationResult"
            }
        },
        "missingItems":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"ValidatePublish"
}

• comments(optional): string
  comments related to the action taken
• failedItems(optional): array failedItems
  items on which the action failed
• items(optional): array items
• tasks(optional): array tasks
  Item to tasks mapping
• value(optional): string
  action applied on the items

{
    "type":"object",
    "properties":{
        "tasks":{
            "type":"array",
            "description":"Item to tasks mapping",
            "items":{
                "$ref":"#/definitions/TaskItemMapping"
            }
        },
        "value":{
            "type":"string",
            "description":"action applied on the items"
        },
        "comments":{
            "type":"string",
            "description":"comments related to the action taken"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "failedItems":{
            "type":"array",
            "description":"items on which the action failed",
            "items":{
                "$ref":"#/definitions/FailedItemId"
            }
        }
    },
    "description":"WorkflowActionBean"
}

• Array of: object CategoryId

{
    "type":"array",
    "description":"categories",
    "items":{
        "$ref":"#/definitions/CategoryId"
    }
}

• Array of: object ItemId

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

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

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

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• name(optional): string
  name of the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

• Array of: object Link
  Link of the resource.

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

• Array of: object ChannelId
  ChannelId

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

• Array of: object ItemId

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• Array of: object CollectionId
  CollectionId

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

• Array of: object ItemId

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

• id(optional): string

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

• Array of: object ItemId

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

• Array of: object Tag
  Tag.

{
    "type":"array",
    "description":"Tags of the item.",
    "items":{
        "$ref":"#/definitions/Tag"
    }
}

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

• Array of: object Link
  Link of the resource.

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

• Array of: object ChannelId
  ChannelId

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

• Array of: object CollectionId
  CollectionId

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

• Array of: string

{
    "type":"array",
    "description":"externalIds",
    "items":{
        "type":"string"
    }
}

• Array of: object Item
  Discriminator: typeCategory

  Item

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

• channels(optional): array channels
• items(optional): object items
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

• collections(optional): array collections
• items(optional): object items
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "collections":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CollectionId"
            }
        },
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

• items(optional): object items
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

• items(optional): object items
  Additional Properties Allowed: additionalProperties
• tags(optional): array tags

{
    "type":"object",
    "properties":{
        "tags":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Tag"
            }
        },
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

• items(optional): object items
  Additional Properties Allowed: additionalProperties

  Items that failed to be categorizes.
• taxonomies(optional): array taxonomies
  List of taxonomies and categories not assigned to the requested items

{
    "type":"object",
    "properties":{
        "taxonomies":{
            "type":"array",
            "description":"List of taxonomies and categories not assigned to the requested items",
            "items":{
                "$ref":"#/definitions/TaxonomyCategories"
            }
        },
        "items":{
            "type":"object",
            "description":"Items that failed to be categorizes.",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

• Array of: object Item
  Discriminator: typeCategory

  Item

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

• Array of: object Tag
  Tag.

{
    "type":"array",
    "description":"Add tags to items",
    "items":{
        "$ref":"#/definitions/Tag"
    }
}

• Array of: object TaxonomyCategories

{
    "type":"array",
    "description":"taxonomies",
    "items":{
        "$ref":"#/definitions/TaxonomyCategories"
    }
}

• 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"
}

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

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

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

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

• 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"
}

• 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"
    }
}

• Array of: object Link
  Link of the resource.

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

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

• 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"
}

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

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

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

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

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

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

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

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

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

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

• 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"
}

• 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"
}

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

• Array of: object ChangesInfo
  ChangesInfo

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• Array of: object ChannelId
  ChannelId

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

• Array of: object Link
  Link of the resource.

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

• Array of: object CollectionId
  CollectionId

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object AggregationResult

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

• Array of: object ItemExtractedExifBean
  ItemExtractedExifBean

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

• Array of: object Link
  Link of the resource.

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

• Array of: string

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

• name(optional): string
  Read Only: true

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• Array of: object AggregationResult

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

• Array of: object Videotranscript
  Video transcript

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

• Array of: object Link
  Link of the resource.

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

• Array of: string

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• Array of: object Action
  Action

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object PublishInfo
  PublishInfo

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• Array of: object References
  References

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

• 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"
}

• Array of: object ReferencedBySites
  ReferencedBySites

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

• Array of: object References
  References

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object SuggestedTaxonomyInfo
  SuggestedTaxonomyInfo

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object ItemSuggestedCategoryInfo

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

• Array of: object Link
  Link of the resource.

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

• 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"
            }
        }
    }
}

• Array of: object Link
  Link of the resource.

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

• Array of: object CategoryNodeBean

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

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

• Array of: object Tag
  Tag.

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

• Array of: object Link
  Link of the resource.

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

• Array of: object TaxonomyInfo
  TaxonomyInfo

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object ItemCategoryInfo

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

• Array of: object Link
  Link of the resource.

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

• 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"
            }
        }
    }
}

• Array of: object Link
  Link of the resource.

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

• Array of: object CategoryNodeBean

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

• Array of: object VariationsInfo
  Variations Info.

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

• Array of: object Link
  Link of the resource.

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

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

• Array of: object Language
  LanguageItem

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• Array of: object Link
  Link of the resource.

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

• Array of: object VersionInfo
  VersionInfo

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

• Array of: object Link
  Link of the resource.

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

• 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"
}

• adaptiveStreams(optional): object AdaptiveStreamsBean
  AdaptiveStreamsBean

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

• 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"
}

• frame(optional): object StripFrameBean
  StripFrameBean

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

• 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"
}

• 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"
}

• Array of: object AggregationResult

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

• Array of: object WorkflowInfo
  WorkflowInfo.

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

• Array of: object Link
  Link of the resource.

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

• Array of: string

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

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

• Array of: object Link
  Link of the resource.

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

• Array of: object WorkflowInfo
  WorkflowInfo.

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

• Array of: object Link
  Link of the resource.

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

• Array of: object ChannelId
  ChannelId

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

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

• Array of: object CollectionId
  CollectionId

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

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

• Array of: object Tag
  Tag.

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

• string

{
    "type":"object",
    "description":"Items that failed to be categorizes.",
    "additionalProperties":{
        "type":"string"
    }
}

• Array of: object TaxonomyCategories

{
    "type":"array",
    "description":"List of taxonomies and categories not assigned to the requested items",
    "items":{
        "$ref":"#/definitions/TaxonomyCategories"
    }
}

• categories(optional): array categories
  Categories to be assigned
• id(optional): string
  The id of the Taxonomy.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Taxonomy."
        },
        "categories":{
            "type":"array",
            "description":"Categories to be assigned",
            "items":{
                "$ref":"#/definitions/CategoryId"
            }
        }
    }
}

• Array of: object CategoryId

{
    "type":"array",
    "description":"Categories to be assigned",
    "items":{
        "$ref":"#/definitions/CategoryId"
    }
}

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

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

• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• message(optional): string
  failed item message.
• name(optional): string
  name of the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "message":{
            "type":"string",
            "description":"failed item message."
        }
    }
}

• Array of: object Link
  Link of the resource.

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

• Array of: object FailedItemId

{
    "type":"array",
    "description":"conversion failed items list",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

{
    "type":"array",
    "description":"conversion completed items list",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

• Array of: object ChangeTypeItemBean
  set information for change type

{
    "type":"array",
    "description":"List of items to be converted",
    "items":{
        "$ref":"#/definitions/ChangeTypeItemBean"
    }
}

• fields(optional): object fields
  Additional Properties Allowed: additionalProperties

  fields to be added as part of type conversion
• id(optional): string
  id of the item
• type(optional): string
  target type name

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item"
        },
        "type":{
            "type":"string",
            "description":"target type name"
        },
        "fields":{
            "type":"object",
            "description":"fields to be added as part of type conversion",
            "additionalProperties":{
                "type":"object"
            }
        }
    },
    "description":"set information for change type"
}

• object additionalProperties

{
    "type":"object",
    "description":"fields to be added as part of type conversion",
    "additionalProperties":{
        "type":"object"
    }
}

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

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

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

{
    "type":"array",
    "description":"items on which the action is applied",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

• name: string
  provider name

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"provider name"
        }
    },
    "description":"Provider"
}

• targetToChannel(optional): array targetToChannel
  targetToChannel

{
    "type":"object",
    "properties":{
        "targetToChannel":{
            "type":"array",
            "description":"targetToChannel",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        }
    }
}

• collectionName(optional): string
  Name of the collection to be created

{
    "type":"object",
    "properties":{
        "collectionName":{
            "type":"string",
            "description":"Name of the collection to be created"
        }
    }
}

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object CopiedItemId

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

• Array of: string

{
    "type":"array",
    "description":"message",
    "items":{
        "type":"string"
    }
}

• id(optional): string
• name(optional): string
  Name of the repository. It is a required property in the get response and post/put request.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the repository. It is a required property in the get response and post/put request."
        }
    },
    "description":"RepositoryId"
}

• Array of: object ChannelId
  ChannelId

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

• id(optional): string
  id of the copied item.
• links(optional): array links
  links of the item resource
• name(optional): string
  name of the item.
• originalId(optional): string
  id of the original item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the copied item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "originalId":{
            "type":"string",
            "description":"id of the original item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

• Array of: object Link
  Link of the resource.

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

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

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

• compiledAt(optional): string
  Date and time of this status message in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.
• compiledTime(optional): string(date-time)
• jobId(optional): string
  Content item rendition compilation job id.
• progress(optional): number(double)
  Compilation job status progress percentage.
• status(optional): string
  Compilation job status.

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Content item rendition compilation job id."
        },
        "status":{
            "type":"string",
            "description":"Compilation job status."
        },
        "progress":{
            "type":"number",
            "format":"double",
            "description":"Compilation job status progress percentage."
        },
        "compiledAt":{
            "type":"string",
            "description":"Date and time of this status message in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format."
        },
        "compiledTime":{
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Compilation Job Status"
}

• Array of: object ContentItemRenditions
  Content Rendition of a item

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

• Array of: object RepositoryId
  RepositoryId

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

• id(optional): string
• renditionFormats(optional): array renditionFormats

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "renditionFormats":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContentRenditionFormat"
            }
        }
    },
    "description":"Content Rendition of a item"
}

• Array of: object ContentRenditionFormat
  Content Rendition Format

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

• apiName(optional): string
• format(optional): string
• status(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "apiName":{
            "type":"string"
        },
        "format":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "description":"Content Rendition Format"
}

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

{
    "type":"array",
    "description":"items on which the action is applied",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

• lockAll(optional): boolean
  lock all the translations in a set or a specific translation

{
    "type":"object",
    "properties":{
        "lockAll":{
            "type":"boolean",
            "description":"lock all the translations in a set or a specific translation"
        }
    }
}

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of publish channels. If channels is not empty, items in the q are published to the given channels. If the channels is empty, all the items as per q are published to their respective targeted channels.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the detailed published item ids.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

• Array of: object IgnoredItemId

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

• Array of: object ItemId

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

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

• unlockAfterPublish(optional): boolean
  Unlock the items owned by user after successful publish

{
    "type":"object",
    "properties":{
        "unlockAfterPublish":{
            "type":"boolean",
            "description":"Unlock the items owned by user after successful publish"
        }
    }
}

• languageOnly(optional): boolean
• testOnly(optional): boolean
• verbosity(optional): string
  Allowed Values: [ "none", "terse", "normal", "verbose" ]

{
    "type":"object",
    "properties":{
        "verbosity":{
            "type":"string",
            "enum":[
                "none",
                "terse",
                "normal",
                "verbose"
            ]
        },
        "testOnly":{
            "type":"boolean"
        },
        "languageOnly":{
            "type":"boolean"
        }
    },
    "description":"PublishValidation"
}

• channels(optional): array channels
• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• message(optional): string
  ignored item message.
• name(optional): string
  name of the item.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "message":{
            "type":"string",
            "description":"ignored item message."
        },
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        }
    }
}

• Array of: object ChannelId
  ChannelId

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

• Array of: object Link
  Link of the resource.

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

• Array of: object ItemRollBackBean

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

• id(optional): string
• toVersion(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "toVersion":{
            "type":"string"
        }
    }
}

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object WorkflowItemId

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

• Array of: object ItemWorkflows
  ItemWorkflows

{
    "type":"array",
    "description":"Items to be submitted to the specified workflows",
    "items":{
        "$ref":"#/definitions/ItemWorkflows"
    }
}

• id(optional): string
  id of the item.
• links(optional): array links
  links of the item resource
• name(optional): string
  name of the item.
• workflowInstanceId(optional): string
  workflow Instance Id to which an item is submitted for review.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "workflowInstanceId":{
            "type":"string",
            "description":"workflow Instance Id to which an item is submitted for review."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

• Array of: object Link
  Link of the resource.

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

• itemId(optional): string
  Item id
• workflowId(optional): string
  Workflow id

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "description":"Item id"
        },
        "workflowId":{
            "type":"string",
            "description":"Workflow id"
        }
    },
    "description":"ItemWorkflows"
}

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

{
    "type":"array",
    "description":"items on which the action is applied",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

• unlockAll(optional): boolean
  Unlock all the translations in a set or a specific translation

{
    "type":"object",
    "properties":{
        "unlockAll":{
            "type":"boolean",
            "description":"Unlock all the translations in a set or a specific translation"
        }
    }
}

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of unpublish channels. If channels is not empty, items in the q are unpublished to the given channels. If the channels is empty, all the items as per q are unpublished to their respective targeted channels.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"links of the detailed unpublished item ids.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

• Array of: object ItemId

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

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of channels to be validated for publish. If channels is not empty, items in the q are validated for publish against the given channels. If the channels is empty, all the items as per q are validated for publish against their respective targeted channels.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: object PublishValidationResult
  Publish validation result for publishing items to channels

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

• error(optional): string
• policyValidation(optional): object PolicyValidationResult
  PolicyValidationResult

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string"
        },
        "policyValidation":{
            "$ref":"#/definitions/PolicyValidationResult"
        }
    },
    "description":"Publish validation result for publishing items to channels"
}

• ChannelItemDocIds(optional): object TableStringStringString
• channels(optional): array channels
• error(optional): string
• items(optional): array items
• processingTime(optional): integer(int64)
• request(optional): object Request
• valid(optional): boolean
• variationSets(optional): array variationSets

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelReference"
            }
        },
        "variationSets":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemVariationSetSummary"
            }
        },
        "ChannelItemDocIds":{
            "description":"Table",
            "$ref":"#/definitions/TableStringStringString"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemSummary"
            }
        },
        "request":{
            "$ref":"#/definitions/Request"
        },
        "processingTime":{
            "type":"integer",
            "format":"int64"
        },
        "valid":{
            "type":"boolean"
        },
        "error":{
            "type":"string"
        }
    },
    "description":"PolicyValidationResult"
}

• empty(optional): boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    }
}

• Array of: object ChannelReference

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

• Array of: object ItemSummary

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

• channels(optional): array channels
• ids(optional): array ids
• validation(optional): object PublishValidation
  PublishValidation

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "ids":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "validation":{
            "$ref":"#/definitions/PublishValidation"
        }
    }
}

• Array of: object ItemVariationSetSummary

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

• error(optional): string
• id(optional): string
• name(optional): string
• publishableItems(optional): array publishableItems
• publishPolicy(optional): object PolicyReference
• variationPolicies(optional): array variationPolicies

{
    "type":"object",
    "properties":{
        "variationPolicies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyReference"
            }
        },
        "publishPolicy":{
            "$ref":"#/definitions/PolicyReference"
        },
        "publishableItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "error":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

• Array of: object PublishItemId

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

• error(optional): string
• id(optional): string
• name(optional): string
• varType(optional): string

{
    "type":"object",
    "properties":{
        "varType":{
            "type":"string"
        },
        "error":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

• Array of: object PolicyReference

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

• id(optional): string

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

• dependencies(optional): array dependencies
• dependencyStatus(optional): string
• fileId(optional): string
• id(optional): string
• language(optional): string
• name(optional): string
• optionalDependency(optional): string
• primaryChannelId(optional): string
• type(optional): string
• validations(optional): array validations
• version(optional): string

{
    "type":"object",
    "properties":{
        "optionalDependency":{
            "type":"string"
        },
        "dependencies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "fileId":{
            "type":"string"
        },
        "primaryChannelId":{
            "type":"string"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelValidation"
            }
        },
        "dependencyStatus":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "language":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

• Array of: object PublishItemId

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

• Array of: object ChannelValidation

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

• alreadyPublished(optional): boolean
• blocking(optional): boolean
• channelId(optional): string
• policyStatus(optional): string
• publishable(optional): boolean
• results(optional): array results

{
    "type":"object",
    "properties":{
        "publishable":{
            "type":"boolean"
        },
        "channelId":{
            "type":"string"
        },
        "alreadyPublished":{
            "type":"boolean"
        },
        "blocking":{
            "type":"boolean"
        },
        "policyStatus":{
            "type":"string"
        },
        "results":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyRuleResult"
            }
        }
    }
}

• Array of: object PolicyRuleResult
  PolicyRuleResult

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

• code(optional): string
• fileId(optional): string
• itemId(optional): string
• message(optional): string
• name(optional): string
• pass(optional): string
• policyId(optional): string
• rule(optional): string
• setId(optional): string
• valid(optional): boolean
• value(optional): string

{
    "type":"object",
    "properties":{
        "policyId":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "rule":{
            "type":"string"
        },
        "pass":{
            "type":"string"
        },
        "itemId":{
            "type":"string"
        },
        "setId":{
            "type":"string"
        },
        "fileId":{
            "type":"string"
        },
        "valid":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    },
    "description":"PolicyRuleResult"
}

• Array of: object ChannelId
  ChannelId

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

• Array of: object PublishItemId

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

• id(optional): string
• items(optional): array items
• masterItemId(optional): string
• type(optional): string
• validations(optional): array validations
• varType(optional): string

{
    "type":"object",
    "properties":{
        "varType":{
            "type":"string"
        },
        "masterItemId":{
            "type":"string"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChannelValidation"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PublishItemId"
            }
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

• Array of: object PublishItemId

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

• Array of: object ChannelValidation

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

• Array of: object FailedItemId

{
    "type":"array",
    "description":"items on which the action failed",
    "items":{
        "$ref":"#/definitions/FailedItemId"
    }
}

• Array of: object ItemId

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

• Array of: object TaskItemMapping
  TaskItemMapping

{
    "type":"array",
    "description":"Item to tasks mapping",
    "items":{
        "$ref":"#/definitions/TaskItemMapping"
    }
}

• itemId(optional): string
  id of the item.
• taskId(optional): string
  id of the workflow task.

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "description":"id of the item."
        },
        "taskId":{
            "type":"string",
            "description":"id of the workflow task."
        }
    },
    "description":"TaskItemMapping"
}

• name(optional): string
  HTTP response header name
• value(optional): string
  HTTP response header value

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"HTTP response header name"
        },
        "value":{
            "type":"string",
            "description":"HTTP response header value"
        }
    },
    "description":"ResultHTTPHeader"
}