機械翻訳について

移動先

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

タイプの作成

post

/content/management/api/v1.1/types

指定されたペイロードでタイプを作成します。

リクエスト

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

• application/json

問合せパラメータ

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

ヘッダー・パラメータ

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

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内に指定の情報でタイプを作成します。 型の名前は、大/小文字が区別されません、つまり、既存の型名を使用した型は作成できません。 ペイロード内に指定されている場合でも、id, createdBy, createdDate, updatedBy, updatedDateおよびlinksフィールドは無視されます。

ルート・スキーマ : タイプ

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

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

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

型: object

date

ソースを表示

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

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

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

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

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

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : タイプ

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

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

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

型: object

date

ソースを表示

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

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

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

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

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

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/types'

例1:

これにより、単純型が作成されます。 ペイロードを独自のデータで置換します。

/content/management/api/v1.1/types

リクエスト・ペイロード

 {
  "name": "Book_1",
  "apiName": "book1",
  "displayName": "Book_1Display",
  "description": "Book_1 description."
}

例2:

これにより、単一値のオプションのテキスト・フィールドを持つ型が作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Book_2",
  "displayName": "Book_2Display",
  "apiName": "book2",
  "typeCategory": "ContentType",
  "description": "Book_2 description.",
  "fields": [
    {
      "name": "title",
      "apiName": "title",
      "description": "Text field",
      "datatype": "largetext",
      "required": false,
      "valuecount": "single"
    }
  ]
}

例3

これにより、複数値のオプションのテキスト・フィールドを持つ型が作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Book_3",
  "displayName": "Book_3Display",
  "apiName": "book3",
  "description": "Book_3 description.",
  "fields": [
    {
      "name": "title",
      "apiName": "title",
      "description": "Text field",
      "datatype": "largetext",
      "required": false,
      "valuecount": "list"
    }
  ]
}

例4

これにより、単一値の必須数値フィールドを持つ型が作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Book_4",
  "displayName": "Book_4",
  "apiName": "book4",
  "description": "Book_4 description.",
  "fields": [
    {
      "name": "volume",
      "apiName": "volume",
      "description": "Number Field",
      "datatype": "number",
      "required": true,
      "valuecount": "single"
    }
  ]
}

例5

これにより、他の既存のtype(Book_4)を参照する必須の参照フィールドを持つタイプが作成されます。Book_4はシステム内の既存のタイプです。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Author",
  "displayName": "AuthorDisplay",
  "apiName": "author",
  "description": "Author description.",
  "fields": [
    {
      "name": "collection",
      "apiName": "collection",
      "description": "referenceField",
      "datatype": "reference",
      "required": true,
      "valuecount": "list",
      "properties": {},
      "settings": {},
      "referenceType": {
        "type": "Book_4",
        "typeCategory": "ContentType"
      }
    }
  ]
}

例6

これにより、typeCategoryの必要な参照MyImageを持つ型が作成されます : DigitalAssetType. ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "referenceType",
  "displayName": "referenceTypeDisplay",
  "apiName": "referenceType",
  "description": "referenceType description",
  "fields": [
    {
      "name": "media",
      "apiName": "media",
      "datatype": "reference",
      "referenceType": {
        "type": "MyImage"
      },
      "valuecount": "single",
      "required": true
    }
  ]
}

例7

これにより、publishingDependencyを必須とするオプションの参照を持つ型が作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "referenceType-pubDep-required",
  "displayName": "refType-pubDep-required_Display",
  "apiName": "referenceTypePubDepRequired",
  "description": "referenceType-pubDep-required description",
  "fields": [
    {
      "name": "media",
      "apiName": "media",
      "datatype": "reference",
      "required": true,
      "valuecount": "single",
      "properties": {
        "publishingDependency": "required"
      },
      "settings": {},
      "referenceType": {
        "type": null,
        "types": []
      }
    }
  ]
}

例8

これにより、publishingDependencyをオプションにした必須の参照DigitalAssetを持つ型が作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "referenceType-pubDep-optional",
  "displayName": "refType-pubDep-optional_Display",
  "apiName": "referenceTypePubDepOptional",
  "description": "referenceType-pubDep-optional description",
  "fields": [
    {
      "name": "media",
      "apiName": "media",
      "datatype": "reference",
      "required": true,
      "valuecount": "single",
      "properties": {
        "publishingDependency": "optional"
      },
      "settings": {},
      "referenceType": {
        "type": "DigitalAsset"
      }
    }
  ]
}

例9

これにより、単一値の必須数値フィールドと単一値のオプション・テキスト・フィールドを持つタイプが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Book_5",
  "displayName": "Book_5_Display",
  "apiName": "book5",
  "description": "Book_5 description.",
  "fields": [
    {
      "name": "title",
      "apiName": "title",
      "description": "Text field",
      "datatype": "largetext",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "volume",
      "apiName": "volume",
      "description": "Number Field",
      "datatype": "number",
      "required": true,
      "valuecount": "single"
    }
  ]
}

例10

これにより、他の既存のtype(Book_4)を参照する参照フィールドを持つタイプAuthorが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Author",
  "displayName": "Author_Display",
  "apiName": "author",
  "description": "Author description.",
  "fields": [
    {
      "name": "subject",
      "apiName": "subject",
      "description": "Text field",
      "datatype": "largetext",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "collection",
      "apiName": "collection",
      "description": "referenceField",
      "datatype": "reference",
      "required": true,
      "valuecount": "list",
      "properties": {},
      "settings": {},
      "referenceType": {
        "type": "Book_4"
      }
    }
  ]
}

例11

これにより、1つのオプション・フィールドである参照フィールドを持つタイプ作成者が作成されます。参照フィールドは、他の既存のタイプとデジタル・アセット参照フィールドを参照します。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Author",
  "apiName": "author",
  "displayName": "Author_Display",
  "description": "Author description.",
  "fields": [
    {
      "name": "subject",
      "apiName": "subject",
      "description": "Text field",
      "datatype": "largetext",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "collection",
      "apiName": "collection",
      "description": "referenceField",
      "datatype": "reference",
      "required": true,
      "valuecount": "list",
      "properties": {},
      "settings": {},
      "referenceType": {
        "type": "Book_4",
        "typeCategory": "ContentType"
      }
    },
    {
      "name": "profilePic",
      "apiName": "profilePic",
      "datatype": "reference",
      "referenceType": {
        "type": "DigitalAsset",
        "typeCategory": "DigitalAssetType"
      },
      "valuecount": "single",
      "required": false
    }
  ]
}

例12

これにより、1つのオプション・フィールド(スキーマのないjsonフィールド)を持つタイプAuthorが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Author",
  "displayName": "Author_Display",
  "apiName": "author",
  "description": "Author description.",
  "fields": [
    {
      "name": "otherDetails",
      "apiName": "otherDetails",
      "description": "json field",
      "datatype": "json",
      "required": false,
      "valuecount": "single"
    }
  ]
}

例13

これにより、1つの必須フィールド(スキーマを持つjsonフィールド)を持つタイプAuthorが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Author",
  "displayName": "Author_Display",
  "apiName": "author",
  "description": "Author description.",
  "fields": [
    {
      "name": "otherDetails",
      "apiName": "otherDetails",
      "description": "json field",
      "datatype": "json",
      "required": true,
      "valuecount": "single",
      "jsonSchema": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "title": "Sample Object schema",
        "type": "object",
        "properties": {
          "string_attr": {
            "type": "string"
          },
          "number_attr": {
            "type": "number"
          },
          "integer_attr": {
            "type": "integer"
          },
          "boolean_attr": {
            "type": "boolean"
          },
          "list_attr": {
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "object_attr": {
            "type": "object"
          }
        }
      }
    }
  ]
}

例14

これにより、単純なデジタル・タイプが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Invoices",
  "displayName": "InvoicesDisplay",
  "description": "Invoices description.",
  "typeCategory": "DigitalAssetType",
  "allowedFileTypes": [
    "pdf"
  ]
}

例15

これにより、複数のfields(digital type supports all fields supported by content type, here mentioning only few)を持つデジタル・タイプが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Invoices",
  "displayName": "MyInvoices",
  "description": "Invoices description.",
  "typeCategory": "DigitalAssetType",
  "allowedFileTypes": [
    "pdf"
  ],
  "fields": [
    {
      "name": "title",
      "description": "title field",
      "datatype": "text",
      "required": true,
      "valuecount": "single"
    },
    {
      "name": "detail",
      "description": "detail field",
      "datatype": "largetext",
      "required": false,
      "valuecount": "multi"
    },
    {
      "name": "invoice date",
      "description": "invoice date field",
      "datatype": "datetime",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "count",
      "description": "count field",
      "datatype": "number",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "percentage",
      "description": "percentage field",
      "datatype": "decimal",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "verified",
      "description": "verified field",
      "datatype": "boolean",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "address",
      "description": "address field",
      "datatype": "json",
      "required": false,
      "valuecount": "single"
    },
    {
      "name": "media",
      "apiName": "media",
      "datatype": "reference",
      "referenceType": {
        "type": "MyImage"
      },
      "valuecount": "single",
      "required": false
    },
    {
      "name": "collection",
      "apiName": "collection",
      "description": "referenceField",
      "datatype": "reference",
      "required": true,
      "valuecount": "list",
      "properties": {},
      "settings": {},
      "referenceType": {
        "type": "Book_4"
      }
    }
  ]
}

例16

ペイロードにallowedFileTypesノードがないため、単純なデジタル型の作成中にエラーが返されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Invoices",
  "displayName": "MyInvoices",
  "description": "Invoices description.",
  "typeCategory": "DigitalAssetType"
}

例17

これにより、わかりやすいURLが有効になり、ファイル共有が有効になっている単純なデジタル・タイプが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Invoices",
  "displayName": "InvoicesDisplay",
  "description": "Invoices description.",
  "typeCategory": "DigitalAssetType",
  "allowedFileTypes": [
    "pdf"
  ],
  "properties": {
    "caas": {
      "slug": {
        "enabled": true,
        "allow-forward-slash": true,
        "pattern": "invoices-{name}"
      }
    },
    "caas-translations": {
      "description": {
        "inheritFromMaster": false,
        "note": "",
        "translate": true
      },
      "file": {
        "inheritFromMaster": true,
        "note": "",
        "translate": false
      },
      "name": {
        "inheritFromMaster": false,
        "note": "",
        "translate": true
      },
      "slug": {
        "inheritFromMaster": false,
        "note": "",
        "translate": true
      }
    }
  }
}

リクエスト・ヘッダー

{
  "Content-Type": "application/json",
  "X-Requested-With": "XMLHttpRequest"
}

例18

これにより、わかりやすいURLが有効になり、ファイル共有が無効になっている単純なデジタル・タイプが作成されます。 ペイロードを独自のデータで置換します。

リクエスト・ペイロード

{
  "name": "Invoices",
  "displayName": "InvoicesDisplay",
  "description": "Invoices description.",
  "typeCategory": "DigitalAssetType",
  "allowedFileTypes": [
    "pdf"
  ],
  "properties": {
    "caas": {
      "slug": {
        "enabled": true,
        "allow-forward-slash": true,
        "pattern": "invoices-{name}"
      }
    },
    "caas-translations": {
      "description": {
        "inheritFromMaster": false,
        "note": "",
        "translate": true
      },
      "file": {
        "inheritFromMaster": false,
        "note": "",
        "translate": true
      },
      "name": {
        "inheritFromMaster": false,
        "note": "",
        "translate": true
      },
      "slug": {
        "inheritFromMaster": false,
        "note": "",
        "translate": true
      }
    }
  }
}

リクエスト・ヘッダー

{
  "Content-Type": "application/json",
  "X-Requested-With": "XMLHttpRequest"
}

例19

これにより、2つの必須タクソノミを持つタイプが作成され、1つのタクソノミにデフォルト・カテゴリが割り当てられます。 タクソノミおよびカテゴリはシステムにすでに存在している必要があります。

リクエスト・ペイロード

{
  "name": "ContentTypeWithRequiredTaxonomy",
  "description": "Type with required taxonomy",
  "typeCategory": "ContentType",
  "requiredTaxonomies": {
    "data": [
      {
        "id": "B3A601C4A45D418DA24F88E00CA238CE",
        "defaultCategories": [
          {
            "id": "317AE47B62A54463AA8AAB7DA03AC40E"
          }
        ]
      },
      {
        "id": "5C31CC8E13C941D58A7DD471496FF188"
      }
    ]
  }
}

先頭に戻る