Jump to

• Request
• Response
• Examples

Get an element definition.

get

/hcmRestApi/resources/11.13.18.05/payrollElementDefinitionsLOV/{payrollElementDefinitionsLOVUniqID}

Request

Path Parameters

• payrollElementDefinitionsLOVUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ElementTypeId, EffectiveStartDate and EffectiveEndDate ---for the Payroll Element Definitions List of Values resource and used to uniquely identify an instance of Payroll Element Definitions List of Values. The client should not generate the hash key value. Instead, the client should query on the Payroll Element Definitions List of Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Payroll Element Definitions List of Values.
  
  For example: payrollElementDefinitionsLOV?q=ElementTypeId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>

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

Type: object

Show Source

• CategoryCode: string
  Read Only: true

  Maximum Length: 30

  Name of the category used, by identifying the predefined questionnaire to create an element, such as Absence, Benefits, Involuntary Deduction, Retirement and Pension, Social Insurance Deduction, Standard, and Time card.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Read Only: true

  Date at the end of the period during which the element is available for processing.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Read Only: true

  Date at the beginning of the period during which the element is available for processing.
• ElementName: string
  Read Only: true

  Maximum Length: 80

  Name of the element.
• ElementTypeId: integer (int64)
  Read Only: true

  System-generated unique identifier for the element.
• InputCurrencyCode: string
  Title: Input Currency

  Read Only: true

  Maximum Length: 15

  Currency code for those element entry input values that use money as the unit of measure.
• LegislationCode: string
  Read Only: true

  Maximum Length: 30

  Code that indicates the legislation that the element definition belongs to. Applicable only for seeded records.
• LegislativeDataGroupId: integer (int64)
  Read Only: true

  Unique identifier for the legislative data group.
• LegislativeDataGroupName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the legislative data group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OutputCurrencyCode: string
  Title: Priority

  Read Only: true

  Maximum Length: 15

  Currency code for those element entry result values that use money as the unit of measure.
• PersonId: integer
  System-generated unique identifier for the person.
• PrimaryClassificationId: integer (int64)
  Read Only: true

  Unique identifier for the element classification that groups elements with similar characteristics. It controls the order in which the elements are processed and the balances that are fed by them.
• PrimaryClassificationName: string
  Title: Element Classification Name

  Read Only: true

  Maximum Length: 80

  Name of the element classification that groups elements with similar characteristics, such as earnings or involuntary deduction. It controls the order in which the elements are processed and the balances that are fed by them.
• ProcessingType: string
  Title: Element Processing Type

  Read Only: true

  Maximum Length: 30

  Indicates whether an element entry is recurring or nonrecurring.
• ReportingName: string
  Title: Reporting Name

  Read Only: true

  Maximum Length: 80

  Name of the element that's displayed on reports and pay advices.
• SecondaryClassificationId: integer (int64)
  Read Only: true

  Unique identifier for the subordinate group of elements within a primary element classification.
• SecondaryClassificationName: string
  Title: Element Classification Name

  Read Only: true

  Maximum Length: 80

  Name of the subordinate group of elements within a primary element classification.
• UseAtAssignmentLevel: string
  Read Only: true

  Maximum Length: 30

  Indicates whether the element can be associated with only employee payroll assignment.
• UseAtRelationshipLevel: string
  Read Only: true

  Maximum Length: 30

  Indicates whether the element can be associated with only employee payroll relationships.

{
    "type":"object",
    "properties":{
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier for the legislative data group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the category used, by identifying the predefined questionnaire to create an element, such as Absence, Benefits, Involuntary Deduction, Retirement and Pension, Social Insurance Deduction, Standard, and Time card.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates the legislation that the element definition belongs to. Applicable only for seeded records.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryClassificationName":{
            "title":"Element Classification Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the subordinate group of elements within a primary element classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the period during which the element is available for processing.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UseAtRelationshipLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the element can be associated with only employee payroll relationships.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InputCurrencyCode":{
            "title":"Input Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code for those element entry input values that use money as the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryClassificationId":{
            "type":"integer",
            "description":"Unique identifier for the element classification that groups elements with similar characteristics. It controls the order in which the elements are processed and the balances that are fed by them.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReportingName":{
            "title":"Reporting Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the element that's displayed on reports and pay advices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseAtAssignmentLevel":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the element can be associated with only employee payroll assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"System-generated unique identifier for the person.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the legislative data group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputCurrencyCode":{
            "title":"Priority",
            "maxLength":15,
            "type":"string",
            "description":"Currency code for those element entry result values that use money as the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryClassificationId":{
            "type":"integer",
            "description":"Unique identifier for the subordinate group of elements within a primary element classification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessingType":{
            "title":"Element Processing Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether an element entry is recurring or nonrecurring.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryClassificationName":{
            "title":"Element Classification Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the element classification that groups elements with similar characteristics, such as earnings or involuntary deduction. It controls the order in which the elements are processed and the balances that are fed by them.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"System-generated unique identifier for the element.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the period during which the element is available for processing.",
            "format":"date",
            "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 : 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."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve a payroll element definition using the element name by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/payrollElementDefinitionsLOV?q=ElementName='A01_CHILD_SUPPORT'"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
  "items" : [ {
    "ElementTypeId" : 300100128817404,
    "EffectiveStartDate" : "2016-01-01",
    "EffectiveEndDate" : "4712-12-31",
    "ElementName" : "A01_CHILD_SUPPORT",
    "ReportingName" : "A01_CHILD_SUPPORT",
    "UseAtRelationshipLevel" : "Y",
    "UseAtAssignmentLevel" : "N",
    "ProcessingType" : "R",
    "LegislativeDataGroupId" : 300100001794247,
    "LegislationCode" : null,
    "InputCurrencyCode" : "USD",
    "OutputCurrencyCode" : "USD",
    "PrimaryClassificationName" : "Involuntary Deductions",
    "LegislativeDataGroupName" : "ZHRX_USVS_ST LDG One",
    "PrimaryClassificationId" : 100010032607677,
    "SecondaryClassificationId" : 100010026299330,
    "SecondaryClassificationName" : "Support Child",
    "PersonId" : null,
    "links" : [ 
		   {
		     ....}
	]
}

Back to Top