機械翻訳について

ジャンプ先

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

シグネチャの更新

patch

/crmRestApi/resources/11.13.18.05/signatures/{SignatureNumber}

リクエスト

パス・パラメータ

• SignatureNumber(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• ChannelId: integer (int64)
  タイトル: Channel ID

  シグネチャに関連付けられたチャネルの一意の識別子。
• DefaultFlag: boolean
  タイトル: Default Flag

  最大長: 1

  デフォルト値: true

  シグネチャがデフォルトのシグネチャかどうかを示します。
• SignatureContent: 文字列(バイト)
  タイトル: Signature Content

  シグネチャの内容。
• SignatureName: string
  タイトル: Signature Name

  最大長: 50

  シグネチャの名前。
• UserPartyId: integer (int64)
  タイトル: User Party ID

  シグネチャに関連付けられたユーザーの一意のパーティ識別子。

{
    "type":"object",
    "properties":{
        "SignatureContent":{
            "title":"Signature Content",
            "type":"string",
            "description":"The content of the signature.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "DefaultFlag":{
            "title":"Default Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the signature is the default signature.",
            "nullable":false,
            "default":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated to a signature.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SignatureName":{
            "title":"Signature Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the signature.",
            "nullable":false
        },
        "UserPartyId":{
            "title":"User Party ID",
            "type":"integer",
            "description":"The unique party identifier of the user who associated to a signature.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : signatures-item-response

タイプ: object

ソースを表示

• ChannelId: integer (int64)
  タイトル: Channel ID

  シグネチャに関連付けられたチャネルの一意の識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  シグネチャを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  シグネチャ・レコードが作成された日付。
• DefaultFlag: boolean
  タイトル: Default Flag

  最大長: 1

  デフォルト値: true

  シグネチャがデフォルトのシグネチャかどうかを示します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  シグネチャが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  シグネチャを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  シグネチャを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• SignatureContent: 文字列(バイト)
  タイトル: Signature Content

  シグネチャの内容。
• SignatureId: integer (int64)
  タイトル: Signature ID

  読取り専用: true

  シグネチャの一意の識別子。
• SignatureName: string
  タイトル: Signature Name

  最大長: 50

  シグネチャの名前。
• SignatureNumber: string
  タイトル: Signature Number

  最大長: 30

  シグネチャの代替キー識別子。
• UserPartyId: integer (int64)
  タイトル: User Party ID

  シグネチャに関連付けられたユーザーの一意のパーティ識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the signature.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the signature record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the signature.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated to a signature.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SignatureId":{
            "title":"Signature ID",
            "type":"integer",
            "description":"The unique identifier of the signature.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SignatureContent":{
            "title":"Signature Content",
            "type":"string",
            "description":"The content of the signature.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "SignatureName":{
            "title":"Signature Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the signature.",
            "nullable":false,
            "x-queryable":true
        },
        "SignatureNumber":{
            "title":"Signature Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the signature.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "title":"Default Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the signature is the default signature.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "UserPartyId":{
            "title":"User Party ID",
            "type":"integer",
            "description":"The unique party identifier of the user who associated to a signature.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the signature was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」