機械翻訳について

移動

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

システムおよびAPI情報

get

/capture/api/v1.1/systemInfo

これは、キャプチャ・システムおよびAPI情報を返す単純な操作です。

リクエスト

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

一般的なContent CaptureシステムおよびREST API情報。

本文()

ルート・スキーマ : システム情報

型: object

タイトル: System Information

このオブジェクトは、バージョンや作成日などの基本的な取得システム情報を定義します。

Show Source

• apiVersion(optional): string

  REST APIの特定のバージョン。 次のようになります: 実際のバージョンに応じて、v1、v1.1、v1.1.1など。 ただし、常にvで始まります。

• buildRevision(optional): string

  REST APIのビルド・バージョン。

• buildTimestamp(optional): string(date-time)

  REST APIビルドの日時(「ISO-8601インスタント」形式(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')は、RFC 3339によって管理されます。

• name(optional): string

  Content Capture REST APIの名前。

{
    "type":"object",
    "title":"System Information",
    "description":"<p>This object defines basic Capture system information, such as version and build date.</p>\n",
    "properties":{
        "name":{
            "type":"string",
            "description":"<p>Name of the Content Capture REST API.</p>\n"
        },
        "apiVersion":{
            "type":"string",
            "description":"<p>The particular version of the REST API. It will resemble something like: <i>v1</i>, <i>v1.1</i>, <i>v1.1.1</i>, etc.\ndepending on the actual version. However, it will always begin with <i>v</i>.</p>\n"
        },
        "buildTimestamp":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date/time of the REST API build in ISO-8601 Instant format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>),\ngoverned by <a href=\"https://datatracker.ietf.org/doc/html/rfc3339\">RFC 3339</a>.</p>\n"
        },
        "buildRevision":{
            "type":"string",
            "description":"<p>The build version of the REST API.</p>\n"
        }
    }
}

500レスポンス

内部サーバー・エラー

サーバーで予期しない状態が発生し、リクエストを処理できませんでした。 レスポンスは「エラーの詳細」オブジェクトになります。

トップに戻る

例

例:

次の例は、CaptureシステムおよびAPI情報を返す方法を示しています。

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

これにより、Content Captureシステム情報が取得されます。

レスポンス本文

{
   "name": "Content Capture REST API",
   "apiVersion": "v1",
   "buildTimestamp": "2021/08/27T11:08:18.245Z",
   "buildRevision": "capture.master.2591.dc8b52245"
 }

トップに戻る