機械翻訳について

ジャンプ先

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

マーケティング・ソース・コードの更新

patch

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/sourceCodes/{leads_sourceCodes_Id}

リクエスト

パス・パラメータ

• leadsUniqID(required): string
  これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。
• leads_sourceCodes_Id(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

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: true

  このソース・コードのアクティブまたは非アクティブ・ステータスを示します。
• CampaignId: integer
  タイトル: Campaign ID

  このソース・コードに関連付けられたキャンペーンの一意の識別子。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  コミット時ロックを実装するために使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
• SourceCodeId: integer (int64)
  タイトル: Source Code ID

  ソース・コードの一意の識別子。

{
    "type":"object",
    "properties":{
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign associated with this source code.",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates an active or inactive status of this source code.",
            "nullable":true,
            "default":true
        },
        "SourceCodeId":{
            "title":"Source Code ID",
            "type":"integer",
            "description":"The unique identifier of the source code.",
            "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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : leads-sourceCodes-item-response

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: true

  このソース・コードのアクティブまたは非アクティブ・ステータスを示します。
• CampaignId: integer
  タイトル: Campaign ID

  このソース・コードに関連付けられたキャンペーンの一意の識別子。
• CampaignName: string
  タイトル: Campaign

  読取り専用: true

  最大長: 250

  このソース・コードに関連付けられたキャンペーンの名前。
• CampaignUsage: string
  タイトル: Campaign Type

  読取り専用: true

  最大長: 30

  ソース・コードに関連付けられたキャンペーン使用です。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  このソース・コード・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  このレコードが作成された日時。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  Who列: 行の最終更新日時を示します。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  Who列: 行の最終更新ユーザーを示します。
• LastUpdateLogin: string
  タイトル: Last Updated Login

  読取り専用: true

  最大長: 32

  Who列: 行を最後に更新したユーザーに関連付けられたセッション・ログインを示します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  タイトル: Object Version Number

  コミット時ロックを実装するために使用されます。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
• SourceCode: string
  タイトル: Source Code

  最大長: 100

  このレコードを表すソース・コード。
• SourceCodeId: integer (int64)
  タイトル: Source Code ID

  ソース・コードの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCode":{
            "title":"Source Code",
            "maxLength":100,
            "type":"string",
            "description":"The source code that represents this record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceCodeId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created this source code record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign",
            "maxLength":250,
            "type":"string",
            "description":"The name of the campaign associated with this source code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates an active or inactive status of this source code.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "CampaignUsage":{
            "title":"Campaign Type",
            "maxLength":30,
            "type":"string",
            "description":"Campaign Usage associated with source code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign associated with this source code.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCodeId":{
            "title":"Source Code ID",
            "type":"integer",
            "description":"The unique identifier of the source code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "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."
        }
    }
}

「トップに戻る」