機械翻訳について

移動先

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

カテゴリの作成

post

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

指定されたペイロードで、提供された親に添付します。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  タクソノミのId。

問合せパラメータ

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

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内に指定の情報でカテゴリを作成します。 ペイロードで指定されている場合でも、id、children, idPath, namePathおよびlinksフィールドは無視されます。

parentId提供時に、カテゴリがそのidを持つカテゴリに添付されます。 1stレベルのカテゴリを作成するには、parentIdをタクソノミidに設定する必要があります。 カテゴリの作成時は、parentIdを空にできません。

positionフィールドを使用して、兄弟のカテゴリの順序を指定できます。 positionを指定しない場合、カテゴリは兄弟の最後に配置されます。

apiNameフィールドは、すべてのタクソノミでカテゴリを一意に識別します。 このフィールドでは、大文字/小文字が区別されます。 ペイロードに一意のタクソノミshortNameがない場合は、プレフィクスとして自動的に付けられます。

例: apiNameを使用したカテゴリの作成。 すべての空白文字はサーバーによって切り捨てられます。 タクソノミshortNameもapiName値のプレフィクスとしてペイロードに追加されることに注意してください。

• taxonomy shortName = "TAX"
• apiName = "My API name value"
• 結果apiName = "tax-my-api-name-value"

例: apiNameを使用しないカテゴリの作成。 サーバーは、タクソノミshortNameプレフィクスに続けてこのカテゴリの各「祖先」の最初の文字を使用して、apiNameを自動的に生成します。

• taxonomy shortName = "VEH"
• category name = "Red"
• 「祖先」名= "Vehicles"、"Cars"および"Sport"
• 結果apiName = "veh-v-c-s-r"

例: apiNameに競合がないカテゴリの作成。 サーバーは、タクソノミshortNameプレフィクスに続けてこのカテゴリの各「祖先」の最初の文字を使用して、apiNameを自動的に生成します。 他の値と競合する場合は、数値サフィクスが追加されます。

• taxonomy shortName = "VEH"
• category name = "Red Wine"
• 「祖先」名= "Vehicles"、"Cars"および"Sport"
• 結果apiName = "veh-v-c-s-r1"

「シノニム」フィールドは、タクソノミの「シノニム」システム管理カテゴリ・プロパティに割り当てられる値のカンマ区切りリストです。

「キーワード」フィールドは、タクソノミの「キーワード」システム管理カテゴリ・プロパティに割り当てられる値のカンマ区切りリストです。

relatedCategoriesフィールドは、各要素が現在のカテゴリに関連するカテゴリを表し、これらの値がタクソノミのrelatedCategoriesシステム管理カテゴリ・プロパティに割り当てられるリストです。

customPropertiesフィールドは、ユーザー定義のカテゴリ・プロパティのプロパティ値を表します。 特定のカスタム・カテゴリ・プロパティに値を割り当てるには、カテゴリ・プロパティのapiNameに続けて値のリストを指定する必要があります。 既存のカスタム・カテゴリ・プロパティに値が指定されていない場合、サーバーはカテゴリ・プロパティのデフォルト値を自動的に割り当てます。

ルート・スキーマ : CategoryInformation

型: object

カテゴリ情報

ソースを表示

• ancestors(optional): array ancestors
  カテゴリの祖先です。 最初の要素はルート・カテゴリを表し、最後の要素はカテゴリの直接の親を表します。
• apiName(optional): string
  カテゴリのapiName。 このプロパティはタクソノミ間でカテゴリを一意に識別し、作成時または更新時に指定されない場合は自動的に生成されます。 これは、リクエストの取得および投稿でのオプションのプロパティです。
• children(optional): object CollectionPropertiesCategoryInCollection
  CollectionProperties.
• customProperties(optional): object customProperties
  許可される追加プロパティ: CustomPropertyValuesBean

  カテゴリのカスタム・プロパティ値。
• description(optional): string
  カテゴリの説明。
• id(optional): string
  カテゴリのId。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• idPath(optional): string
  ルート・カテゴリから、'/'で区切られたこのカテゴリへの完全なidパス。 これは、Getリクエストのオプションのプロパティであり、post/putリクエストでは無視されます。
• isSiteCategory(optional): boolean
  カテゴリがサイト・カテゴリかどうか。(デフォルトはfalse)
• keywords(optional): array keywords
  カテゴリのキーワード。
• links(optional): array links
  リンク
• name: string
  カテゴリの名前。 これはレスポンス取得の必須プロパティであり、post / putリクエストで空にはできません。
• namePath(optional): string
  ルート・カテゴリから、'/'で区切られたこのカテゴリへのフル・ネーム・パス。 これは、Getリクエストのオプションのプロパティであり、post/putリクエストでは無視されます。
• parent(optional): object CategoryAncestorBean
• parentId(optional): string
  カテゴリのparentId。 これは、リクエストの取得と投稿に必須のプロパティです。 Putリクエストで指定される場合、カテゴリとその下のツリーを、タクソノミ内の別の親カテゴリに移動するために使用できます。
• position(optional): integer(int32)
  最小値: 0

  カテゴリ兄弟間の位置。 これは必須プロパティであるため、取得レスポンスのプロパティです。
• relatedCategories(optional): array relatedCategories
  カテゴリの関連カテゴリ。
• roleName(optional): string
  リソース上のロールの名前。
• status(optional): string
  許容値: [ "draft", "promoted" ]

  カテゴリのステータス。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• suggestedItems(optional): object ItemSubResourceListItem
  アイテムSubResource。
• synonyms(optional): array synonyms
  カテゴリのシノニム。

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

ネストされたスキーマ : 祖先

型: array

カテゴリの祖先です。 最初の要素はルート・カテゴリを表し、最後の要素はカテゴリの直接の親を表します。

ソースを表示

• Array of: object CategoryAncestorBean

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

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

型: object

CollectionProperties.

ソースを表示

• 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/CategoryInCollection"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"CollectionProperties."
}

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

型: object

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

ソースを表示

• object CustomPropertyValuesBean

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

カテゴリのカスタム・プロパティ値。

ネストされたスキーマ : キーワード

型: array

カテゴリのキーワード。

ソースを表示

• Array of: string

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

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

型: array

リンク

ソースを表示

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

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

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

型: object

ソースを表示

• apiName(optional): string
  カテゴリ祖先のapiName
• id(optional): string
  カテゴリ祖先のid。
• name(optional): string
  カテゴリ祖先の名前。

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

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

型: array

カテゴリの関連カテゴリ。

ソースを表示

• Array of: object RelatedCategory
  関連カテゴリ

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

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

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

ネストされたスキーマ : シノニム

型: array

カテゴリのシノニム。

ソースを表示

• Array of: string

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

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

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

型: array

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

ソースを表示

• Array of: object CategoryInCollection
  回収レスポンスのカテゴリ

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

ネストされたスキーマ: 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
        }
    }
}

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

型: object

回収レスポンスのカテゴリ

ソースを表示

• apiName(optional): string
  カテゴリのapiName。 このプロパティはタクソノミ間でカテゴリを一意に識別し、作成時または更新時に指定されない場合は自動的に生成されます。 これは、リクエストの取得および投稿でのオプションのプロパティです。
• customProperties(optional): object customProperties
  許可される追加プロパティ: CustomPropertyValuesBean

  カテゴリのカスタム・プロパティ値。
• description(optional): string
  カテゴリの説明。
• id(optional): string
  カテゴリのId。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• isSiteCategory(optional): boolean
  カテゴリがサイト・カテゴリかどうか。(デフォルトはfalse)
• keywords(optional): array keywords
  カテゴリのキーワード。
• links(optional): array links
  リンク
• name: string
  カテゴリの名前。 これはレスポンス取得の必須プロパティであり、post / putリクエストで空にはできません。
• parentId(optional): string
  カテゴリのparentId。 これは、リクエストの取得と投稿に必須のプロパティです。 Putリクエストで指定される場合、カテゴリとその下のツリーを、タクソノミ内の別の親カテゴリに移動するために使用できます。
• position(optional): integer(int32)
  最小値: 0

  カテゴリ兄弟間の位置。 これは必須プロパティであるため、取得レスポンスのプロパティです。
• relatedCategories(optional): array relatedCategories
  カテゴリの関連カテゴリ。
• roleName(optional): string
  リソース上のロールの名前。
• status(optional): string
  許容値: [ "draft", "promoted" ]

  カテゴリのステータス。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• suggestedItems(optional): object ItemSubResourceListItem
  アイテムSubResource。
• synonyms(optional): array synonyms
  カテゴリのシノニム。

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

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

型: object

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

ソースを表示

• object CustomPropertyValuesBean

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

カテゴリのカスタム・プロパティ値。

ネストされたスキーマ : キーワード

型: array

カテゴリのキーワード。

ソースを表示

• Array of: string

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

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

型: array

リンク

ソースを表示

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

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

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

型: array

カテゴリの関連カテゴリ。

ソースを表示

• Array of: object RelatedCategory
  関連カテゴリ

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

ネストされたスキーマ : シノニム

型: array

カテゴリのシノニム。

ソースを表示

• Array of: string

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

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

型: object

ソースを表示

• values(optional): array values
  カスタム・プロパティの値リスト。

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

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

型: array

カスタム・プロパティの値リスト。

ソースを表示

• Array of: object CustomPropertyValue

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

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

型: object

ソースを表示

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

  カスタム・プロパティ値のID。
• value(optional): string
  カスタム・プロパティの値

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

ネストされたスキーマ: 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."
}

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

型: object

関連カテゴリ

ソースを表示

• apiName(optional): string
  カテゴリのapiName。
• id(optional): string
  カテゴリのid。
• name(optional): string
  カテゴリの名前。
• nodes(optional): array nodes
  カテゴリのパス。
• taxonomy(optional): object RelatedTaxonomyBean

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

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

型: array

カテゴリのパス。

ソースを表示

• Array of: object CategoryNodeBean

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

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

型: object

ソースを表示

• id(optional): string
  タクソノミのId。
• name(optional): string
  タクソノミの名前。
• shortName(optional): string
  タクソノミの短縮名。

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

ネストされたスキーマ : 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 Item
  識別子: typeCategory

  項目

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

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

型: array

ソースを表示

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

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

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

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

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

型: object

date

ソースを表示

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

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

ネストされたスキーマ: 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"
    }
}

ネストされたスキーマ : 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"
    }
}

ネストされたスキーマ: 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"
    }
}

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

型: object

CollectionId

ソースを表示

• id(optional): string

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

ネストされたスキーマ : 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"
    }
}

ネストされたスキーマ : 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"
    }
}

ネストされたスキーマ: 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"
    }
}

ネストされたスキーマ: 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"
    }
}

ネストされたスキーマ: 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"
    }
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : CategoryInformation

型: object

カテゴリ情報

ソースを表示

• ancestors(optional): array ancestors
  カテゴリの祖先です。 最初の要素はルート・カテゴリを表し、最後の要素はカテゴリの直接の親を表します。
• apiName(optional): string
  カテゴリのapiName。 このプロパティはタクソノミ間でカテゴリを一意に識別し、作成時または更新時に指定されない場合は自動的に生成されます。 これは、リクエストの取得および投稿でのオプションのプロパティです。
• children(optional): object CollectionPropertiesCategoryInCollection
  CollectionProperties.
• customProperties(optional): object customProperties
  許可される追加プロパティ: CustomPropertyValuesBean

  カテゴリのカスタム・プロパティ値。
• description(optional): string
  カテゴリの説明。
• id(optional): string
  カテゴリのId。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• idPath(optional): string
  ルート・カテゴリから、'/'で区切られたこのカテゴリへの完全なidパス。 これは、Getリクエストのオプションのプロパティであり、post/putリクエストでは無視されます。
• isSiteCategory(optional): boolean
  カテゴリがサイト・カテゴリかどうか。(デフォルトはfalse)
• keywords(optional): array keywords
  カテゴリのキーワード。
• links(optional): array links
  リンク
• name: string
  カテゴリの名前。 これはレスポンス取得の必須プロパティであり、post / putリクエストで空にはできません。
• namePath(optional): string
  ルート・カテゴリから、'/'で区切られたこのカテゴリへのフル・ネーム・パス。 これは、Getリクエストのオプションのプロパティであり、post/putリクエストでは無視されます。
• parent(optional): object CategoryAncestorBean
• parentId(optional): string
  カテゴリのparentId。 これは、リクエストの取得と投稿に必須のプロパティです。 Putリクエストで指定される場合、カテゴリとその下のツリーを、タクソノミ内の別の親カテゴリに移動するために使用できます。
• position(optional): integer(int32)
  最小値: 0

  カテゴリ兄弟間の位置。 これは必須プロパティであるため、取得レスポンスのプロパティです。
• relatedCategories(optional): array relatedCategories
  カテゴリの関連カテゴリ。
• roleName(optional): string
  リソース上のロールの名前。
• status(optional): string
  許容値: [ "draft", "promoted" ]

  カテゴリのステータス。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• suggestedItems(optional): object ItemSubResourceListItem
  アイテムSubResource。
• synonyms(optional): array synonyms
  カテゴリのシノニム。

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

ネストされたスキーマ : 祖先

型: array

カテゴリの祖先です。 最初の要素はルート・カテゴリを表し、最後の要素はカテゴリの直接の親を表します。

ソースを表示

• Array of: object CategoryAncestorBean

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

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

型: object

CollectionProperties.

ソースを表示

• 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/CategoryInCollection"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"CollectionProperties."
}

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

型: object

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

ソースを表示

• object CustomPropertyValuesBean

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

カテゴリのカスタム・プロパティ値。

ネストされたスキーマ : キーワード

型: array

カテゴリのキーワード。

ソースを表示

• Array of: string

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

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

型: array

リンク

ソースを表示

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

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

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

型: object

ソースを表示

• apiName(optional): string
  カテゴリ祖先のapiName
• id(optional): string
  カテゴリ祖先のid。
• name(optional): string
  カテゴリ祖先の名前。

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

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

型: array

カテゴリの関連カテゴリ。

ソースを表示

• Array of: object RelatedCategory
  関連カテゴリ

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

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

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

ネストされたスキーマ : シノニム

型: array

カテゴリのシノニム。

ソースを表示

• Array of: string

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

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

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

型: array

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

ソースを表示

• Array of: object CategoryInCollection
  回収レスポンスのカテゴリ

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

ネストされたスキーマ: 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
        }
    }
}

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

型: object

回収レスポンスのカテゴリ

ソースを表示

• apiName(optional): string
  カテゴリのapiName。 このプロパティはタクソノミ間でカテゴリを一意に識別し、作成時または更新時に指定されない場合は自動的に生成されます。 これは、リクエストの取得および投稿でのオプションのプロパティです。
• customProperties(optional): object customProperties
  許可される追加プロパティ: CustomPropertyValuesBean

  カテゴリのカスタム・プロパティ値。
• description(optional): string
  カテゴリの説明。
• id(optional): string
  カテゴリのId。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• isSiteCategory(optional): boolean
  カテゴリがサイト・カテゴリかどうか。(デフォルトはfalse)
• keywords(optional): array keywords
  カテゴリのキーワード。
• links(optional): array links
  リンク
• name: string
  カテゴリの名前。 これはレスポンス取得の必須プロパティであり、post / putリクエストで空にはできません。
• parentId(optional): string
  カテゴリのparentId。 これは、リクエストの取得と投稿に必須のプロパティです。 Putリクエストで指定される場合、カテゴリとその下のツリーを、タクソノミ内の別の親カテゴリに移動するために使用できます。
• position(optional): integer(int32)
  最小値: 0

  カテゴリ兄弟間の位置。 これは必須プロパティであるため、取得レスポンスのプロパティです。
• relatedCategories(optional): array relatedCategories
  カテゴリの関連カテゴリ。
• roleName(optional): string
  リソース上のロールの名前。
• status(optional): string
  許容値: [ "draft", "promoted" ]

  カテゴリのステータス。 これはレスポンス取得時に必須プロパティであり、ポスト/putリクエストでは無視されます。
• suggestedItems(optional): object ItemSubResourceListItem
  アイテムSubResource。
• synonyms(optional): array synonyms
  カテゴリのシノニム。

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

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

型: object

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

ソースを表示

• object CustomPropertyValuesBean

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

カテゴリのカスタム・プロパティ値。

ネストされたスキーマ : キーワード

型: array

カテゴリのキーワード。

ソースを表示

• Array of: string

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

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

型: array

リンク

ソースを表示

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

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

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

型: array

カテゴリの関連カテゴリ。

ソースを表示

• Array of: object RelatedCategory
  関連カテゴリ

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

ネストされたスキーマ : シノニム

型: array

カテゴリのシノニム。

ソースを表示

• Array of: string

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

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

型: object

ソースを表示

• values(optional): array values
  カスタム・プロパティの値リスト。

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

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

型: array

カスタム・プロパティの値リスト。

ソースを表示

• Array of: object CustomPropertyValue

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

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

型: object

ソースを表示

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

  カスタム・プロパティ値のID。
• value(optional): string
  カスタム・プロパティの値

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

ネストされたスキーマ: 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."
}

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

型: object

関連カテゴリ

ソースを表示

• apiName(optional): string
  カテゴリのapiName。
• id(optional): string
  カテゴリのid。
• name(optional): string
  カテゴリの名前。
• nodes(optional): array nodes
  カテゴリのパス。
• taxonomy(optional): object RelatedTaxonomyBean

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

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

型: array

カテゴリのパス。

ソースを表示

• Array of: object CategoryNodeBean

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

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

型: object

ソースを表示

• id(optional): string
  タクソノミのId。
• name(optional): string
  タクソノミの名前。
• shortName(optional): string
  タクソノミの短縮名。

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

ネストされたスキーマ : 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 Item
  識別子: typeCategory

  項目

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

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

型: array

ソースを表示

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

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

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

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

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

型: object

date

ソースを表示

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

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

ネストされたスキーマ: 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"
    }
}

ネストされたスキーマ : 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"
    }
}

ネストされたスキーマ: 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"
    }
}

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

型: object

CollectionId

ソースを表示

• id(optional): string

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

ネストされたスキーマ : 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"
    }
}

ネストされたスキーマ : 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"
    }
}

ネストされたスキーマ: 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"
    }
}

ネストされたスキーマ: 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"
    }
}

ネストされたスキーマ: 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"
    }
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

タクソノミが見つかりません。 リクエストしたリソースが見つかりません。

409レスポンス

リクエストされたリソース操作は一時的に使用できません

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースにPOSTリクエストを発行し、タクソノミ・カテゴリを作成する方法を示します:

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/taxonomies/{id}/categories'

例1:

この例では、C5という名前のルート・カテゴリをタクソノミに追加する方法を示します。 指定するparentIdは、タクソノミのIDです。

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories

リクエスト本文

{
   "name": "C5",
   "parentId": "D7969D6CA0D144AEA9CCA88BA6D2CF81"
}

例2:

この例では、説明と名前を含むタクソノミにルート・カテゴリを追加する方法を示します。

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories

リクエスト本文

{
  "name": "C6",
  "parentId": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
  "description": "The description info"
}

例3 :

この例は、親IDを指定して、親カテゴリの下にカテゴリを追加する方法(デフォルト)を示しています。

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories

リクエスト本文

{
   "name": "C6.1",
   "parentId": "6F81E244EB8D4E229CBF00A065009598",
   "description": "The description info"
}

例4 :

次の例は、親IDを指定して、0 (前)の親カテゴリの下にカテゴリを追加する方法を示しています。

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/categories

リクエスト本文

{
   "name": "C6.0",
   "parentId": "6F81E244EB8D4E229CBF00A065009598",
   "position": 0
}

先頭に戻る