ドキュメント用REST API

機械翻訳について

すべてのバージョンの取得

get

/documents/api/

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

リクエスト

この操作のリクエスト・パラメータはありません。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: VersionsResponse

タイプ: object

レスポンス本文には、APIバージョン操作に関する情報が含まれます。

ソースを表示

links(optional): array links

バージョンのリスト。

{
    "description":"The response body includes information about the API versions operation.",
    "properties":{
        "links":{
            "type":"array",
            "description":"List of Versions.",
            "items":{
                "$ref":"#/definitions/VersionDefinition"
            }
        }
    }
}

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

タイプ: array

バージョンのリスト。

ソースを表示

Array of: object VersionDefinition

バージョン情報。

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

ネストされたスキーマ: 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.0",
            "lifecycle":"active",
            "isLatest":"false",
            "catalog":{
                "links":[
                    {
                        "ref":"canonical",
                        "href":"https://www.example.com/documents/api/1.0/metadata-catalog"
                    }
                ]
            },
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.0"
                }
            ]
        },
        {
            "version":"1.1",
            "lifecycle":"active",
            "isLatest":"false",
            "catalog":{
                "links":[
                    {
                        "ref":"canonical",
                        "href":"https://www.example.com/documents/api/1.1/metadata-catalog"
                    }
                ]
            },
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1"
                }
            ]
        },
        {
            "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

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

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

先頭に戻る