機械翻訳について

移動先

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

すべてのデータ型を一覧表示

get

/content/management/api/v1.1/dataTypes

すべてのデータ型の情報をリストします。

リクエスト

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : DataTypes

型: object

DataTypes

ソースを表示

• dataTypes(optional): array dataTypes
  dataTypes. リスト
• links(optional): array links
  リンク

{
    "type":"object",
    "properties":{
        "dataTypes":{
            "type":"array",
            "description":"dataTypes. List<DataTypeBean>",
            "items":{
                "$ref":"#/definitions/DataType"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"DataTypes"
}

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

型: array

dataTypes. リスト

ソースを表示

• Array of: object DataType
  DataType

{
    "type":"array",
    "description":"dataTypes. List<DataTypeBean>",
    "items":{
        "$ref":"#/definitions/DataType"
    }
}

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

型: array

リンク

ソースを表示

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

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

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

型: object

DataType

ソースを表示

• datatype(optional): string
• description(optional): string

{
    "type":"object",
    "properties":{
        "datatype":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "description":"DataType"
}

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

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してGETリクエストを送信することによってすべてのタイプを取得する方法を示します。

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/dataTypes'

例:

これには、システムでサポートされているすべてのDataTypesがリストされます。

/content/management/api/v1.1/dataTypes

レスポンス本文

{
    "dataTypes": [
    {
      "datatype": "text",
      "description": "Supports upto 2000 characters"
    },
    {
      "datatype": "largetext",
      "description": "Supports unlimited text"
    },
    {
      "datatype": "number",
      "description": "Supports Supports as signed Integer value with the range of -2,147,483,648 to 2,147,483,647"
    },
    {
      "datatype": "decimal",
      "description": "Supports float or decimal values with the range of approximately ??3.40282347E+38F (6-7 significant decimal digits)"
    },
    {
      "datatype": "boolean",
      "description": "Supports Boolean values of TRUE or FALSE, default value is FALSE for empty"
    },
    {
      "datatype": "reference",
      "description": "Supports the reference relationship to other Item(s)"
    },
    {
      "datatype": "datetime",
      "description": "Supports date and time values"
    },
    {
      "datatype": "location",
      "description": "Supports location data about geo location using longitude and latitude values"
    },
    {
      "datatype": "json",
      "description": "Supports the json type data"
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/dataTypes",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/dataTypes",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/metadata-catalog/dataTypes",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
    ]
    }

先頭に戻る