Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

関係者ロールの作成

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/{incentiveCompensationParticipantsUniqID}/child/ParticipantRoles

リクエスト

パス・パラメータ

incentiveCompensationParticipantsUniqID(required): string

これは、参加者リソースのコンポジット・キーを構成し、参加者のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは参加者の特定のインスタンスに移動してハッシュ・キーを取得するために、Participantsコレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

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

ソースを表示

EndDateActive: 文字列(日付)

タイトル: Role End Date

その参加者のロール割当が終了する日付。書式はyyyy-mm-ddです。
ParticipantId: integer (int64)

タイトル: Participant Identifier

参加者レコードの一意の識別子。
ParticipantRoleId: integer (int64)

タイトル: Participant Role ID

関係者ロールの一意の識別子。
PreserveRoleAssignmentFlag: boolean

タイトル: Preserve Assignment

ロール割当を保持するかどうか、およびロール割当の自動プロセスによる更新を防止するかどうかを示します。取り得る値には、更新を防止するためにTRUEが含まれます。ロールが関係者に手動で追加された場合、割当の保持はTrueに設定され、更新を許可する場合はFALSEに設定されます。
RoleId: integer (int64)

タイトル: Role ID

関係者レコードに割り当てられたロールの一意の識別子。
StartDateActive: 文字列(日付)

タイトル: Role Start Date

関係者のロール割当が開始する日付。これは必須フィールドです。書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier of the participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StartDateActive":{
            "title":"Role Start Date",
            "type":"string",
            "description":"The date when the role assignment starts for a participant. This is a mandatory field. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "EndDateActive":{
            "title":"Role End Date",
            "type":"string",
            "description":"The date when the role assignment ends for that participant. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"Indicates whether to keep the role assignment and to prevent update by the automatic the role assignment process. Possible values include TRUE to prevent update. In cases where the Role is added manually to participants, the Preserve Assignment is set as True, and FALSE to allow update.",
            "nullable":true
        },
        "ParticipantRoleId":{
            "title":"Participant Role ID",
            "type":"integer",
            "description":"The unique identifier for the participant role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"The unique identifier for a role assigned to a participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : incentiveCompensationParticipants-ParticipantRoles-item-response

タイプ: object

ソースを表示

AccessType: string

タイトル: Access Type

読取り専用: true

最大長: 30

デフォルト値: INDIVIDUAL

マネージャや個人など、アクセス・タイプを表す参照コード。可能な値には、参加者アクセスが個人であることを指定するINDIVIDUALと、参加者アクセスがマネージャであることを指定するMANAGERがあります。デフォルト値はINDIVIDUALです。許容可能な値のリストは、参照CN_ACCESS_TYPEで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
EndDateActive: 文字列(日付)

タイトル: Role End Date

その参加者のロール割当が終了する日付。書式はyyyy-mm-ddです。
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

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

タイトル: Participant Identifier

参加者レコードの一意の識別子。
ParticipantRoleId: integer (int64)

タイトル: Participant Role ID

関係者ロールの一意の識別子。
PreserveRoleAssignmentFlag: boolean

タイトル: Preserve Assignment

ロール割当を保持するかどうか、およびロール割当の自動プロセスによる更新を防止するかどうかを示します。取り得る値には、更新を防止するためにTRUEが含まれます。ロールが関係者に手動で追加された場合、割当の保持はTrueに設定され、更新を許可する場合はFALSEに設定されます。
RoleId: integer (int64)

タイトル: Role ID

関係者レコードに割り当てられたロールの一意の識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

ロールの名前。
StartDateActive: 文字列(日付)

タイトル: Role Start Date

関係者のロール割当が開始する日付。これは必須フィールドです。書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantRoleId":{
            "title":"Participant Role ID",
            "type":"integer",
            "description":"The unique identifier for the participant role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"The unique identifier for a role assigned to a participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier of the participant record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Role Start Date",
            "type":"string",
            "description":"The date when the role assignment starts for a participant. This is a mandatory field. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"Role End Date",
            "type":"string",
            "description":"The date when the role assignment ends for that participant. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PreserveRoleAssignmentFlag":{
            "title":"Preserve Assignment",
            "type":"boolean",
            "description":"Indicates whether to keep the role assignment and to prevent update by the automatic the role assignment process. Possible values include TRUE to prevent update. In cases where the Role is added manually to participants, the Preserve Assignment is set as True, and FALSE to allow update.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccessType":{
            "title":"Access Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that represents the access type, such as manager or individual. Possible values include INDIVIDUAL which specifies that the participant access is individual, and MANAGER which specifies that the participant access is manager. The default value is INDIVIDUAL.  A list of acceptable values is defined in the lookup CN_ACCESS_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INDIVIDUAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "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."
        }
    }
}

リンク

CnLookupAccessTypeVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DCN_ACCESS_TYPE

マネージャや個人など、アクセス・タイプを表す参照コードを含む値リスト。可能な値には、参加者アクセスが個人であることを指定するINDIVIDUALと、参加者アクセスがマネージャであることを指定するMANAGERがあります。デフォルト値はINDIVIDUALです。

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

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

RolesVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles

パラメータ:

ファインダ: SearchActiveRoles

ロールの一意の識別子を含む値リスト。

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

ソース属性: RoleId;ターゲット属性: RoleId
表示属性: RoleName

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、参加者ロールを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/999666333000584/child/ParticipantRoles

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
"StartDateActive": "2017-02-01",
  "RoleId": 300100089821754,
  "EndDateActive": "2017-12-31"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "ParticipantRoleId": 300100089854605,
  "CreatedBy": "OIC_MGR_OPERATIONS",
  "CreationDate": "2017-05-16T07:34:28-07:00",
  "EndDateActive": "2017-12-31",
  "LastUpdateDate": "2017-05-16T07:34:28.024-07:00",
  "LastUpdateLogin": "4FA525997C5C6DC5E0532DD6F00A3E7B",
  "LastUpdatedBy": "OIC_MGR_OPERATIONS",
  "ParticipantId": 999666333000584,
  "RoleId": 300100089821754,
  "RoleName": "US Sales Representative",
  "StartDateActive": "2017-02-01",
  "AccessType": false,
  "PreserveRoleAssignmentFlag": true,
  "links": [
    ...
  ]
}

「トップに戻る」