ジャンプ先

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

接続の詳細の取得

get

/api/20210901/catalog/connections/{connectionId}

指定されたIDの既存の接続の詳細を返します。たとえば、所有者、名前、説明、ID、最終変更日、オブジェクト・タイプ、親IDなどの詳細です。'content'が問合せパラメータ'fields'を介してリクエストされた場合、接続'content'も返されます。

リクエスト

パス・パラメータ

• connectionId(必須): string(byte)
  Base64エンコーディングを使用した接続のID。たとえば、接続にオブジェクトID 'user'.'connId'がある場合、Base64でエンコードされた値J3VzZXInLidjb25uSWQnを入力します

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功した操作。

本文()

ルート・スキーマ: schema

Type: object

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。

本文()

ルート・スキーマ: Error

Type: object

ソースを表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

先頭に戻る