機械翻訳について

移動

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

コンテンツ・プレビューAPIの使用可能なバージョンを取得

get

/content/preview/api

利用可能なAPIのバージョンに関する情報を返します。
これはコレクション・リソースであり、コレクション内の各アイテムはバージョン・リソースです。

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

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

リクエスト

問合せパラメータ

• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。 制限に使用できる最大値は500です。

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

  デフォルト値: 0
• totalResults(optional): boolean
  ブール値を受け入れます。 Trueに設定すると、レスポンスの結果フィールド合計が表示されます。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : CollectionProperties

型: object

CollectionProperties.

Show Source

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンスのレコードの合計数。
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• properties(optional): object properties
  許可される追加プロパティ: additionalProperties

  追加のコレクション・プロパティ。
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "properties":{
            "type":"object",
            "description":"additional collection properties.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "type":"object"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"CollectionProperties."
}

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

型: array

集計結果。

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

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

型: array

コレクションに含まれる特異なリソース。

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "type":"object"
    }
}

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

型: array

リソースのリンク。

Show Source

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

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

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

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

型: object

使用可能なその他のプロパティ

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"additional collection properties.",
    "additionalProperties":{
        "type":"object"
    }
}

追加のコレクション・プロパティ。

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

型: object

Show Source

• name(optional): string
  読取り専用: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

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

型: object

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

型: 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."
}

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

型: object

403レスポンス

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

500レスポンス

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

トップに戻る

例

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行して、使用可能なバージョンのPreview APIを取得する方法を示しています:

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

コンテンツ・プレビューAPIの使用可能なバージョンを読み取ります。

レスポンス本文

{
        "offset": 0,
        "limit": 1,
        "count": 1,
        "hasMore": false,
        "links": [
          {
            "href": "https://<hostname>/content/preview/api",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/metadata-catalog",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/preview/api?offset=0",
            "rel": "first"
          },
          {
            "href": "https://<hostname>/content/preview/api?offset=0",
            "rel": "last"
          }
        ],
        "aggregationResults": null,
        "items": [
          {
            "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": "canonical",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ]
      }

トップに戻る