移動先

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

資格証明入力ソースの更新

patch

/api/v2/credential_input_sources/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、この資格証明入力ソースを更新します。次のフィールドを変更できます。

• description: この資格証明入力ソースのオプションの説明。(文字列、デフォルト="")
• input_field_name: (文字列、必須)
• metadata: (json、デフォルト={})
• target_credential: (id、必須)
• source_credential: (id、必須)

PATCHリクエストの場合は、変更中のフィールドのみを含めます。

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : CredentialInputSource

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• input_field_name(必須): 文字列
  タイトル: Input field name

  最小長: 1

  最大長: 1024
• metadata: オブジェクト Metadata
  タイトル: Metadata
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• related: 文字列
  タイトル: Related

  読取り専用: true
• source_credential(必須): 整数
  タイトル: Source credential
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• target_credential(必須): 整数
  タイトル: Target credential
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "input_field_name":{
            "maxLength":"1024",
            "minLength":"1",
            "title":"Input field name",
            "type":"string",
            "x-nullable":true
        },
        "metadata":{
            "title":"Metadata",
            "type":"object"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "source_credential":{
            "title":"Source credential",
            "type":"integer",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "target_credential":{
            "title":"Target credential",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "input_field_name",
        "target_credential",
        "source_credential"
    ],
    "type":"object"
}

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

型: object

タイトル: Metadata

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : CredentialInputSource

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• input_field_name(必須): 文字列
  タイトル: Input field name

  最小長: 1

  最大長: 1024
• metadata: オブジェクト Metadata
  タイトル: Metadata
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• related: 文字列
  タイトル: Related

  読取り専用: true
• source_credential(必須): 整数
  タイトル: Source credential
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• target_credential(必須): 整数
  タイトル: Target credential
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "input_field_name":{
            "maxLength":"1024",
            "minLength":"1",
            "title":"Input field name",
            "type":"string",
            "x-nullable":true
        },
        "metadata":{
            "title":"Metadata",
            "type":"object"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "source_credential":{
            "title":"Source credential",
            "type":"integer",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "target_credential":{
            "title":"Target credential",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "input_field_name",
        "target_credential",
        "source_credential"
    ],
    "type":"object"
}

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

型: object

タイトル: Metadata

先頭に戻る