インセンティブ報酬ロールの作成
post
/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles
リクエスト
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
AccessType: string
タイトル:
Access Type最大長:30デフォルト値:INDIVIDUAL -
ActiveFlag: boolean
タイトル:
Active最大長:1デフォルト値:true -
RoleDescription: string
タイトル:
Role Description最大長:120 -
RoleId: integer (int64)
-
RoleName(required): string
タイトル:
Name最大長:60 -
RoleParticipants: array Role - Participants
タイトル:
Role - Participantsロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。
ネストされたスキーマ : ロール - 参加者
タイプ:
arrayタイトル:
Role - Participantsロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object-
EndDateActive: 文字列(日付)
タイトル:
Assignment End Date -
ParticipantId: integer (int64)
タイトル:
Participant Name -
ParticipantRoleId: integer (int64)
-
PreserveRoleAssignmentFlag: boolean
タイトル:
Preserve Assignment -
RoleId: integer (int64)
タイトル:
Name -
StartDateActive: 文字列(日付)
タイトル:
Assignment Start Date
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationRoles-item-response
タイプ:
ソースを表示
object-
AccessType: string
タイトル:
Access Type最大長:30デフォルト値:INDIVIDUAL -
ActiveFlag: boolean
タイトル:
Active最大長:1デフォルト値:true -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用: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リソース・インスタンスに関連付けられたリンク関係。 -
RoleDescription: string
タイトル:
Role Description最大長:120 -
RoleId: integer (int64)
-
RoleName: string
タイトル:
Name最大長:60 -
RoleParticipants: array Role - Participants
タイトル:
Role - Participantsロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。
ネストされたスキーマ : ロール - 参加者
タイプ:
arrayタイトル:
Role - Participantsロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : incentiveCompensationRoles-RoleParticipants-item-response
タイプ:
ソースを表示
object-
ActiveFlag: boolean
タイトル:
Active読取り専用:true最大長:1 -
AnalystName: string
タイトル:
Analyst読取り専用:true最大長:360 -
CompensationEndDate: 文字列(日付)
タイトル:
Compensation End Date読取り専用:true -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:true -
EndDateActive: 文字列(日付)
タイトル:
Assignment End Date -
HoldPaymentFlag: boolean
タイトル:
Hold payment読取り専用:true最大長:1 -
HRPersonNumber: string
タイトル:
Person Number読取り専用:true最大長:30 -
HRPrimaryWorkerNumber: string
タイトル:
Worker Number読取り専用:true最大長:30 -
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リソース・インスタンスに関連付けられたリンク関係。 -
OrgId: integer (int64)
タイトル:
Business Unit読取り専用:true -
ParticipantId: integer (int64)
タイトル:
Participant Name -
ParticipantName: string
タイトル:
Participant Name読取り専用:true最大長:360 -
ParticipantRoleId: integer (int64)
-
ParticipantType: string
タイトル:
Type読取り専用:true最大長:60 -
PartyNumber: string
タイトル:
Party Number読取り専用:true最大長:30 -
PayeeOnly: string
タイトル:
Payee Only読取り専用:true最大長:1 -
PreserveRoleAssignmentFlag: boolean
タイトル:
Preserve Assignment -
RoleId: integer (int64)
タイトル:
Name -
StartDateActive: 文字列(日付)
タイトル:
Assignment Start Date
リンク
- CnLookupAccessTypeVO
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCN_ACCESS_TYPE
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ:
- CnLookupYesNoVO
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DCN_YES_NO
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。 - ファインダ:
- RoleParticipants
-
パラメータ:
- RoleId:
$request.path.RoleId
ロール - 関係者リソースは、インセンティブ報酬ロールを割り当てることができる関係者を表示、作成、更新および削除するために使用されます。 - RoleId:
例:
次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行してロールを作成する方法を示しています。
関係者を割り当てずにロールを作成
cURLコマンド
curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"RoleName": "Sales Representative Role",
"ActiveFlag": true,
"RoleDescription": "All sales members in our team",
"AccessType": "INDIVIDUAL"
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"RoleName": "Sales Representative Role",
"ActiveFlag": true,
"RoleId": 300100089784737,
"RoleDescription": "All sales members in our team",
"CreatedBy": "OIC_MGR_OPERATIONS",
"CreationDate": "2017-03-16T15:39:40+05:30",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T15:39:40+05:30",
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"AccessType": "INDIVIDUAL",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737",
"name": "roles",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737/lov/CnLookupYesNoVO",
"name": "CnLookupYesNoVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737/lov/CnLookupAccessTypeVO",
"name": "CnLookupAccessTypeVO",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089784737/child/RoleParticipants",
"name": "RoleParticipants",
"kind": "collection"
}
]
}
参加者が割り当てられているロールの作成
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{
"RoleName": "Sales Representatives",
"ActiveFlag": true,
"RoleDescription": "All sales members in our team",
"AccessType": "INDIVIDUAL",
"RoleParticipants" : [
{
"StartDateActive": "2015-01-01",
"ParticipantId": 2001,
"EndDateActive": "2015-12-31",
"PreserveRoleAssignmentFlag": "true"
}
],
"RoleParticipants" : [
{
"StartDateActive": "2015-01-01",
"ParticipantId": 2002,
"EndDateActive": "2015-12-31",
"PreserveRoleAssignmentFlag": "true"
}
]
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"RoleName": "Sales Representatives",
"ActiveFlag": true,
"RoleId": 300100089785736,
"RoleDescription": "All sales members in our team",
"CreatedBy": "OIC_MGR_OPERATIONS",
"CreationDate": "2017-03-16T17:16:44+05:30",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T17:16:44+05:30",
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"AccessType": "INDIVIDUAL",
"RoleParticipants": [
{
"ParticipantRoleId": 300100089785737,
"StartDateActive": "2015-01-01",
"ParticipantId": 2001,
"RoleId": 300100089785736,
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T17:16:44+05:30",
"CreationDate": "2017-03-16T17:16:44+05:30",
"CreatedBy": "OIC_MGR_OPERATIONS",
"EndDateActive": "2015-12-31",
"ActiveFlag": true,
"HRPrimaryWorkerNumber": null,
"ParticipantType": "PARTICIPANT",
"PartyNumber": "300100005347180",
"CompensationEndDate": null,
"HoldPaymentFlag": false,
"OrgId": 204,
"HRPersonNumber": null,
"PayeeOnly": "N",
"ParticipantName": "IC_PARTY_VO_20111202135553",
"AnalystName": null,
"PreserveRoleAssignmentFlag": "true",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737",
"name": "RoleParticipants",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737",
"name": "RoleParticipants",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/BusinessUnitPVO",
"name": "BusinessUnitPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/ParticipantsVO",
"name": "ParticipantsVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785737/lov/CnLookupParticipantTypeVO",
"name": "CnLookupParticipantTypeVO",
"kind": "collection"
}
]
},
{
"ParticipantRoleId": 300100089785738,
"StartDateActive": "2015-01-01",
"ParticipantId": 2002,
"RoleId": 300100089785736,
"LastUpdateLogin": "4AC7DE6005D2570AE0537F90B10A3DBA",
"LastUpdatedBy": "OIC_MGR_OPERATIONS",
"LastUpdateDate": "2017-03-16T17:16:44+05:30",
"CreationDate": "2017-03-16T17:16:44+05:30",
"CreatedBy": "OIC_MGR_OPERATIONS",
"EndDateActive": "2015-12-31",
"ActiveFlag": true,
"HRPrimaryWorkerNumber": null,
"ParticipantType": "PARTICIPANT",
"PartyNumber": "300100005347187",
"CompensationEndDate": null,
"HoldPaymentFlag": false,
"OrgId": 204,
"HRPersonNumber": null,
"PayeeOnly": "N",
"ParticipantName": "IC_PARTY_VO_20111202141139",
"AnalystName": null,
"PreserveRoleAssignmentFlag": "true",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738",
"name": "RoleParticipants",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738",
"name": "RoleParticipants",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738/lov/BusinessUnitPVO",
"name": "BusinessUnitPVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738/lov/ParticipantsVO",
"name": "ParticipantsVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/child/RoleParticipants/300100089785738/lov/CnLookupParticipantTypeVO",
"name": "CnLookupParticipantTypeVO",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736",
"name": "roles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/lov/CnLookupYesNoVO",
"name": "CnLookupYesNoVO",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles/300100089785736/lov/CnLookupAccessTypeVO",
"name": "CnLookupAccessTypeVO",
"kind": "collection"
}
]
}