機械翻訳について

ジャンプ先

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

割当済参加者の取得

get

/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments/{SrpCompPlanId}

リクエスト

パス・パラメータ

• CompensationPlanId(required): integer(int64)
  報酬プランの一意の識別子。
• SrpCompPlanId(required): integer(int64)
  報酬プランの一意の識別子。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : compensationPlans-CompensationPlanAssignments-item-response

タイプ: object

ソースを表示

• AcceptanceStatus: string
  タイトル: Acceptance Status

  最大長: 30

  デフォルト値: ACCEPTED

  公開済関係者報酬プラン文書のステータス。 受理可能な値のリストが参照CN_SRP_APPR_STATUSに定義されています。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューします。 受入ステータスは、ビジネス・ユニットのプラン承認および受入ワークフロー使用可能属性がいいえに設定されている場合、更新できます。 設定およびメンテナンスのパラメータの管理タスクを使用して、属性値をレビューおよび更新します。
• AnalystId: integer (int64)
  タイトル: Analyst

  読取り専用: true

  関係者に割り当てられたアナリストの一意の識別子。
• AnalystName: string
  タイトル: Name

  読取り専用: true

  最大長: 360

  関係者に割り当てられたアナリストの名前。
• AssignmentType: string
  タイトル: Assignment Type

  最大長: 30

  参加者が報酬プランに直接割り当てられるか、ロールを介して割り当てられるかなど、アサイメントのタイプ。 許容可能な値のリストは、参照CN_PARTICIPANT_PLN_ASSIGN_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• CompensationPlanId: integer (int64)
  タイトル: Compensation Plan

  基本報酬プランの一意の識別子です。
• CreatedBy: string
  読取り専用: true

  最大長: 64

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

  報酬プラン割当が作成された日時。
• EndDate: 文字列(日付)
  タイトル: End Date

  報酬プラン割当が非アクティブになる日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  報酬プラン割当が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

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

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• ParticipantId: integer (int64)
  タイトル: Participant Name

  関係者の一意の識別子。
• ParticipantName: string
  タイトル: Name

  読取り専用: true

  最大長: 360

  参加者の名前。
• ParticipantPlanNumber: string
  タイトル: Participant Plan Number

  最大長: 30

  参加者プランの代替キー識別子。
• ParticipantType: string
  タイトル: Type

  読取り専用: true

  最大長: 60

  デフォルト値: PARTICIPANT

  参加者のタイプ。 この属性は、参加者が管理者であるか、ツールの更新を担当しているか、営業チーム・メンバーであり、販売実績を取得できるかを示します。 取り得る値は、管理者の場合はANALYST、営業チーム・メンバーの場合はPARTICIPANTです。 受理可能な値のリストは、参照CN_PARTICIPANT_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• PersonNumber: string
  タイトル: Person Number

  読取り専用: true

  最大長: 30

  企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。 国別識別子コンポーネントとの関連はありません。
• RoleId: integer (int64)
  タイトル: Name

  読取り専用: true

  インセンティブ報酬ロールの一意の識別子。
• RoleName: string
  タイトル: Name

  読取り専用: true

  最大長: 60

  インセンティブ報酬ロールの名前。
• SrpCompPlanId: integer (int64)
  報酬プランの一意の識別子。
• StartDate: 文字列(日付)
  タイトル: Start Date

  報酬プラン割当がアクティブになる日付。
• ViewPlanDocument: 文字列(バイト)
  読取り専用: true

  プラン文書へのリンク。 プラン文書には、関係者に割り当てられた報酬プランに関する詳細が含まれています。 これは、設定およびメンテナンスのパラメータの管理タスクを使用してプラン承認機能が有効になっている場合にのみ使用できます。 参加者のプランが承認のために送信されると、プラン文書が生成されます。

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the compensation plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the compensation plan assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptanceStatus":{
            "title":"Acceptance Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the published participant compensation plan document. A list of acceptable values is defined for the lookup CN_SRP_APPR_STATUS. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. The acceptance status can be updated when the Enable Plan Approval and Acceptance Workflow attribute are set to the No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.",
            "nullable":false,
            "default":"ACCEPTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the compensation plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompensationPlanId":{
            "title":"Compensation Plan",
            "type":"integer",
            "description":"The unique identifier of the base compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of a incentive compensation role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the compensation plan assignment becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the analyst assigned to a participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewPlanDocument":{
            "type":"string",
            "description":"The link to the plan document. The plan document contains details about the compensation plan assigned to the participant. It is only available if the plan approval feature has been enabled using the Setup and Maintenance, Manage Parameters task. The plan document gets generated once the participant's plan is submitted for approval.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParticipantId":{
            "title":"Participant Name",
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the compensation plan assignment becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the incentive compensation role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalystId":{
            "title":"Analyst",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the assignment, for example whether a participant is assigned to a compensation plan directly or through a role. A list of acceptable values is defined in the lookup CN_PARTICIPANT_PLN_ASSIGN_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantType":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the participant. This attribute indicates whether the participant is an administrator, responsible for updating tools, or a sales team member, capable of getting a sales credit. Possible values include ANALYST for an Administrator, and PARTICIPANT for a Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"PARTICIPANT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ParticipantPlanNumber":{
            "title":"Participant Plan Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the participant plan.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the compensation plan assignment 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."
        }
    }
}

リンク

CnLookupAcceptanceStatus

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

公開済報酬プラン文書のステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: AcceptanceStatus;ターゲット属性: LookupCode
• 表示属性: 意味

CnLookupAssignmentType

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

報酬プランが直接割り当てられているか、ロールを介して割り当てられているかを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: AssignmentType;ターゲット属性: LookupCode
• 表示属性: 意味

CnLookupParticipantType

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

管理者や営業チーム・メンバーなど、関係者のタイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ParticipantType;ターゲット属性: LookupCode
• 表示属性: 意味

「トップに戻る」