機械翻訳について

ジャンプ先

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

子分割売上を更新

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/ChildSplitRevenue/{ChildSplitRevenueUniqID}

リクエスト

パス・パラメータ

• ChildRevenueUniqID(required): string
  これは、収益アイテム・リソースの複合キーを構成し、収益アイテムのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、収益アイテムの特定のインスタンスに移動してハッシュ・キーを取得するために、収益アイテム・コレクション・リソースを問い合せる必要があります。
• ChildSplitRevenueUniqID(required): string
  これは、子分割収益リソースの複合キーを構成し、子分割収益のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、子分割売上の特定のインスタンスに移動してハッシュ・キーを取得するために、子分割収益コレクション・リソースを問い合せる必要があります。
• OptyNumber(required): string
  商談の一意の代替識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• ExtnPartyName: string
  タイトル: Owner

  売上所有者の名前。
• ExtnPartyNameLOVSwitcher: string
  UIシナリオで使用される、収益所有者の値でないスイッチャ。
• ForecastTerritoryName: string
  タイトル: Territory Name

  最大長: 60

  予測テリトリの名前。
• OwnerLockAsgnFlag: boolean
  タイトル: Lock Credit Owner

  最大長: 1

  デフォルト値: false

  収益明細のクレジット受信者をシステムによる再割当からロックする必要があるかどうかを示します。
• PrTerritoryVersionId: integer (int64)
  タイトル: Forecast Territory

  予測テリトリ・バージョン識別子。
• PrTerritoryVersionIdForManual: string
  タイトル: Manually Assigned Territory Version ID

  売上レコードに手動で割り当てられるテリトリのバージョンIDを示します。
• ResourcePartyId: integer (int64)
  タイトル: Owner

  子分割売上に関連付けられたリソースの識別子。
• RevnAmount: number
  タイトル: Line Revenue

  デフォルト値: 0

  収益金額。
• RevnAmountCurcyCode: string
  タイトル: Currency

  最大長: 15

  この収益明細の金額の基準となる通貨。
• RevnNumber: string
  タイトル: Revenue Number

  最大長: 30

  収益明細の一意の番号。
• SplitPercent: number
  タイトル: Sales Credit

  分割収益のパーセント。

{
    "type":"object",
    "properties":{
        "PrTerritoryVersionId":{
            "title":"Forecast Territory",
            "type":"integer",
            "description":"Forecast territory version identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ExtnPartyName":{
            "title":"Owner",
            "type":"string",
            "description":"The name of the revenue owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExtnPartyNameLOVSwitcher":{
            "type":"string",
            "description":"The switcher for ist of values for the revenue owner, used in UI scenarios.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SalesCreditTypeCode"
                ]
            }
        },
        "SplitPercent":{
            "title":"Sales Credit",
            "type":"number",
            "description":"The percentage of split revenue.",
            "nullable":true
        },
        "PrTerritoryVersionIdForManual":{
            "title":"Manually Assigned Territory Version ID",
            "type":"string",
            "description":"Indicates the version ID of a territory that is to be manually assigned to the revenue record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The identifier of the resource associated with the child split revenue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ExtnPartyName",
                    "PartyName"
                ]
            }
        },
        "OwnerLockAsgnFlag":{
            "title":"Lock Credit Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ForecastTerritoryName":{
            "title":"Territory Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the forecast territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RevnAmountCurcyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency the amount on this revenue line is based on.",
            "nullable":false
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"The revenue amount.",
            "nullable":true,
            "default":0
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique number for the revenue line.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : opportunities-ChildRevenue-ChildSplitRevenue-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• ExtnPartyName: string
  タイトル: Owner

  売上所有者の名前。
• ExtnPartyNameLOVSwitcher: string
  UIシナリオで使用される、収益所有者の値でないスイッチャ。
• ForecastTerritoryName: string
  タイトル: Territory Name

  最大長: 60

  予測テリトリの名前。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  タイトル: Organization

  読取り専用: true

  売上に関連付けられているリソース組織の名前。
• OwnerLockAsgnFlag: boolean
  タイトル: Lock Credit Owner

  最大長: 1

  デフォルト値: false

  収益明細のクレジット受信者をシステムによる再割当からロックする必要があるかどうかを示します。
• OwnerPartyNumber: string
  タイトル: Owner Number

  読取り専用: true

  最大長: 30

  子分割売上の所有者のパーティ番号。
• PrTerritoryUpdatedByPartyName: string
  タイトル: Updated By

  読取り専用: true

  最大長: 360

  予測テリトリを最後に更新したユーザーの名前。
• PrTerritoryVersionId: integer (int64)
  タイトル: Forecast Territory

  予測テリトリ・バージョン識別子。
• PrTerritoryVersionIdForManual: string
  タイトル: Manually Assigned Territory Version ID

  売上レコードに手動で割り当てられるテリトリのバージョンIDを示します。
• ResourcePartyId: integer (int64)
  タイトル: Owner

  子分割売上に関連付けられたリソースの識別子。
• RevnAmount: number
  タイトル: Line Revenue

  デフォルト値: 0

  収益金額。
• RevnAmountCurcyCode: string
  タイトル: Currency

  最大長: 15

  この収益明細の金額の基準となる通貨。
• RevnId: integer (int64)
  子分割売上の一意の識別子。
• RevnNumber: string
  タイトル: Revenue Number

  最大長: 30

  収益明細の一意の番号。
• SalesCreditTypeCode: string
  タイトル: Sales Credit Type

  最大長: 30

  デフォルト値: QUOTA

  クレジットのタイプを示します。
• SplitPercent: number
  タイトル: Sales Credit

  分割収益のパーセント。
• TerrOwnerPartyName: string
  タイトル: Owner

  読取り専用: true

  最大長: 360

  予測テリトリ所有者の名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number for the owner of child split revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrTerritoryVersionId":{
            "title":"Forecast Territory",
            "type":"integer",
            "description":"Forecast territory version identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ExtnPartyName":{
            "title":"Owner",
            "type":"string",
            "description":"The name of the revenue owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExtnPartyNameLOVSwitcher":{
            "type":"string",
            "description":"The switcher for ist of values for the revenue owner, used in UI scenarios.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SalesCreditTypeCode"
                ]
            }
        },
        "PrTerritoryUpdatedByPartyName":{
            "title":"Updated By",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user who last updated the forecast territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrTerritoryVersionIdForManual":{
            "title":"Manually Assigned Territory Version ID",
            "type":"string",
            "description":"Indicates the version ID of a territory that is to be manually assigned to the revenue record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TerrOwnerPartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the forecast territory owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditTypeCode":{
            "title":"Sales Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit.",
            "nullable":true,
            "default":"QUOTA",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerLockAsgnFlag":{
            "title":"Lock Credit Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the resource organization associated the with revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique number for the revenue line.",
            "nullable":false,
            "x-queryable":true
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the child split revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SplitPercent":{
            "title":"Sales Credit",
            "type":"number",
            "description":"The percentage of split revenue.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The identifier of the resource associated with the child split revenue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ExtnPartyName",
                    "PartyName"
                ]
            },
            "x-queryable":true
        },
        "ForecastTerritoryName":{
            "title":"Territory Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the forecast territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RevnAmountCurcyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency the amount on this revenue line is based on.",
            "nullable":false,
            "x-queryable":true
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"The revenue amount.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

リンク

OwnerLockAsgnFlagLookupPVO

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeFinder%3BBindLookupType%3DYES_NO

参照リソースは、標準参照コードの表示に使用されます。

SalesCreditTypeLOV

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_SALES_CREDIT_TYPE

参照リソースは、標準参照コードの表示に使用されます。

TerritoryListVA

操作: /crmRestApi/resources/11.13.18.05/territories

営業テリトリの様々なバージョンを保持するエンティティ。 各バージョン・レコードには、テリトリのほとんどの主要な属性が含まれます。 ほとんどの営業テリトリ・オブジェクト・コンポーネントは、テリトリ・ルール、テリトリ・ルール境界、テリトリ・ルール境界値、テリトリ・リソースなど、営業テリトリ・バージョンに対する子エンティティです。

「トップに戻る」