機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

アイテムの一括操作ステータスの読取り

get

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

アイテムの一括操作ステータスを読み取ります。

リクエスト

パス・パラメータ

• statusId: string
  一括アイテム操作のステータスIdです。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : BulkItemsOperationsStatus

型: object

BulkItemsOperationsStatus

ソースを表示

• completed(optional): boolean
  元のリクエストが完了しているかどうか
• completedPercentage(optional): integer(int32)
  プロセスの完了数を取得し、0から100までの数値。
• endTime(optional): object date
  date
• error(optional): object Error
  エラー
• id(optional): string
  元のリクエストのステータスid。 これはレスポンス取得の必須プロパティです。
• links(optional): array links
  ステータス・リソースのリンク
• message(optional): string
  現在の処理ステータスに関する人間が読むことができるメッセージ
• progress(optional): string
  許容値: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  元のリクエストの現在の進行状況。 これはレスポンス取得の必須プロパティです。
• requestStatus(optional): integer(int32)
  元のリクエストのHTTPステータス・コード。 これはポーリング・リクエストのステータスではありません。 値はリクエストが完了した後にのみ使用できます
• result(optional): object ResultBulkItemsOperations
  結果
• 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"
}

ネストされたスキーマ : date

型: object

date

ソースを表示

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

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

ネストされたスキーマ: Error

型: object

エラー

ソースを表示

• detail(optional): string
  詳細なエラー・メッセージ
• instance(optional): string
  エラーに関する詳細を提供するリンクへのURI。
• o:errorCode(optional): string
  アプリケーション固有のエラー・コード。
• o:errorDetails(optional): object Error
  エラー
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONのパス
• status(optional): integer(int32)
  HTTPステータス・コード。
• title(optional): string
  要約エラー・メッセージ。 これはレスポンス取得の必須プロパティです。
• type(optional): string
  HTTPエラー・コード・ページにリンクします。 これはレスポンス取得の必須プロパティです。

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

ネストされたスキーマ: links

型: array

ステータス・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ResultBulkItemsOperations

型: object

結果

ソースを表示

• body(optional): object BulkItemsOperations
  アイテムの一括操作
• headers(optional): array headers
  元の非同期リクエストへのレスポンスのHTTPヘッダーのリスト
• 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"
}

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

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

ネストされたスキーマ : BulkItemsOperations

型: object

アイテムの一括操作

ソースを表示

• links(optional): array links
  一括アイテム工程リソースのリンク。
• operations(optional): object BulkItemsOperationsActions
  実行可能な操作。 現時点では、一度に1つの操作のみがサポートされています。
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 このような問合せ条件の多くは、OR演算子を使用して結合できます。 問合せ条件の値は、id eq "{itemId}"の形式に従います。 Id以外のアイテム・フィールドに対する問合せ条件はサポートされていません。 問合せ条件がeq (Equals)以外の演算子はサポートされていません。

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

ネストされたスキーマ: headers

型: array

元の非同期リクエストへのレスポンスのHTTPヘッダーのリスト

ソースを表示

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

ネストされたスキーマ : ResultHTTPStatus

型: object

ResultHTTPStatus

ソースを表示

• code(optional): integer(int32)
  HTTPレスポンス・ステータス・コード
• reason(optional): string
  HTTPレスポンス理由フレーズ

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

ネストされたスキーマ: links

型: array

一括アイテム工程リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : BulkItemsOperationsActions

型: object

実行可能な操作。 現時点では、一度に1つの操作のみがサポートされています。

ソースを表示

• addCategories(optional): object CategoryIds
  CategoryIds
• addChannels(optional): object ChannelIds
  ChannelIds
• addCollections(optional): object CollectionIds
  CollectionIds
• addTags(optional): object Tags
  タグ
• addToRepository(optional): object AddToRepository
  AddToRepository
• approve(optional): object Approve
  承認
• changeTypeByItems(optional): object ChangeTypeByItems
  アセットのアセット・タイプの変更
• 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
  コンテンツ・タイプのレンディションの生成
• lock(optional): object LockAssets
  LockAssets
• makeTranslatable(optional): object BooleanOperation
  BooleanOperation
• publish(optional): object 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
  タグ
• 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
  非公開
• 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."
}

ネストされたスキーマ : CategoryIds

型: object

CategoryIds

ソースを表示

• categories(optional): array 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"
}

ネストされたスキーマ : ChannelIds

型: object

ChannelIds

ソースを表示

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

ネストされたスキーマ : CollectionIds

型: object

CollectionIds

ソースを表示

• collections(optional): array 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"
}

ネストされたスキーマ : タグ

型: object

タグ

ソースを表示

• items(optional): array items
• tags(optional): array tags
  アイテムのタグ。

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

ネストされたスキーマ : AddToRepository

型: object

AddToRepository

ソースを表示

• channels(optional): array channels
  チャネル
• collections(optional): array 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
  許容値: [ "docs", "kaltura" ]

  externalIdsのソースstorageProvider
• tags(optional): array tags
  アイテムにタグを追加
• 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"
}

ネストされたスキーマ : 承認

型: object

承認

ソースを表示

• failedItems(optional): array failedItems
  処理が失敗した品目
• isExtendedWorkflow(optional): boolean
  ワークフローが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"
}

ネストされたスキーマ : ChangeTypeByItems

型: object

アセットのアセット・タイプの変更

ソースを表示

• failedItems(optional): array failedItems
  変換失敗アイテム・リスト
• items(optional): array items
  変換完了アイテム・リスト
• setItems(optional): array setItems
  変換するアイテムのリスト

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

ネストされたスキーマ : BooleanOperation

型: object

BooleanOperation

ソースを表示

• failedItems(optional): array failedItems
  処理が失敗した品目
• 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"
}

ネストされたスキーマ : ConvertToAdvancedVideo

型: object

ConvertToAdvancedVideo

ソースを表示

• failedItems(optional): array failedItems
  処理が失敗した品目
• items(optional): array items
  アクションが適用されるアイテム
• provider(optional): object 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"
}

ネストされたスキーマ : CopyItems

型: object

CopyItems

ソースを表示

• channels(optional): object ChannelsInCopy
• collections(optional): object CollectionsInCopy
• failedItems(optional): array failedItems
  処理が失敗した品目
• 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"
}

ネストされたスキーマ : DeleteItems

型: object

DeleteItems

ソースを表示

• failedItems(optional): array failedItems
  処理が失敗した品目
• 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"
}

ネストされたスキーマ : ExecuteScheduledTask

型: object

ExecuteScheduledTask

ソースを表示

• taskId(optional): string
  実行されるグループID
• taskType(optional): string
  タスクのタイプ

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

ネストされたスキーマ : GenerateRenditions

型: object

コンテンツ・タイプのレンディションの生成

ソースを表示

• compilationStatus(optional): object CompilationJobStatus
  コンパイル・ジョブ・ステータス
• 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"
}

ネストされたスキーマ : LockAssets

型: object

LockAssets

ソースを表示

• dependencies(optional): boolean
  含めるかどうか
• failedItems(optional): array failedItems
  処理が失敗した品目
• items(optional): array items
  アクションが適用されるアイテム
• 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"
}

ネストされたスキーマ : 公開

型: object

パブリッシュ

ソースを表示

• channels(optional): array channels
  公開チャネルのリスト。 チャネルが空でない場合、q内のアイテムは指定されたチャネルにパブリッシュされます。 チャネルが空の場合、qに従ってすべてのアイテムがターゲット対象の各チャネルに公開されます。
• ids(optional): array ids
  詳細な公開済アイテムidのリンク。
• ignoredItems(optional): array ignoredItems
• items(optional): array items
• itemVersions(optional): object itemVersions
  許可される追加のプロパティ: 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"
}

ネストされたスキーマ : ロールバック

型: object

Rollback

ソースを表示

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

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

ネストされたスキーマ : submitToWorkflow

型: object

submitToWorkflow

ソースを表示

• autoSubmit(optional): boolean
• failedItems(optional): array failedItems
  処理が失敗した品目
• id(optional): string
  アイテムが承認のために送信されるワークフロー
• includeDependencies(optional): boolean
  ワークフローへのアイテムの発行中に依存関係が含まれている場合。
• items(optional): array items
• itemWorkflows(optional): array itemWorkflows
  指定されたワークフローに送信するアイテム

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

ネストされたスキーマ : UnlockAssets

型: object

UnlockAssets

ソースを表示

• dependencies(optional): boolean
  含めるかどうか
• failedItems(optional): array failedItems
  処理が失敗した品目
• items(optional): array items
  アクションが適用されるアイテム
• 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"
}

ネストされたスキーマ : 非公開

型: object

非公開

ソースを表示

• allowUnpublishFromActiveSite(optional): boolean
  アクティブなサイト・アイテムをunpublished.(defaults to false)にするかどうか。
• channels(optional): array channels
  公開取消チャネルのリスト。 チャネルが空でない場合、q内のアイテムは指定されたチャネルに対する公開が取り消されます。 チャネルが空の場合、q当たりのすべてのアイテムは、ターゲット対象の各チャネルに対して非公開になります。
• ids(optional): array ids
  詳細な未公開アイテムidのリンク。
• 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"
}

ネストされたスキーマ : ValidatePublish

型: object

ValidatePublish

ソースを表示

• channels(optional): array channels
  公開のために検証するチャネルのリストです。 チャネルが空でない場合、q内のアイテムは指定されたチャネルに対してパブリッシュ用に検証されます。 チャネルが空の場合、qに従ってすべてのアイテムがターゲット対象の各チャネルに対してパブリッシュ用に検証されます。
• 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"
}

ネストされたスキーマ : WorkflowActionBean

型: object

WorkflowActionBean

ソースを表示

• comments(optional): string
  実行されたアクションに関連するコメント
• failedItems(optional): array failedItems
  処理が失敗した品目
• items(optional): array items
• tasks(optional): array tasks
  品目からタスクへのマッピング
• value(optional): string
  アイテムに適用されるアクション

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

ネストされたスキーマ : categories

型: array

カテゴリ

ソースを表示

• Array of: object CategoryId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : TaxonomyId

型: object

TaxonomyId

ソースを表示

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

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

ネストされたスキーマ : CategoryId

型: object

ソースを表示

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

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

ネストされたスキーマ : ItemId

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• name(optional): string
  アイテムの名前。

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

ネストされたスキーマ: links

型: array

アイテム・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : channels

型: array

channels

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : ChannelId

型: object

ChannelId

ソースを表示

• id(optional): string
• isPrimaryChannel(optional): boolean
  チャネルがアセットのプライマリかどうかを示します。
• links(optional): array 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"
}

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : collections

型: array

コレクション

ソースを表示

• Array of: object CollectionId
  CollectionId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : CollectionId

型: object

CollectionId

ソースを表示

• id(optional): string

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ: tags

型: array

アイテムのタグ。

ソースを表示

• Array of: object Tag
  Tag.

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

ネストされたスキーマ: Tag

型: object

Tag.

ソースを表示

• language: string
  タグの言語。
• links(optional): array links
  リンク
• name: string
  タグの名前。

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

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : channels

型: array

チャネル

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ : collections

型: array

コレクション

ソースを表示

• Array of: object CollectionId
  CollectionId

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

ネストされたスキーマ : externalIds

型: array

externalIds

ソースを表示

• Array of: string

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

ネストされたスキーマ : externalItems

型: array

externalItems

ソースを表示

• Array of: object Item
  識別子: typeCategory

  項目

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

ネストされたスキーマ : FailedChannels

型: object

ソースを表示

• channels(optional): array channels
• items(optional): object items
  許可される追加のプロパティ: additionalProperties

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

ネストされたスキーマ : FailedCollections

型: object

ソースを表示

• collections(optional): array collections
• items(optional): object items
  許可される追加のプロパティ: additionalProperties

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

ネストされたスキーマ : FailedExternalIds

型: object

ソースを表示

• items(optional): object items
  許可される追加のプロパティ: additionalProperties

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

ネストされたスキーマ : FailedTags

型: object

ソースを表示

• items(optional): object items
  許可される追加のプロパティ: additionalProperties
• tags(optional): array tags

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

ネストされたスキーマ : FailedTaxonomyCategories

型: object

ソースを表示

• items(optional): object items
  許可される追加のプロパティ: additionalProperties

  カテゴリ分けに失敗した品目です。
• taxonomies(optional): array taxonomies
  リクエストされたアイテムに割り当てられていないタクソノミおよびカテゴリのリスト

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object Item
  識別子: typeCategory

  項目

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

ネストされたスキーマ: tags

型: array

アイテムにタグを追加

ソースを表示

• Array of: object Tag
  Tag.

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

ネストされたスキーマ : タクソノミ

型: array

taxonomies

ソースを表示

• Array of: object TaxonomyCategories

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

ネストされたスキーマ : アイテム

型: object

識別子: typeCategory

項目

ソースを表示

• changes(optional): object ItemSubResourceListChangesInfo
  アイテムSubResource。
• channels(optional): object ItemSubResourceListChannelId
  アイテムSubResource。
• collections(optional): object ItemSubResourceListCollectionId
  アイテムSubResource。
• connectorFileInfo(optional): object ItemSubResourceConnectorFileInfo
  アイテムSubResource。
• connectorId(optional): string
  アイテムのコネクタid。
• connectorSyncEnabled(optional): boolean
  アイテムのコネクタ同期使用可能フラグ。
• createdBy(optional): string
  作成方法
• createdByUser(optional): object User
  ユーザー・オブジェクト
• createdDate(optional): object date
  date
• description(optional): string
  アイテムの説明
• fields(optional): object fields
  読取り専用: true

  許可される追加のプロパティ: additionalProperties

  ユーザー定義フィールドのデータ。 Map。 タイプ定義に必要なすべてのユーザー定義フィールドは、このプロパティのPUTとPOSTリクエストで指定する必要があります。
• fileExtension(optional): string
  ファイルの拡張子。
• id(optional): string
  アイテムのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isPublished(optional): boolean
  アイテムが公開されたかどうか。
• language(optional): string
  アイテムの言語。
• languageIsMaster(optional): boolean
  アイテムがマスターかどうか。
• links(optional): array links
  リンク
• lockInfo(optional): object ItemSubResourceLockInfo
  アイテムSubResource。
• metadata(optional): object ItemMetadataInfo
  ItemMetadataInfo
• name(optional): string
  アイテムの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• permissions(optional): object ItemSubResourceListAction
  アイテムSubResource。
• publishedChannels(optional): object ItemSubResourceListChannelId
  アイテムSubResource。
• publishInfo(optional): object ItemSubResourceListPublishInfo
  アイテムSubResource。
• reference(optional): object ItemReferenceInfo
  ItemReferenceInfo
• relationships(optional): object ItemSubResourceRelationships
  アイテムSubResource。
• repositoryId(optional): string
  アイテムのリポジトリ。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• scheduled(optional): boolean
• slug(optional): string
  アイテムのURLスラグ。
• sourceId(optional): string
  ソースId。
• status(optional): string
  アイテムの現在のステータス。
• suggestedTaxonomies(optional): object ItemSubResourceListSuggestedTaxonomyInfo
  アイテムSubResource。
• tags(optional): object ItemSubResourceListTag
  アイテムSubResource。
• taxonomies(optional): object ItemSubResourceListTaxonomyInfo
  アイテムSubResource。
• translatable(optional): boolean
  アイテムが翻訳可能かどうか。
• type(optional): string
  タイプの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• typeCategory(optional): string
  読取り専用: true
• updatedBy(optional): string
  更新者。
• updatedByUser(optional): object User
  ユーザー・オブジェクト
• updatedDate(optional): object date
  date
• variations(optional): object ItemSubResourceListVariationsInfo
  アイテムSubResource。
• version(optional): string
  このアイテムの現在のリビジョン・バージョン。
• versionInfo(optional): object ItemSubResourceListVersionInfo
  アイテムSubResource。
• video(optional): object VideoBean
  VideoBean
• workflowInstances(optional): object WorkflowField
  すべてのマップ済ワークフロー・フィールド
• workflows(optional): object ItemSubResourceListWorkflowInfo
  アイテム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"
}

ネストされたスキーマ : ItemSubResourceListChangesInfo

型: object

アイテム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/ChangesInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

ネストされたスキーマ : ItemSubResourceListChannelId

型: object

アイテム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."
}

ネストされたスキーマ : ItemSubResourceListCollectionId

型: object

アイテム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."
}

ネストされたスキーマ : ItemSubResourceConnectorFileInfo

型: object

アイテム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."
}

ネストされたスキーマ: User

型: object

ユーザー・オブジェクト

ソースを表示

• displayName(optional): string
  読取り専用: true

  ユーザーの表示名
• email(optional): string
  読取り専用: true

  ユーザーの電子メール。
• userID(optional): integer(int64)
  読取り専用: true

  ユーザーのID。
• userName(optional): string
  読取り専用: true

  ユーザーの名前

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

ネストされたスキーマ: fields

型: object

読取り専用: true

使用可能なその他のプロパティ

ソースを表示

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

ユーザー定義フィールドのデータ。 Map。 タイプ定義に必要なすべてのユーザー定義フィールドは、このプロパティのPUTとPOSTリクエストで指定する必要があります。

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ItemSubResourceLockInfo

型: object

アイテムSubResource。

ソースを表示

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

ネストされたスキーマ : ItemMetadataInfo

型: object

ItemMetadataInfo

ソースを表示

• exif(optional): object EXIFMetadata
  EXIFメタデータ
• links(optional): array links
  リンク
• transcripts(optional): object VideoTranscriptMetadata
  ビデオ記録Metadata

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

ネストされたスキーマ : ItemSubResourceListAction

型: object

アイテム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/Action"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

ネストされたスキーマ : ItemSubResourceListPublishInfo

型: object

アイテム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."
}

ネストされたスキーマ : ItemReferenceInfo

型: object

ItemReferenceInfo

ソースを表示

• isAccessible(optional): boolean
  アイテムがアクセス可能かどうか。

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

ネストされたスキーマ : ItemSubResourceRelationships

型: object

アイテムSubResource。

ソースを表示

• data(optional): object 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."
}

ネストされたスキーマ : ItemSubResourceListSuggestedTaxonomyInfo

型: object

アイテム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."
}

ネストされたスキーマ : ItemSubResourceListTag

型: object

アイテム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."
}

ネストされたスキーマ : ItemSubResourceListTaxonomyInfo

型: object

アイテム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."
}

ネストされたスキーマ : ItemSubResourceListVariationsInfo

型: object

アイテム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."
}

ネストされたスキーマ : ItemSubResourceListVersionInfo

型: object

アイテム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."
}

ネストされたスキーマ : VideoBean

型: object

VideoBean

ソースを表示

• duration(optional): string
  読取り専用: true

  ISO 8601形式のビデオの期間。
• isFormatSupported(optional): boolean
  読取り専用: true

  ビデオ・ファイル形式がサポートされている場合のブール表現。
• 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"
}

ネストされたスキーマ : WorkflowField

型: object

すべてのマップ済ワークフロー・フィールド

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

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

ネストされたスキーマ : ItemSubResourceListWorkflowInfo

型: object

アイテム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/WorkflowInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object ChangesInfo
  ChangesInfo

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ChangesInfo

型: object

ChangesInfo

ソースを表示

• links(optional): array links
• source(optional): string
  この変更のソースであるこの品目に関連付けられたサブリソース。
• type(optional): string
  指定されたソースに対して追跡される変更のタイプ。
• value(optional): boolean
  Trueは変更を示します。 Falseは、このソース/タイプに対する現在の変更がないことを示します。

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object CollectionId
  CollectionId

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ConnectorFileInfo

型: object

ConnectorFileInfo

ソースを表示

• connectorId(optional): string
  コネクタID。
• id(optional): string
  ファイルID
• inUse(optional): boolean
  最新バージョンのアセットがファイル・コンテンツを使用しているかどうかを表します。
• version(optional): integer(int32)
  ファイルのバージョン

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: additionalProperties

型: object

ネストされたスキーマ : LockInfo

型: object

LockInfo

ソースを表示

• isLocked(optional): boolean
  アイテムがロックされているかどうかを表します。
• lockedBy(optional): string
  ユーザーによりロック済
• 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"
}

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : EXIFMetadata

型: object

EXIFメタデータ

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

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

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : VideoTranscriptMetadata

型: object

ビデオ記録Metadata

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

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

ネストされたスキーマ : aggregationResults

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

ネストされたスキーマ: items

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object ItemExtractedExifBean
  ItemExtractedExifBean

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

ネストされたスキーマ: links

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

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

ネストされたスキーマ : AggregationResult

型: object

ソースを表示

• name(optional): string
  読取り専用: true

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

ネストされたスキーマ : ItemExtractedExifBean

型: object

ItemExtractedExifBean

ソースを表示

• floatValue(optional): number(float)
  EXIFフィールドの浮動小数。 この値は、小数点以下桁数を使用したEXIFフィールド値の数値表現です。
• handle(optional): string
  ハンドルまたはEXIFフィールド名。 この値は翻訳できません。
• integerValue(optional): integer(int32)
  EXIFフィールドの整数値。 この値は、小数点のないEXIFフィールド値の数値表現です。
• links(optional): array links
  リンク
• rawId(optional): string
  EXIFフィールドのID。 1つのEXIFフィールドを一意に識別します。
• rawValue(optional): string
  未処理のEXIFフィールド値。 この値は、事前定義の値リストまたはテキスト値から数値にできます。
• stringValue(optional): string
  EXIFフィールドのテキスト値。 この値は、EXIFフィールド値のテキスト表現になります。
• type(optional): string
  EXIFフィールドのデータ型。(日付、整数、浮動小数、文字列)。
• value(optional): string
  EXIFフィールドの表示値。 この値は、EXIFフィールドの実際のタイプ値(日付、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"
}

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : aggregationResults

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

ネストされたスキーマ: items

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object Videotranscript
  ビデオ・トランスクリプト

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

ネストされたスキーマ: links

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

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

ネストされたスキーマ : Videotranscript

型: object

ビデオ・トランスクリプト

ソースを表示

• end(optional): string
  各トランスクリプト・ノードの終わり。
• id(optional): string
  各トランスクリプト・ノードのID。
• links(optional): array links
  リンク
• start(optional): string
  各トランスクリプト・ノードの開始。
• text(optional): string
  各成績証明書ノードのテキスト。

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

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object Action
  アクション

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: Action

型: object

アクション

ソースを表示

• action(optional): string
  許容値: [ "view", "update", "create", "delete" ]

  リソースでアクションが許可されています

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object PublishInfo
  PublishInfo

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : PublishInfo

型: object

PublishInfo

ソースを表示

• channel (オプション): string
  ターゲット名
• links(optional): array links
  リンク
• publishedBy(optional): string
  パブリッシュしたユーザー
• publishedDate(optional): object date
  date
• slug(optional): string
  公開スラグ
• version(optional): string
  公開済のバージョン

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

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : 関係

型: object

関係

ソースを表示

• referencedBy(optional): array referencedBy
  Idによる参照
• referencedBySitePlan(optional): object Siteplanreference
  サイト・プラン参照
• referencedBySites(optional): array referencedBySites
  サイトで参照
• references(optional): array references
  参照Id

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : referencedBy

型: array

Idによる参照

ソースを表示

• Array of: object References
  参照

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

ネストされたスキーマ : サイト・プラン参照

型: object

サイト・プラン参照

ソースを表示

• id(optional): string
  サイト・プランのID。
• 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"
}

ネストされたスキーマ : referencedBySites

型: array

サイトで参照

ソースを表示

• Array of: object ReferencedBySites
  ReferencedBySites

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

ネストされたスキーマ : references

型: array

参照Id

ソースを表示

• Array of: object References
  参照

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

ネストされたスキーマ : 参照

型: object

参照

ソースを表示

• id(optional): string
  アイテムのId。
• 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"
}

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ReferencedBySites

型: object

ReferencedBySites

ソースを表示

• component(オプション): string
  品目の構成部品
• pageId(optional): string
  アイテムが追加されたページ
• site(optional): string
  アイテムが追加されたサイト

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object SuggestedTaxonomyInfo
  SuggestedTaxonomyInfo

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : SuggestedTaxonomyInfo

型: object

SuggestedTaxonomyInfo

ソースを表示

• categories(optional): array categories
  アイテムが属する推奨タクソノミのカテゴリ。
• 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"
}

ネストされたスキーマ : categories

型: array

アイテムが属する推奨タクソノミのカテゴリ。

ソースを表示

• Array of: object ItemSuggestedCategoryInfo

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ItemSuggestedCategoryInfo

型: object

ソースを表示

• apiName(optional): string
  品目に割り当てられたカテゴリのapiName。
• id(optional): string
• isRejected(optional): boolean
  品目の提示カテゴリのステータス。
• links(optional): array links
• name(optional): string
• nodes(optional): array nodes
  品目に割り当てられたカテゴリ内のノード。
• order(optional): integer(int32)
  リポジトリに割り当てられたすべてのタクソノミ間の推奨カテゴリの確率の順序。

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : nodes

型: array

品目に割り当てられたカテゴリ内のノード。

ソースを表示

• Array of: object CategoryNodeBean

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

ネストされたスキーマ : CategoryNodeBean

型: object

ソースを表示

• apiName(optional): string
  カテゴリ・ノードのapiName。
• id(optional): string
  カテゴリ・ノードのid。
• name(optional): string
  カテゴリ・ノードの名前。

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object Tag
  Tag.

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object TaxonomyInfo
  TaxonomyInfo

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : TaxonomyInfo

型: object

TaxonomyInfo

ソースを表示

• categories(optional): array categories
  アイテムが属するタクソノミのカテゴリ。
• 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"
}

ネストされたスキーマ : categories

型: array

アイテムが属するタクソノミのカテゴリ。

ソースを表示

• Array of: object ItemCategoryInfo

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ItemCategoryInfo

型: object

ソースを表示

• apiName(optional): string
  品目に割り当てられたカテゴリのapiName。
• id(optional): string
• links(optional): array links
• name(optional): string
• nodes(optional): array nodes
  品目に割り当てられたカテゴリ内のノード。

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : nodes

型: array

品目に割り当てられたカテゴリ内のノード。

ソースを表示

• Array of: object CategoryNodeBean

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object VariationsInfo
  バリエーション情報。

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : VariationsInfo

型: object

バリエーション情報。

ソースを表示

• items(optional): array items
  コンテンツ・アイテムのバリエーション。
• links(optional): array links
• masterItem(optional): string
  マスター・アイテム。
• setId(optional): string
  変動セットId。
• varType(optional): string
  バリエーション・タイプ名です。

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

ネストされたスキーマ: items

型: array

コンテンツ・アイテムのバリエーション。

ソースを表示

• Array of: object Language
  LanguageItem

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : 言語

型: object

LanguageItem

ソースを表示

• id(optional): string
  アイテムのId。
• isPublished(optional): boolean
  アイテムが公開されたかどうか。
• links(optional): array links
• name(optional): string
  アイテムの名前。
• status(optional): string
  アイテムのステータス
• value(optional): string
  言語値

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object VersionInfo
  VersionInfo

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : VersionInfo

型: object

VersionInfo

ソースを表示

• latestVersion(optional): string
  最新バージョン
• publishedVersion(optional): string
  公開済のバージョン

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

ネストされたスキーマ : PlaybackBean

型: object

PlaybackBean

ソースを表示

• adaptiveStreams(optional): object AdaptiveStreamsBean
  AdaptiveStreamsBean

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

ネストされたスキーマ : ProcessingBean

型: object

ProcessingBean

ソースを表示

• progress(optional): string
  読取り専用: true

  バックグラウンド・プロセスの進捗。 このフィールドの値は、保留中、成功または失敗のいずれかになります。

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

ネストされたスキーマ : StripBean

型: object

StripBean

ソースを表示

• frame(optional): object StripFrameBean
  StripFrameBean

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

ネストされたスキーマ : AdaptiveStreamsBean

型: object

AdaptiveStreamsBean

ソースを表示

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

ネストされたスキーマ : StripFrameBean

型: object

StripFrameBean

ソースを表示

• count(optional): integer(int32)
  読取り専用: true

  ストリップ・イメージ内のフレーム数。
• height(optional): integer(int32)
  読取り専用: true

  ストリップ・イメージの高さです。
• width(optional): integer(int32)
  読取り専用: true

  ストリップ・イメージの幅です。

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

ネストされたスキーマ : aggregationResults

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

ネストされたスキーマ: items

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object WorkflowInfo
  WorkflowInfo.

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

ネストされたスキーマ: links

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

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

ネストされたスキーマ : WorkflowInfo

型: object

WorkflowInfo.

ソースを表示

• id(optional): string
  ワークフローID
• instanceId: string
  ワークフロー・インスタンスID。
• isCompleted(optional): boolean
  ワークフロー・インスタンスがOICで完了したかどうか。
• links(optional): array links
  リンク
• name(optional): string
  ワークフロー名
• status(optional): string
  ワークフロー・ステータス
• submittedBy(optional): string
  ユーザーにより送信済
• 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."
}

ネストされたスキーマ: links

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: data

型: array

ソースを表示

• Array of: object WorkflowInfo
  WorkflowInfo.

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

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ: items

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ネストされたスキーマ : collections

型: array

ソースを表示

• Array of: object CollectionId
  CollectionId

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

ネストされたスキーマ: items

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ネストされたスキーマ: items

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ネストされたスキーマ: items

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ネストされたスキーマ: tags

型: array

ソースを表示

• Array of: object Tag
  Tag.

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

ネストされたスキーマ: items

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

カテゴリ分けに失敗した品目です。

ネストされたスキーマ : タクソノミ

型: array

リクエストされたアイテムに割り当てられていないタクソノミおよびカテゴリのリスト

ソースを表示

• Array of: object TaxonomyCategories

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

ネストされたスキーマ : TaxonomyCategories

型: object

ソースを表示

• categories(optional): array categories
  割り当てるカテゴリ
• id(optional): string
  タクソノミのid。

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

ネストされたスキーマ : categories

型: array

割り当てるカテゴリ

ソースを表示

• Array of: object CategoryId

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : FailedItemId

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• message(optional): string
  失敗品目メッセージです。
• name(optional): string
  アイテムの名前。

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

ネストされたスキーマ: links

型: array

アイテム・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : failedItems

型: array

変換失敗アイテム・リスト

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

変換完了アイテム・リスト

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : setItems

型: array

変換するアイテムのリスト

ソースを表示

• Array of: object ChangeTypeItemBean
  変更タイプに関する情報の設定

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

ネストされたスキーマ : ChangeTypeItemBean

型: object

変更タイプに関する情報の設定

ソースを表示

• fields(optional): object fields
  許可される追加のプロパティ: additionalProperties

  型変換の一部として追加するフィールド
• id(optional): string
  アイテムのID
• type(optional): string
  ターゲット・タイプ名

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

ネストされたスキーマ: fields

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

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

型変換の一部として追加するフィールド

ネストされたスキーマ: additionalProperties

型: object

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

アクションが適用されるアイテム

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : プロバイダ

型: object

プロバイダ

ソースを表示

• name: string
  プロバイダ名

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

ネストされたスキーマ : ChannelsInCopy

型: object

ソースを表示

• targetToChannel(optional): array targetToChannel
  targetToChannel

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

ネストされたスキーマ : CollectionsInCopy

型: object

ソースを表示

• collectionName(optional): string
  作成するコレクションの名前。

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object CopiedItemId

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

ネストされたスキーマ: message

型: array

message

ソースを表示

• Array of: string

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

ネストされたスキーマ : RepositoryId

型: object

RepositoryId

ソースを表示

• id(optional): string
• name(optional): string
  リポジトリの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。

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

ネストされたスキーマ : targetToChannel

型: array

targetToChannel

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ : CopiedItemId

型: object

ソースを表示

• id(optional): string
  コピーされたアイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• name(optional): string
  アイテムの名前。
• originalId(optional): string
  元のアイテムのId。

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

ネストされたスキーマ: links

型: array

アイテム・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : CompilationJobStatus

型: object

コンパイル・ジョブ・ステータス

ソースを表示

• compiledAt(optional): string
  yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式のこのステータス・メッセージの日時。
• compiledTime(optional): string(date-time)
• jobId(optional): string
  コンテンツ・アイテム翻訳コンパイル・ジョブID。
• progress(optional): number(double)
  コンパイル・ジョブ・ステータス進捗率。
• status(optional): string
  コンパイル・ジョブ・ステータス。

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ContentItemRenditions
  アイテムのコンテンツ・レンディション

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

ネストされたスキーマ: repositories

型: array

ソースを表示

• Array of: object RepositoryId
  RepositoryId

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

ネストされたスキーマ : ContentItemRenditions

型: object

アイテムのコンテンツ・レンディション

ソースを表示

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

ネストされたスキーマ : renditionFormats

型: array

ソースを表示

• Array of: object ContentRenditionFormat
  コンテンツ・レンディション形式

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

ネストされたスキーマ : ContentRenditionFormat

型: object

コンテンツ・レンディション形式

ソースを表示

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

アクションが適用されるアイテム

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : LockTranslations

型: object

ソースを表示

• lockAll(optional): boolean
  セット内のすべての翻訳または特定の翻訳をロック

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

ネストされたスキーマ : channels

型: array

公開チャネルのリスト。 チャネルが空でない場合、q内のアイテムは指定されたチャネルにパブリッシュされます。 チャネルが空の場合、qに従ってすべてのアイテムがターゲット対象の各チャネルに公開されます。

ソースを表示

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

ネストされたスキーマ: ids

型: array

詳細な公開済アイテムidのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ignoredItems

型: array

ソースを表示

• Array of: object IgnoredItemId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : itemVersions

型: object

使用可能なその他のプロパティ

ソースを表示

• string

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

ネストされたスキーマ : PublishOptions

型: object

ソースを表示

• unlockAfterPublish(optional): boolean
  正常に公開された後、ユーザーが所有するアイテムのロックを解除

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

ネストされたスキーマ : PublishValidation

型: object

PublishValidation

ソースを表示

• languageOnly(optional): boolean
• testOnly(optional): boolean
• verbosity(optional): string
  許容値: [ "none", "terse", "normal", "verbose" ]

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

ネストされたスキーマ : IgnoredItemId

型: object

ソースを表示

• channels(optional): array channels
• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• message(optional): string
  無視されたアイテム・メッセージです。
• name(optional): string
  アイテムの名前。

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

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ: links

型: array

アイテム・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemRollBackBean

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

ネストされたスキーマ : ItemRollBackBean

型: object

ソースを表示

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

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object WorkflowItemId

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

ネストされたスキーマ : itemWorkflows

型: array

指定されたワークフローに送信するアイテム

ソースを表示

• Array of: object ItemWorkflows
  ItemWorkflows

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

ネストされたスキーマ : WorkflowItemId

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• name(optional): string
  アイテムの名前。
• workflowInstanceId(optional): string
  レビューのためにアイテムが送信されるワークフロー・インスタンスID。

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

ネストされたスキーマ: links

型: array

アイテム・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ : ItemWorkflows

型: object

ItemWorkflows

ソースを表示

• itemId(optional): string
  項目ID
• workflowId (オプション): string
  ワークフローID

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

アクションが適用されるアイテム

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : UnlockTranslations

型: object

ソースを表示

• unlockAll(optional): boolean
  セット内のすべての翻訳または特定の翻訳のロック解除

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

ネストされたスキーマ : channels

型: array

公開取消チャネルのリスト。 チャネルが空でない場合、q内のアイテムは指定されたチャネルに対する公開が取り消されます。 チャネルが空の場合、q当たりのすべてのアイテムは、ターゲット対象の各チャネルに対して非公開になります。

ソースを表示

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

ネストされたスキーマ: ids

型: array

詳細な未公開アイテムidのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ : channels

型: array

公開のために検証するチャネルのリストです。 チャネルが空でない場合、q内のアイテムは指定されたチャネルに対してパブリッシュ用に検証されます。 チャネルが空の場合、qに従ってすべてのアイテムがターゲット対象の各チャネルに対してパブリッシュ用に検証されます。

ソースを表示

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

ネストされたスキーマ : missingItems

型: array

ソースを表示

• Array of: string

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

ネストされたスキーマ : validationResults

型: array

ソースを表示

• Array of: object PublishValidationResult
  アイテムをチャネルに公開するための検証結果を公開

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

ネストされたスキーマ : PublishValidationResult

型: object

アイテムをチャネルに公開するための検証結果を公開

ソースを表示

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

ネストされたスキーマ : PolicyValidationResult

型: object

PolicyValidationResult

ソースを表示

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

ネストされたスキーマ : TableStringStringString

型: object

ソースを表示

• empty(optional): boolean

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

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelReference

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemSummary

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

ネストされたスキーマ : リクエスト

型: object

ソースを表示

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

ネストされたスキーマ : variationSets

型: array

ソースを表示

• Array of: object ItemVariationSetSummary

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

ネストされたスキーマ : ChannelReference

型: object

ソースを表示

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

ネストされたスキーマ : publishableItems

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : PolicyReference

型: object

ソースを表示

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

ネストされたスキーマ : variationPolicies

型: array

ソースを表示

• Array of: object PolicyReference

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

ネストされたスキーマ : PublishItemId

型: object

ソースを表示

• id(optional): string

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

ネストされたスキーマ : ItemSummary

型: object

ソースを表示

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

ネストされたスキーマ: dependencies

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : 検証

型: array

ソースを表示

• Array of: object ChannelValidation

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

ネストされたスキーマ : ChannelValidation

型: object

ソースを表示

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

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object PolicyRuleResult
  PolicyRuleResult

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

ネストされたスキーマ : PolicyRuleResult

型: object

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

ネストされたスキーマ : channels

型: array

ソースを表示

• Array of: object ChannelId
  ChannelId

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

ネストされたスキーマ: ids

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : ItemVariationSetSummary

型: object

ソースを表示

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object PublishItemId

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

ネストされたスキーマ : 検証

型: array

ソースを表示

• Array of: object ChannelValidation

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

ネストされたスキーマ : failedItems

型: array

処理が失敗した品目

ソースを表示

• Array of: object FailedItemId

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

ネストされたスキーマ: items

型: array

ソースを表示

• Array of: object ItemId

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

ネストされたスキーマ: tasks

型: array

品目からタスクへのマッピング

ソースを表示

• Array of: object TaskItemMapping
  TaskItemMapping

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

ネストされたスキーマ : TaskItemMapping

型: object

TaskItemMapping

ソースを表示

• itemId(optional): string
  アイテムのId。
• taskId(optional): string
  ワークフロー・タスクのID。

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

ネストされたスキーマ : ResultHTTPHeader

型: object

ResultHTTPHeader

ソースを表示

• name(optional): string
  HTTPレスポンス・ヘッダー名
• value(optional): string
  HTTPレスポンス・ヘッダー値

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

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、cURLを使用したGETリクエストの送信によるステータスIDを使用した一括アイテム操作の取得方法を示しています。

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

例:

この操作Idを使用した正常なアイテム一括非同期操作の読取りステータス: E2A8C607848940D9ADA0DFFBE078E799。

/content/management/api/v1.1/bulkItemsOperations/E2A8C607848940D9ADA0DFFBE078E799

レスポンス本文

{
    "id": "E2A8C607848940D9ADA0DFFBE078E799",
    "startTime": {
     "value": "2018-12-21T06:47:14.656Z",
     "timezone": "UTC"
    },
    "endTime": {
     "value": "2018-12-21T06:47:16.759Z",
     "timezone": "UTC"
    },
    "progress": "succeeded",
    "completed": true,
    "message": "Job Completed Successfully",
    "completedPercentage": 100,
    "result": {
     "status": {
    "code": 200,
    "reason": ""
     },
     "headers": [],
     "body": {
    "q": "id eq \"CORE286F0F6560694D2A9A51B1EAA2FAC1D9\"",
    "operations": {
     "deleteItems": {
    "value": true,
    "items": [
     {
    "id": "CORE286F0F6560694D2A9A51B1EAA2FAC1D9"
     }
    ]
     }
    },
    "links": [
     {
    "href": "https://host:port/content/management/api/v1.1/bulkItemsOperations",
    "rel": "self",
    "method": "POST",
    "mediaType": "application/json"
     },
     {
    "href": "https://host:port/content/management/api/v1.1/bulkItemsOperations",
    "rel": "canonical",
    "method": "POST",
    "mediaType": "application/json"
     },
     {
    "href": "https://host:port/content/management/api/v1.1/metadata-catalog/bulkItemsOperations",
    "rel": "describedby",
    "method": "GET",
    "mediaType": "application/schema+json"
     }
    ]
     }
    },
    "links": [
     {
    "href": "https://host:port/content/management/api/v1.1/bulkItemsOperations/E2A8C607848940D9ADA0DFFBE078E799",
    "rel": "self",
    "method": "GET",
    "mediaType": "application/json"
     },
     {
    "href": "https://host:port/content/management/api/v1.1/bulkItemsOperations/E2A8C607848940D9ADA0DFFBE078E799",
    "rel": "canonical",
    "method": "GET",
    "mediaType": "application/json"
     },
     {
    "href": "https://host:port/content/management/api/v1.1/metadata-catalog/bulkItemsOperations/E2A8C607848940D9ADA0DFFBE078E799",
    "rel": "describedby",
    "method": "GET",
    "mediaType": "application/schema+json"
     }
    ]
   }
  

先頭に戻る