Jump to

• Request
• Response
• Examples

Get a participant role

get

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

Request

Path Parameters

• ParticipantRoleId(required): integer(int64)
  The unique identifier for the participant role.
• incentiveCompensationParticipantsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Participants resource and used to uniquely identify an instance of Participants. The client should not generate the hash key value. Instead, the client should query on the Participants collection resource in order to navigate to a specific instance of Participants to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : incentiveCompensationParticipants-ParticipantRoles-item-response

Type: object

Show Source

• AccessType: string
  Title: Access Type

  Read Only: true

  Maximum Length: 30

  Default Value: INDIVIDUAL

  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• EndDateActive: string (date)
  Title: Role End Date

  The date when the role assignment ends for that participant. The format is yyyy-mm-dd.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantId: integer (int64)
  Title: Participant Identifier

  The unique identifier of the participant record.
• ParticipantRoleId: integer (int64)
  Title: Participant Role ID

  The unique identifier for the participant role.
• PreserveRoleAssignmentFlag: boolean
  Title: Preserve Assignment

  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.
• RoleId: integer (int64)
  Title: Role ID

  The unique identifier for a role assigned to a participant record.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 60

  The name of the role.
• StartDateActive: string (date)
  Title: Role Start Date

  The date when the role assignment starts for a participant. This is a mandatory field. The format is 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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CnLookupAccessTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_ACCESS_TYPE

The list of values containing the lookup codes that represent the access type, such as a 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.

The following properties are defined on the LOV link relation:

• Source Attribute: AccessType; Target Attribute: LookupCode
• Display Attribute: Meaning

RolesVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRoles

Parameters:

• finder: SearchActiveRoles

The list of values containing the unique identifiers of roles.

The following properties are defined on the LOV link relation:

• Source Attribute: RoleId; Target Attribute: RoleId
• Display Attribute: RoleName

Back to Top

Examples

The following example shows how to get a participant role by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationParticipants/999666333000584/child/ParticipantRoles/100000015515807

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ParticipantRoleId": 100000015515807,
  "CreatedBy": "OIC_MGR_OPERATIONS",
  "CreationDate": "2010-01-22T03:46:39-08:00",
  "EndDateActive": "2012-12-31",
  "LastUpdateDate": "2017-05-03T22:54:21-07:00",
  "LastUpdateLogin": "4EAD677BFDD950B7E0532DD6F00A3787",
  "LastUpdatedBy": "OIC_MGR_OPERATIONS",
  "ParticipantId": 999666333000584,
  "RoleId": 100000011896461,
  "RoleName": "US Sales Representative",
  "StartDateActive": "2012-02-01",
  "AccessType": false,
  "PreserveRoleAssignmentFlag": true,
  "links": [
   ...
  ]
}

Back to Top