機械翻訳について

移動先

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

タイプのすべてのアーカイブ済のリストフィールド

get

/content/management/api/v1.1/types/{name}/archivedFields

タイプのすべてのアーカイブ済フィールドをリストします。

リクエスト

パス・パラメータ

• name: string
  型名識別子は大/小文字が区別され、特殊文字はエンコードする必要があります。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : TypeSubResourceListArchivedFields

型: object

ArchivedFields

ソースを表示

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

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

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

型: object

date

ソースを表示

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

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

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

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る