Jump to

• Request
• Response

Get a pay group

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}

Request

Path Parameters

• PayGroupId(required): integer(int64)
  The unique identifier of the pay group.

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 : incentiveCompensationPayGroups-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the pay group.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the pay group is created.
• Description: string
  Title: Pay Group Description

  Maximum Length: 999

  A brief description of the pay group.
• EndDate: string (date)
  Title: End Date

  The date when the pay group becomes inactive. The acceptable format is yyyy-mm-dd.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the pay group was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the pay group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit to which the pay group belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column.
• PayGroupAssignments: array Pay Group Assignments
  Title: Pay Group Assignments

  The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.
• PayGroupId: integer (int64)
  The unique identifier of the pay group.
• PayGroupName: string
  Title: Name

  Maximum Length: 80

  The name of the incentive compensation pay group. The combination of the name and business unit must be unique.
• PayGroupRoles: array Pay Group Roles
  Title: Pay Group Roles

  The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.
• PayGroupType: string
  Title: Pay Group Type

  Maximum Length: 30

  The code indicating the type of pay group, for example, for payroll or for payables. Possible values include ORACLE_PAYROLL and ORACLE_AP. A list of acceptable values is defined in the lookup CN_PAY_GROUP_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• StartDate: string (date)
  Title: Start Date

  The date when the pay group becomes active. The acceptable format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the pay group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the pay group is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the pay group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Pay Group Description",
            "maxLength":"999",
            "type":"string",
            "description":"A brief description of the pay group.",
            "nullable":true,
            "x-queryable":true
        },
        "PayGroupAssignments":{
            "title":"Pay Group Assignments",
            "type":"array",
            "description":"The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupAssignments-item-response"
            }
        },
        "PayGroupRoles":{
            "title":"Pay Group Roles",
            "type":"array",
            "description":"The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupRoles-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the pay group becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PayGroupName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the incentive compensation pay group. The combination of the name and business unit must be unique.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the pay group becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the pay group belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "PayGroupType":{
            "title":"Pay Group Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of pay group, for example, for payroll or for payables. Possible values include ORACLE_PAYROLL and ORACLE_AP.  A list of acceptable values is defined in the lookup CN_PAY_GROUP_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the pay group was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Pay Group Assignments

Type: array

Title: Pay Group Assignments

The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.

Show Source

• Array of: object incentiveCompensationPayGroups-PayGroupAssignments-item-response

{
    "title":"Pay Group Assignments",
    "type":"array",
    "description":"The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupAssignments-item-response"
    }
}

Nested Schema : Pay Group Roles

Type: array

Title: Pay Group Roles

The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.

Show Source

• Array of: object incentiveCompensationPayGroups-PayGroupRoles-item-response

{
    "title":"Pay Group Roles",
    "type":"array",
    "description":"The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPayGroups-PayGroupRoles-item-response"
    }
}

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."
        }
    }
}

Nested Schema : incentiveCompensationPayGroups-PayGroupAssignments-item-response

Type: object

Show Source

• AnalystId: integer (int64)
  Title: Analyst

  Read Only: true

  The unique identifier of the analyst assigned to the pay group.
• AnalystName: string
  Title: Analyst Name

  Read Only: true

  Maximum Length: 360

  The name of the analyst assigned to the pay group.
• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  The assignment type for the pay group.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the pay group assignment is created.
• EndDate: string (date)
  Title: End Date

  The date when the assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the pay group assignment.
• links: array Links
  Title: Links

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

  The unique identifier for a participant.
• ParticipantName: string
  Title: Participant Name

  Read Only: true

  Maximum Length: 360

  The name of the participant in incentive compensation.
• ParticipantPayGroupId: integer (int64)
  The unique identifier of the participant pay group assignment record.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  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.
• RoleId: integer (int64)
  Read Only: true

  The unique identifier off the pay group role.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 60

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

  The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.

{
    "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":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the pay group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the pay group assignment is 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 pay group assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name  of the participant in incentive compensation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier off the pay group role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Analyst Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the analyst assigned to the pay group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the participant pay group assignment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the assignment becomes active. The acceptable 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
        },
        "AnalystId":{
            "title":"Analyst",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to the pay group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"The assignment type for the pay group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the pay group assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : incentiveCompensationPayGroups-PayGroupRoles-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the pay group role assignment.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the pay group role assignment is created.
• EndDate: string (date)
  Title: End Date

  The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the pay group role assignment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the pay group role assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayGroupId: integer (int64)
  The unique identifier of the pay group.
• RoleDescription: string
  Title: Role Description

  Read Only: true

  Maximum Length: 120

  A brief description of the pay group role.
• RoleId: integer (int64)
  Title: Name

  The unique identifier of a pay group role.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 60

  The name of the pay group role.
• RolePayGroupId: integer (int64)
  The unique identifier of the role associated with a pay group.
• StartDate: string (date)
  Title: Start Date

  The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the pay group role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the pay group start date. The default value is the pay group start date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the pay group role assignment is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the pay group role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the pay group role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolePayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the role associated with a pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":"120",
            "type":"string",
            "description":"A brief description of the pay group role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of a pay group role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment for a pay group becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the pay group end date. The default value is the pay group end date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the pay group role assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

Links

BusinessUnitPVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

The list of values containing the unique identifiers of the business units.

The following properties are defined on the LOV link relation:

• Source Attribute: OrgId; Target Attribute: OrganizationId
• Display Attribute: Name

CnLookupPayGroupTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_PAY_GROUP_TYPE

The list of values for the type of pay group.

The following properties are defined on the LOV link relation:

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

PayGroupAssignments

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupAssignments

Parameters:

• PayGroupId: $request.path.PayGroupId

The pay group assignments resource is used to view, create, update or delete an incentive compensation assignments for pay group.

PayGroupRoles

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPayGroups/{PayGroupId}/child/PayGroupRoles

Parameters:

• PayGroupId: $request.path.PayGroupId

The pay group roles resource is used to view, create, update, and delete an incentive compensation role assignment for a pay group.

Back to Top