機械翻訳について

移動

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

v1.1 API情報の取得

get

/content/preview/api/v1.1

v1.1 APIに関する情報を返します。
バージョン・リソースには、次のプロパティがあります:

1. version: リソースのバージョン。
2. lifecycle: バージョンがアクティブにサポートされているかサポートされていないか。
3. isLatest: それが最新バージョンかどうか。
4. terminationDate (オプション): 終了日。
5. catalog: そのバージョンでサポートされているすべてのリソースのメタデータ・カタログとして機能する子リソース。

ヘッダー(オプション):

ヘッダー名	ヘッダー値
Accept	application/json

リクエスト

問合せパラメータ

• links(optional): string
  クライアントが結果に必要とするrel (リレーション)リンクのコンマ区切りのリストを受け入れます。 デフォルトでは、リソース内のすべての適用可能なリンクがレスポンスに含まれます。 可能な値は次のとおりです: self, canonical, describedby。
  例: links=self,canonicalは、relプロパティselfまたはcanonicalを持つリンクのみを返します。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : バージョン

型: object

Version.

Show Source

• catalog: object Version
  Version.
• isLatest: boolean
  それが最新バージョンかどうか。
• lifecycle: string
  バージョンがアクティブにサポートされているかサポートされていないか。
• links: array links
  リソースのリンク。
• terminationDate (optional): string(date-time)
  バージョンがもうサポートされないとき。
• version: string
  リソースのバージョン。

{
    "type":"object",
    "required":[
        "catalog",
        "isLatest",
        "lifecycle",
        "links",
        "version"
    ],
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of the resource."
        },
        "lifecycle":{
            "type":"string",
            "description":"Whether a version is actively supported or deprecated."
        },
        "isLatest":{
            "type":"boolean",
            "description":"Whether it is latest version."
        },
        "catalog":{
            "description":"A child resource that serves as a metadata catalog for all the resources supported in the version.",
            "$ref":"#/definitions/Version"
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "terminationDate ":{
            "type":"string",
            "format":"date-time",
            "description":"When a version is not supported anymore."
        }
    },
    "description":"Version."
}

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

型: array

リソースのリンク。

Show Source

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

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

ネストされたスキーマ : リンク

型: object

リソースのリンク。

Show Source

• 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."
}

403レスポンス

禁止。 クライアントはこのリクエストを実行する権限がありません。

500レスポンス

内部サーバー・エラー システムで予期しないエラーが発生しました。

トップに戻る

例

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、v1.1 Preview APIを取得する方法を示しています:

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

これは、v1.1プレビューAPIの情報を読み取ります。

レスポンス本文

{
        "version": "v1.1",
        "lifecycle": "active",
        "isLatest": true,
        "catalog": {
          "links": [
            {
              "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog",
              "rel": "canonical",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

トップに戻る