機械翻訳について

移動先

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

検針タイプ更新操作ステータス

get

/content/management/api/v1.1/types/{name}/updateType/.status/{statusId}

読取りタイプ更新操作のステータス。

リクエスト

パス・パラメータ

• name: string
  型名識別子は大/小文字が区別され、特殊文字はエンコードする必要があります。
• statusId: string
  タイプ更新操作のステータスID。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : TypeUpdateOperationJobStatus

型: object

TypeUpdateOperationJobStatus

ソースを表示

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

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

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

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

型: object

date

ソースを表示

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

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

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

型: object

エラー

ソースを表示

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

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

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

型: array

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

ソースを表示

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

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

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

型: object

結果

ソースを表示

• body(optional): object Type
  AggregatedType
• headers(optional): array headers
  元の非同期リクエストへのレスポンスのHTTPヘッダーのリスト
• status(optional): object ResultHTTPStatus
  ResultHTTPStatus

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

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

型: object

リソースのリンク。

ソースを表示

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

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

ネストされたスキーマ : タイプ

型: object

AggregatedType

ソースを表示

• allowedActions(optional): array allowedActions
  タイプのallowedActions。
• allowedFileTypes(optional): array allowedFileTypes
  タイプでサポートされているファイル拡張子の許可されたリスト。 これはレスポンス取得の必須プロパティです。 ポスト/プット・リクエストではオプションで、typeCategoryがContentTypeの場合は[ContentItem]にデフォルト設定され、typeCategoryがDigitalAssetTypeの場合は空にデフォルト設定されます。
• apiName(optional): string
  タイプのAPI名。
• archivedFields(optional): object ItemSubResourceListTypeField
  アイテムSubResource。
• connectorInfos(optional): array connectorInfos
  タイプのconnectorInfos。
• createdBy(optional): string
  作成方法
• createdDate(optional): object date
  date
• description(optional): string
  タイプの説明。
• displayName(optional): string
  タイプの表示名。 これはgetレスポンスの必須プロパティですが、post/putリクエストでは必要ありません。
• fields(optional): array fields
  タイプで使用されるフィールド。
• id(optional): string
  型のId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• inplacePreview(optional): object ItemSubResourceListInplacePreview
  アイテムSubResource。
• jobToken(optional): string
  タイプを更新するバックグラウンド・ジョブのジョブ・トークン。
• layoutMapping(optional): object ItemSubResourceListLayoutMapping
  アイテムSubResource。
• links(optional): array links
• name(optional): string
  タイプの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• properties(optional): object properties
  許可される追加のプロパティ: additionalProperties

  特定のプロパティを入力します。
• relationships(optional): object ItemSubResourceTypeRelationships
  アイテムSubResource。
• requiredTaxonomies(optional): object ItemSubResourceListRequiredTaxonomy
  アイテムSubResource。
• roleName(optional): string
  コンテンツ・タイプのユーザー・ロールの名前。
• typeCategory(optional): string
  タイプのカテゴリ。 使用可能な値は[ContentType, DigitalAssetType]です。 これはレスポンス取得の必須プロパティです。 ポスト・リクエストではオプションで、ContentTypeにデフォルト設定されます。 Putリクエストでもオプションで、URLのtypeNameパス・パラメータに基づいて識別されます。
• updatedBy(optional): string
  更新者
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the type. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"Name of the type. It is a required property in the get response and post/put request."
        },
        "displayName":{
            "type":"string",
            "description":"display name of the type. It is a required property in the get response whereas it is not required in the post/put request."
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the type."
        },
        "description":{
            "type":"string",
            "description":"Description of the type."
        },
        "typeCategory":{
            "type":"string",
            "description":"Category of the type. The allowed values are [ContentType, DigitalAssetType]. It is a required property in the get response. It is optional in post request and defaults to ContentType. It is also optional in put request and is identified based on the typeName path param in URL."
        },
        "createdBy":{
            "type":"string",
            "description":"Created by"
        },
        "createdDate":{
            "description":"date and time Type createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated by"
        },
        "updatedDate":{
            "description":"date and time Type updatedAt.",
            "$ref":"#/definitions/date"
        },
        "fields":{
            "type":"array",
            "description":"Fields used in the type.",
            "items":{
                "$ref":"#/definitions/TypeField"
            }
        },
        "properties":{
            "type":"object",
            "description":"Type specific properties.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "allowedFileTypes":{
            "type":"array",
            "description":"Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the content type."
        },
        "layoutMapping":{
            "$ref":"#/definitions/ItemSubResourceListLayoutMapping"
        },
        "inplacePreview":{
            "$ref":"#/definitions/ItemSubResourceListInplacePreview"
        },
        "requiredTaxonomies":{
            "$ref":"#/definitions/ItemSubResourceListRequiredTaxonomy"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "allowedActions":{
            "type":"array",
            "description":"allowedActions on Type.",
            "items":{
                "type":"string",
                "enum":[
                    "preview",
                    "read",
                    "write",
                    "update",
                    "delete"
                ]
            }
        },
        "connectorInfos":{
            "type":"array",
            "description":"connectorInfos on Type.",
            "items":{
                "$ref":"#/definitions/ConnectorInfo"
            }
        },
        "archivedFields":{
            "$ref":"#/definitions/ItemSubResourceListTypeField"
        },
        "relationships":{
            "$ref":"#/definitions/ItemSubResourceTypeRelationships"
        },
        "jobToken":{
            "type":"string",
            "description":"job token of the background job updating the Type."
        }
    },
    "description":"AggregatedType"
}

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

型: array

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

ソースを表示

• Array of: object ResultHTTPHeader
  ResultHTTPHeader

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

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

型: object

ResultHTTPStatus

ソースを表示

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

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

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

型: array

タイプのallowedActions。

ソースを表示

• Array of: string
  許容値: [ "preview", "read", "write", "update", "delete" ]

{
    "type":"array",
    "description":"allowedActions on Type.",
    "items":{
        "type":"string",
        "enum":[
            "preview",
            "read",
            "write",
            "update",
            "delete"
        ]
    }
}

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

型: array

タイプでサポートされているファイル拡張子の許可されたリスト。 これはレスポンス取得の必須プロパティです。 ポスト/プット・リクエストではオプションで、typeCategoryがContentTypeの場合は[ContentItem]にデフォルト設定され、typeCategoryがDigitalAssetTypeの場合は空にデフォルト設定されます。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Allowed list of file extensions supported by the type. It is a required property in the get response. It is optional in post/put request and defaults to [ContentItem] if the typeCategory is ContentType and defaults to empty if the typeCategory is DigitalAssetType .",
    "items":{
        "type":"string"
    }
}

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

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

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

型: array

タイプのconnectorInfos。

ソースを表示

• Array of: object ConnectorInfo
  ConnectorInfo

{
    "type":"array",
    "description":"connectorInfos on Type.",
    "items":{
        "$ref":"#/definitions/ConnectorInfo"
    }
}

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

型: array

タイプで使用されるフィールド。

ソースを表示

• Array of: object TypeField
  FieldInAggrType.

{
    "type":"array",
    "description":"Fields used in the type.",
    "items":{
        "$ref":"#/definitions/TypeField"
    }
}

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

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

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

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

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

型: array

ソースを表示

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

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

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Type specific properties.",
    "additionalProperties":{
        "type":"object"
    }
}

特定のプロパティを入力します。

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

型: object

アイテムSubResource。

ソースを表示

• data(optional): object TypeRelationships
  タイプ関連
• links(optional): array links
• totalResults(optional): integer(int32)

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

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

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

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

型: array

ソースを表示

• Array of: object TypeField
  FieldInAggrType.

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

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

型: array

ソースを表示

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

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

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

型: object

FieldInAggrType.

ソースを表示

• apiName(optional): string
  フィールドのAPI名。
• archivedBy(optional): string
  アーカイブしました。
• archivedDate(optional): object date
  date
• datatype(optional): string
  許容値: [ "number", "long", "decimal", "text", "largetext", "reference", "datetime", "boolean" ]

  データ型列挙。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• defaultValue(optional): object defaultValue
  フィールドのdefaultValue。
• description(optional): string
  フィールドの説明。
• id(optional): string
  フィールドのid。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isSystemField(optional): boolean
  システムによって提供されるフィールドです。
• name(optional): string
  フィールドの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• properties(optional): object properties
  許可される追加のプロパティ: additionalProperties

  フィールド固有のプロパティ。 publishingDependencyフィールドは、メディアおよび参照に固有です。
• required(optional): boolean
  フィールドの必須またはオプションの値。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• settings(optional): object settings
  許可される追加のプロパティ: additionalProperties

  フィールド固有の設定。
• valuecount(optional): string
  許容値: [ "single", "list" ]

  値は単一またはリストとしてカウントされます。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the field. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"name of the field. It is a required property in the get response and post/put request."
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the field."
        },
        "description":{
            "type":"string",
            "description":"Description of the field."
        },
        "datatype":{
            "type":"string",
            "description":"Data Type Enum. It is a required property in the get response and post/put request.",
            "enum":[
                "number",
                "long",
                "decimal",
                "text",
                "largetext",
                "reference",
                "datetime",
                "boolean"
            ]
        },
        "required":{
            "type":"boolean",
            "description":"Required or optional value for the Field. It is a required property in the get response and post/put request."
        },
        "valuecount":{
            "type":"string",
            "description":"Value count as a single or list. It is a required property in the get response and post/put request.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValue":{
            "type":"object",
            "description":"defaultValue for field."
        },
        "isSystemField":{
            "type":"boolean",
            "description":"Is the field provided by the system."
        },
        "properties":{
            "type":"object",
            "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
            "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "settings":{
            "type":"object",
            "description":"Field specific settings.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "archivedBy":{
            "type":"string",
            "description":"Archived by."
        },
        "archivedDate":{
            "description":"date and time Field archivedAt",
            "$ref":"#/definitions/date"
        }
    },
    "description":"FieldInAggrType."
}

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

型: object

フィールドのdefaultValue。

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
    "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
    "additionalProperties":{
        "type":"object"
    }
}

フィールド固有のプロパティ。 publishingDependencyフィールドは、メディアおよび参照に固有です。

例:

{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Field specific settings.",
    "additionalProperties":{
        "type":"object"
    }
}

フィールド固有の設定。

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

型: object

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

型: object

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

型: object

ConnectorInfo

ソースを表示

• connectorId(optional): string
  コネクタのId。
• connectorSyncEnabled(optional): boolean
  コネクタの同期ステータス。

{
    "type":"object",
    "properties":{
        "connectorId":{
            "type":"string",
            "description":"id of the connector."
        },
        "connectorSyncEnabled":{
            "type":"boolean",
            "description":"Sync status of connector."
        }
    },
    "description":"ConnectorInfo"
}

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

型: array

ソースを表示

• Array of: object InplacePreview
  InplacePreview

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

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

型: array

ソースを表示

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

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

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

型: object

InplacePreview

ソースを表示

• isSiteExternal(optional): boolean
• pageId(optional): string
• pageName(optional): string
• pageUrl(optional): string
• siteId(optional): string
• siteName(optional): string
• typeId(optional): string

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "pageId":{
            "type":"string"
        },
        "isSiteExternal":{
            "type":"boolean"
        },
        "siteName":{
            "type":"string"
        },
        "pageName":{
            "type":"string"
        },
        "pageUrl":{
            "type":"string"
        }
    },
    "description":"InplacePreview"
}

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

型: array

ソースを表示

• Array of: object LayoutMapping
  LayoutMapping

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

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

型: array

ソースを表示

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

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

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

型: object

LayoutMapping

ソースを表示

• apiName(optional): string
  レイアウトの名前。
• formats(optional): object formats
  許可される追加のプロパティ: additionalProperties

  レイアウト形式。
• generateRendition(optional): boolean
  generateRendition.
• id(optional): integer(int64)
  レイアウト・マッピングのID。
• label(optional): string
  レイアウト・マッピングのカテゴリの名前です。

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Name of the category for layout mapping."
        },
        "apiName":{
            "type":"string",
            "description":"Name of the layout."
        },
        "formats":{
            "type":"object",
            "description":"layout formats.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "generateRendition":{
            "type":"boolean",
            "description":"generateRendition."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Id of the layout mapping."
        }
    },
    "description":"LayoutMapping"
}

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

型: object

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

ソースを表示

• string

{
    "type":"object",
    "description":"layout formats.",
    "additionalProperties":{
        "type":"string"
    }
}

レイアウト形式。

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

型: object

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

型: object

タイプ関連

ソースを表示

• references(optional): array references
  一意のアイテムが必要: true

  参照タイプ名/ID

{
    "type":"object",
    "properties":{
        "references":{
            "type":"array",
            "description":"Reference type names/ids",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/TypeReferences"
            }
        }
    },
    "description":"Type Relationships"
}

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

型: array

ソースを表示

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

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

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

型: array

一意のアイテムが必要: true

参照タイプ名/ID

ソースを表示

• Array of: object TypeReferences
  型参照Bean

{
    "type":"array",
    "description":"Reference type names/ids",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/TypeReferences"
    }
}

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

型: object

型参照Bean

ソースを表示

• id(optional): string
  型のID
• links(optional): array links
• name(optional): string
  型の名前

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the type"
        },
        "name":{
            "type":"string",
            "description":"name of the type"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Type References bean"
}

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

型: array

ソースを表示

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

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

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

型: array

ソースを表示

• Array of: object RequiredTaxonomy

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

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

型: array

ソースを表示

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

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

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

型: object

ソースを表示

• defaultCategories(optional): array defaultCategories
• description(optional): string
  読取り専用: true
• id(optional): string
• name(optional): string
  読取り専用: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "defaultCategories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Category"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object Category

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

ネストされたスキーマ : カテゴリ

型: object

ソースを表示

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

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

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

型: object

ResultHTTPHeader

ソースを表示

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

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

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

409レスポンス

競合

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してGETリクエストを発行することによってタイプ更新操作のステータスを読み取る方法を示しています。

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/types/{name}/updateType/.status/{statusId}'

例1

これは、操作IDを持つ指定された{typename}の正常なタイプ更新操作のステータスを読み取ります: OP4C2BA99B626B4E43A4A64853D639F4CA。

/content/management/api/v1.1/types/{typename}/updateType/.status/OP4C2BA99B626B4E43A4A64853D639F4CA

レスポンス本文

{
        "id": "OPE0ED029409F14E2FA6BE244D7BE0C1E9",
        "startTime": {
          "value": "2020-04-25T00:08:55.712Z",
          "timezone": "UTC"
        },
        "endTime": {
          "value": "2020-04-25T00:08:56.264Z",
          "timezone": "UTC"
        },
        "progress": "succeeded",
        "completed": true,
        "message": "Job Completed Successfully",
        "completedPercentage": 100,
        "result": {
          "status": {
            "code": 200,
            "reason": ""
          },
          "headers": [],
          "body": {
            "id": "698DADAFDD0841F38DD9FE9A4D38DA8C",
            "name": "Type1",
            "description": "",
            "typeCategory": "ContentType",
            "createdBy": "swebcli.SitesAdmin1.admin",
            "createdDate": {
              "value": "2020-04-22T03:01:59.188Z",
              "timezone": "UTC"
            },
            "updatedBy": "swebcli.SitesAdmin1.admin",
            "updatedDate": {
              "value": "2020-04-25T00:08:56.023Z",
              "timezone": "UTC"
            },
            "fields": [
              {
                "id": "15560059AEB7487D95FDDB610EE03EE3",
                "name": "field1",
                "description": "field1",
                "datatype": "text",
                "required": true,
                "valuecount": "single",
                "defaultValue": "This is the default value for the field1",
                "properties": {
                  "caas-translation": {
                    "note": "",
                    "translate": true
                  }
                },
                "settings": {
                  "groupIndex": 0,
                  "caas": {
                    "description": "",
                    "valuecountRange": null,
                    "customValidators": [],
                    "editor": {
                      "name": "textbox",
                      "options": {}
                    }
                  }
                }
              },
              {
                "id": "E70C7D179A8A4A6F9C920C4F14177AA7",
                "name": "field2",
                "description": "field2",
                "datatype": "text",
                "required": false,
                "valuecount": "single",
                "properties": {
                  "caas-translation": {
                    "note": "",
                    "translate": false
                  }
                },
                "settings": {
                  "groupIndex": 0,
                  "caas": {
                    "description": "",
                    "valuecountRange": null,
                    "customValidators": [],
                    "editor": {
                      "name": "textbox",
                      "options": {}
                    }
                  }
                }
              },
              {
                "id": "2B63F14BDCE54C768AED77C92EAF82D4",
                "name": "field3",
                "description": "field3",
                "datatype": "text",
                "required": true,
                "valuecount": "single",
                "properties": {
                  "caas-translation": {
                    "inheritFromMaster": true,
                    "note": "",
                    "translate": false
                  }
                },
                "settings": {
                  "groupIndex": 0,
                  "caas": {
                    "description": "",
                    "valuecountRange": null,
                    "customValidators": [],
                    "editor": {
                      "name": "textbox",
                      "options": {}
                    }
                  }
                }
              },
              {
                "id": "7353DFA594B64A80A5527F7765032F74",
                "name": "field4",
                "description": "field4",
                "datatype": "text",
                "required": false,
                "valuecount": "single",
                "properties": {
                  "caas-translation": {
                    "inheritFromMaster": true,
                    "note": "",
                    "translate": false
                  }
                },
                "settings": {
                  "groupIndex": 0,
                  "caas": {
                    "description": "",
                    "valuecountRange": null,
                    "customValidators": [],
                    "editor": {
                      "name": "textbox",
                      "options": {}
                    }
                  }
                }
              }
            ],
            "properties": {
              "caas": {
                "slug": {
                  "enabled": false,
                  "pattern": "-{name}"
                }
              },
              "customEditors": [],
              "groups": [
                {
                  "title": "Content Item Data Fields",
                  "collapse": false
                }
              ]
            },
            "roleName": "manager",
            "links": [
              {
                "href": "https://<hostname>/content/management/api/v1.1/types/Type1",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              },
              {
                "href": "https://<hostname>/content/management/api/v1.1/types/Type1",
                "rel": "canonical",
                "method": "GET",
                "mediaType": "application/json"
              },
              {
                "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types/Type1",
                "rel": "describedby",
                "method": "GET",
                "mediaType": "application/schema+json"
              }
            ],
            "allowedActions": [
              "preview",
              "read",
              "write",
              "update",
              "delete"
            ]
          }
        },
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/types/Type1/updateType/.status/OPE0ED029409F14E2FA6BE244D7BE0C1E9",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/types/Type1/updateType/.status/OPE0ED029409F14E2FA6BE244D7BE0C1E9",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/types/Type1/updateType/.status/OPE0ED029409F14E2FA6BE244D7BE0C1E9",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
    }
     

先頭に戻る