機械翻訳について

ジャンプ先

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

ルール割当の更新

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}

リクエスト

パス・パラメータ

• RuleAssignmentId(required): integer(int64)
  ルール割当の一意の識別子。 この値は作成アクション中に生成されます。
• RuleId(required): integer(int64)
  ルールの一意の識別子。 この値は作成アクション中に生成されます。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AssignedObjectId: integer (int64)
  タイトル: Name

  割り当てられたオブジェクトの一意の識別子。
• AssignedObjectType: string
  タイトル: Type

  最大長: 30

  関係者、ロール、チーム、グループ、適格カテゴリなど、割当のタイプ。
• EndDate: 文字列(日付)
  タイトル: End Date

  ルール割当が非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
• GroupMemberCreditFlag: boolean
  タイトル: Receive direct credit

  最大長: 1

  デフォルト値: false

  グループのメンバーが他のグループ・メンバー・ダイレクト・クレジットのクレジットを取得するかどうかを示します。 この値は、積上ルール・タイプとアナリスト階層ルール・タイプに適用されます。
• RevenueType: string
  タイトル: Revenue Type

  最大長: 30

  デフォルト値: REVENUE

  収益や非収益など、生成されたクレジットのタイプ。 この値は、クレジットおよび積上ルール・タイプに適用されます。 受け入れられる値のリストは、参照タイプCN_RS_REVENUE_TYPEで定義されます。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。
• RoleId: integer (int64)
  タイトル: Role

  関係者に関連付けられたロールの一意の識別子。 この値は、割り当てられたオブジェクト・タイプが関係者である場合に適用されます。
• RollupFlag: boolean
  タイトル: Roll Up to Parents

  最大長: 1

  デフォルト値: false

  貸方受け側に対して積上クレジットが生成されるかどうかを示します。 この値は、与信ルール・タイプに適用されます。
• SplitPercent: number
  タイトル: Split Percent

  デフォルト値: 100

  貸方金額を計算するためにトランザクション金額に対して適用されるパーセント数値。 この値は、与信ルール・タイプに適用されます。
• StartDate: 文字列(日付)
  タイトル: Start Date

  ルール割当がアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
• SummaryFlag: boolean
  タイトル: Summarize rollups

  最大長: 1

  デフォルト値: false

  参加者が、要約された直接クレジットまたは個々の直接クレジットを間接クレジットとして受け取るかどうかを示します。 この値は、クレジットおよび積上ルール・タイプに適用されます。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false
        },
        "RollupFlag":{
            "title":"Roll Up to Parents",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignedObjectId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the assigned object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":18
            }
        },
        "GroupMemberCreditFlag":{
            "title":"Receive direct credit",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SplitPercent":{
            "title":"Split Percent",
            "type":"number",
            "description":"The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.",
            "nullable":true,
            "default":100
        },
        "AssignedObjectType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of assignment, such as participant, role, team, group, or eligible category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SummaryFlag":{
            "title":"Summarize rollups",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RevenueType":{
            "title":"Revenue Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : incentiveCompensationRuleHierarchies-RuleAssignments-item-response

タイプ: object

ソースを表示

• AssignedObjectId: integer (int64)
  タイトル: Name

  割り当てられたオブジェクトの一意の識別子。
• AssignedObjectName: string
  読取り専用: true

  割り当てられたオブジェクトの名前。
• AssignedObjectType: string
  タイトル: Type

  最大長: 30

  関係者、ロール、チーム、グループ、適格カテゴリなど、割当のタイプ。
• CreatedBy: string
  読取り専用: true

  最大長: 64

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

  ルール割当が作成された日付。
• EndDate: 文字列(日付)
  タイトル: End Date

  ルール割当が非アクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
• GroupMemberCreditFlag: boolean
  タイトル: Receive direct credit

  最大長: 1

  デフォルト値: false

  グループのメンバーが他のグループ・メンバー・ダイレクト・クレジットのクレジットを取得するかどうかを示します。 この値は、積上ルール・タイプとアナリスト階層ルール・タイプに適用されます。
• LastUpdateDate: string (date-time)
  読取り専用: true

  ルール割当が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  ルール割当を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• OrganizationId: integer (int64)
  ビジネス・ユニットの一意の識別子。
• RevenueType: string
  タイトル: Revenue Type

  最大長: 30

  デフォルト値: REVENUE

  収益や非収益など、生成されたクレジットのタイプ。 この値は、クレジットおよび積上ルール・タイプに適用されます。 受け入れられる値のリストは、参照タイプCN_RS_REVENUE_TYPEで定義されます。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。
• RoleId: integer (int64)
  タイトル: Role

  関係者に関連付けられたロールの一意の識別子。 この値は、割り当てられたオブジェクト・タイプが関係者である場合に適用されます。
• RoleName: string
  タイトル: Name

  読取り専用: true

  最大長: 60

  ルールに割り当てられた関係者に関連付けられたロールの名前。
• RollupFlag: boolean
  タイトル: Roll Up to Parents

  最大長: 1

  デフォルト値: false

  貸方受け側に対して積上クレジットが生成されるかどうかを示します。 この値は、与信ルール・タイプに適用されます。
• RuleAssignmentId: integer (int64)
  読取り専用: true

  ルール割当の一意の識別子。 この値は作成アクション中に生成されます。
• RuleId: integer (int64)
  タイトル: Parent

  ルールの一意の識別子。
• SplitPercent: number
  タイトル: Split Percent

  デフォルト値: 100

  貸方金額を計算するためにトランザクション金額に対して適用されるパーセント数値。 この値は、与信ルール・タイプに適用されます。
• StartDate: 文字列(日付)
  タイトル: Start Date

  ルール割当がアクティブになる日時。 許容可能な書式はyyyy-mm-ddです。 この値は、クレジット、積上、チーム、アナリスト階層および関係者割当ルール・タイプに適用されます。
• SummaryFlag: boolean
  タイトル: Summarize rollups

  最大長: 1

  デフォルト値: false

  参加者が、要約された直接クレジットまたは個々の直接クレジットを間接クレジットとして受け取るかどうかを示します。 この値は、クレジットおよび積上ルール・タイプに適用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the rule assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedObjectName":{
            "type":"string",
            "description":"The name of the assigned object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the rule assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Roll Up to Parents",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rule assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedObjectId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the assigned object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":18
            },
            "x-queryable":true
        },
        "GroupMemberCreditFlag":{
            "title":"Receive direct credit",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role associated with the participant assigned to the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPercent":{
            "title":"Split Percent",
            "type":"number",
            "description":"The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.",
            "nullable":true,
            "default":100,
            "x-queryable":true
        },
        "RuleAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of rule assignment. This value is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "AssignedObjectType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of assignment, such as participant, role, team, group, or eligible category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummaryFlag":{
            "title":"Summarize rollups",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueType":{
            "title":"Revenue Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the rule assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the rule assignment.",
            "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."
        }
    }
}

リンク

AssignedObjectTypeAccessor

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_RS_ASSIGNED_OBJECT_TYPE%2CLookupCode%3DELIGIBLE_CATEGORY

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

GroupMemberCreditFlagLookupViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_YES_NO

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

ParticipantsLovViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/creditCategories

クレジット・カテゴリ・リソースは、クレジット・カテゴリとその詳細の表示、作成、更新および削除に使用されます。 クレジット・カテゴリは、関係者、チームまたはマネージャの適格性を提供し、トランザクションに対するクレジットを受け取ります。

RollupFlagLookupViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_YES_NO

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

RollupRevenueTypeAccessor

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_RS_REVENUE_TYPE

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

SummaryFlagLookupViewAccessor

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_YES_NO

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

「トップに戻る」