機械翻訳について

移動先

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

特定バージョンの取得

get

/documents/api/{version}

指定したバージョンのAPIに関する情報を取得します。 バージョン・リソースは、使用可能なすべてのバージョン、または特定のバージョンのAPI自体に関する情報を提供します。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• version: string
  バージョン値

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

リクエストが処理されました。

本文 ()

ルート・スキーマ: VersionDefinition

タイプ: object

バージョン情報。

ソースを表示

• catalog(optional): object APILinks
  APIリンク情報。
• isLatest(optional): string
  最新のバージョンであるか(true)、そうでないか(false)を示します。
• lifecycle(optional): string
  このバージョンがactiveかdeprecatedかを示します。 デフォルト値はactiveです。

• links(optional): array links
  リンクのリスト。
• terminationDate(optional): string
  バージョンのサポートがいつ終了するかを示します。
• version(optional): string
  バージョン識別子。

{
    "description":"Version information.",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version identifier."
        },
        "lifecycle":{
            "type":"string",
            "description":"Indicates whether the version is <code>active</code> or <code>deprecated</code>. The default value is <code>active</code>.</p>"
        },
        "isLatest":{
            "type":"string",
            "description":"Indicates whether it is the latest version (<code>true</code>) or not (<code>false</code>)."
        },
        "terminationDate":{
            "type":"string",
            "description":"Indicates when the version will no longer be supported."
        },
        "catalog":{
            "$ref":"#/definitions/APILinks"
        },
        "links":{
            "type":"array",
            "description":"List of Links.",
            "items":{
                "$ref":"#/definitions/APILinks"
            }
        }
    }
}

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

タイプ: object

APIリンク情報。

ソースを表示

• href(optional): string
  リソースを一意に定義する完全なURL。
• ref(optional): string
  関係。

{
    "description":"API links information.",
    "properties":{
        "ref":{
            "type":"string",
            "description":"Relationship."
        },
        "href":{
            "type":"string",
            "description":"Complete URL that uniquely defines the resource."
        }
    }
}

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

タイプ: array

リンクのリスト。

ソースを表示

• Array of: object APILinks
  APIリンク情報。

{
    "type":"array",
    "description":"List of Links.",
    "items":{
        "$ref":"#/definitions/APILinks"
    }
}

レスポンスの例(application/json)

{
    "items":[
        {
            "version":"1.2",
            "lifecycle":"active",
            "isLatest":"true",
            "catalog":{
                "links":[
                    {
                        "ref":"canonical",
                        "href":"https://www.example.com/documents/api/1.2/metadata-catalog"
                    }
                ]
            },
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2"
                }
            ]
        }
    ]
}

トップに戻る

例

次の例は、指定されたバージョンのAPIに関する情報を返します。

GET .../api/1.2

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "version": "1.2",
    "lifecycle": "active",
    "isLatest": true,
    "catalog": {
        "links": [
            {
                "ref": "canonical",
                "href": "https://www.example.com/documents/api/1.2/metadata-catalog"
            }
        ]
    },
    "links": [
        {
            "ref": "canonical",
            "href": "https://www.example.com/documents/api/1.2"
        }
    ]
}

先頭に戻る