Jump to

• Request
• Response

Get an element entry

get

/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}

Request

Path Parameters

• elementEntriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ElementEntryId, EffectiveStartDate and EffectiveEndDate ---for the Element Entries resource and used to uniquely identify an instance of Element Entries. The client should not generate the hash key value. Instead, the client should query on the Element Entries collection resource with a filter on the primary key values in order to navigate to a specific instance of Element Entries.
  
  For example: elementEntries?q=ElementEntryId=<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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : elementEntries-item-response

Type: object

Show Source

• AssignmentId: integer
  Unique identifier for a person assignment.
• AssignmentNumber: string
  Read Only: true

  Maximum Length: 255

  Person's assignment number for the element entry.
• CreatorType: string
  Title: Creator Type

  Maximum Length: 30

  Name of the user or the process that created the element entry record, such as batch element entry.
• EffectiveEndDate: string (date)
  Title: Effective End Date

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

  Date at the beginning of the period within which the entry is available for processing.
• ElementEntryHistory: array Element Entry History
  Title: Element Entry History

  The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
• ElementEntryId: integer (int64)
  Unique identifier for an element entry.
• elementEntryValues: array Element Entry Values
  Title: Element Entry Values

  The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
• ElementName: string
  Maximum Length: 80

  Name of the element the entry is for, such as Performance Bonus.
• ElementTypeId: integer (int64)
  Title: Element Name

  Unique identifier of the element type.
• EntrySequence: integer (int64)
  Title: Sequence Number

  Unique number that identifies an element entry record when overlapping entries exists for the same element.
• EntryType: string
  Title: Entry Type

  Maximum Length: 30

  Type of the element entry, such as regular entry or override.
• Intent: string
  Maximum Length: 200

  Apply internal finder validation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayrollRelationshipNumber: string
  Read Only: true

  Maximum Length: 255

  Unique number that identifies the association between a person and a payroll statutory unit based on the payroll calculation and reporting requirements.
• PersonId: integer (int64)
  Unique identifier for a person.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  Person number of the worker.
• Reason: string
  Title: Reason

  Maximum Length: 4000

  Reason for creating or updating an element entry.
• Subpriority: integer (int32)
  Title: Subpriority

  Number used to sequence the processing of element entries with the same priority.
• UsageLevel: string
  Title: Employment Level

  Read Only: true

  Maximum Length: 30

  Employment level of the element at which the entry is created.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the worker.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the period within which the entry is available for processing with element entry identifier.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreatorType":{
            "title":"Creator Type",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the user or the process that created the element entry record, such as batch element entry.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Intent":{
            "maxLength":"200",
            "type":"string",
            "description":"Apply internal finder validation.",
            "nullable":true,
            "x-queryable":false
        },
        "elementEntryValues":{
            "title":"Element Entry Values",
            "type":"array",
            "description":"The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.",
            "items":{
                "$ref":"#/components/schemas/elementEntries-elementEntryValues-item-response"
            }
        },
        "EntrySequence":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Unique number that identifies an element entry record when overlapping entries exists for the same element.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason",
            "maxLength":"4000",
            "type":"string",
            "description":"Reason for creating or updating an element entry.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageLevel":{
            "title":"Employment Level",
            "maxLength":"30",
            "type":"string",
            "description":"Employment level of the element at which the entry is created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntryType":{
            "title":"Entry Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the element entry, such as regular entry or override.",
            "nullable":false,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for a person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Subpriority":{
            "title":"Subpriority",
            "type":"integer",
            "description":"Number used to sequence the processing of element entries with the same priority.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ElementName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the element the entry is for, such as Performance Bonus.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Person's assignment number for the element entry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementEntryId":{
            "type":"integer",
            "description":"Unique identifier for an element entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for a person assignment.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ElementTypeId":{
            "title":"Element Name",
            "type":"integer",
            "description":"Unique identifier of the element type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayrollRelationshipNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique number that identifies the association between a person and a payroll statutory unit based on the payroll calculation and reporting requirements.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementEntryHistory":{
            "title":"Element Entry History",
            "type":"array",
            "description":"The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.",
            "items":{
                "$ref":"#/components/schemas/elementEntries-ElementEntryHistory-item-response"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the period within which the entry is available for processing.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Element Entry History

Type: array

Title: Element Entry History

The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.

Show Source

• Array of: object elementEntries-ElementEntryHistory-item-response

{
    "title":"Element Entry History",
    "type":"array",
    "description":"The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.",
    "items":{
        "$ref":"#/components/schemas/elementEntries-ElementEntryHistory-item-response"
    }
}

Nested Schema : Element Entry Values

Type: array

Title: Element Entry Values

The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.

Show Source

• Array of: object elementEntries-elementEntryValues-item-response

{
    "title":"Element Entry Values",
    "type":"array",
    "description":"The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.",
    "items":{
        "$ref":"#/components/schemas/elementEntries-elementEntryValues-item-response"
    }
}

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 : elementEntries-ElementEntryHistory-item-response

Type: object

Show Source

• EffectiveEndDate: string (date)
  Read Only: true

  Default entry value for the element entry.
• EffectiveStartDate: string (date)
  Read Only: true

  Unique identifier for an element entry value.
• ElementEntryId: integer (int64)
  Read Only: true

  Number assigned to an input value that determines the sequence in which the values appear.
• ElementTypeId: integer (int64)
  Read Only: true

  Indicates whether the existing entry values should be updated when the default value is updated.
• LastUpdateDate: string (date-time)
  Read Only: true

  Indicates whether a value is required for the input.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Source location of the values contained within a list of values.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultipleEntryCount: integer (int64)
  Read Only: true

  Unique identifier for an input value.
• Reason: string
  Read Only: true

  Maximum Length: 4000

  Name of the element's input value.
• Subpriority: integer (int32)
  Read Only: true

  Entry values contained within a list of values.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Source location of the values contained within a list of values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Default entry value for the element entry.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subpriority":{
            "type":"integer",
            "description":"Entry values contained within a list of values.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ElementEntryId":{
            "type":"integer",
            "description":"Number assigned to an input value that determines the sequence in which the values appear.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "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"
            }
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Indicates whether the existing entry values should be updated when the default value is updated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Unique identifier for an element entry value.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleEntryCount":{
            "type":"integer",
            "description":"Unique identifier for an input value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Reason":{
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the element's input value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates whether a value is required for the input.",
            "format":"date-time",
            "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."
        }
    }
}

Nested Schema : elementEntries-elementEntryValues-item-response

Type: object

Show Source

• BaseName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Unique identifier for the payroll
• DefaultValue: string
  Read Only: true

  Maximum Length: 60

  Default entry value for the element entry.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  Number assigned to an input value that determines the sequence in which the values appear.
• ElementEntryValueId: integer (int64)
  Unique identifier for an element entry value.
• HotDefaultFlag: boolean
  Title: Apply default at run time

  Read Only: true

  Maximum Length: 30

  Indicates whether the existing entry values should be updated when the default value is updated.
• InputValueId: integer (int64)
  Unique identifier for an input value.
• InputValueName: string
  Name of the element's input value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LovScreenEntryValue: string
  Maximum Length: 60

  Entry values contained within a list of values.
• MandatoryFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether a value is required for the input.
• PAY_VALUE_SET_ValueSetScreenEntryValue_VALUE_SET_SWITCHER: string
  Read Only: true
• ReservedInputValue: string
  Title: Special Purpose

  Read Only: true

  Maximum Length: 30

  Unique identifier for the payroll
• ScreenEntryDataURL: string
  Read Only: true

  Maximum Length: 255

  Source location of the values contained within a list of values.
• ScreenEntryValue: string
  Maximum Length: 60

  Entry for input values available for each entry of the element.
• UOM: string
  Read Only: true

  Maximum Length: 30

  Name of the type of measurement that's applicable to a number displayed in a balance, amount, or other type of numeric field such as money, character or number.
• UserEnterableFlag: boolean
  Title: Allow User Entry

  Read Only: true

  Maximum Length: 1

  Indicates whether the user can enter input values.

{
    "type":"object",
    "properties":{
        "LovScreenEntryValue":{
            "maxLength":"60",
            "type":"string",
            "description":"Entry values contained within a list of values.",
            "nullable":true,
            "x-hints":{
                "PAY_VALUE_SET_ATTRIBUTE_NAME":"ValueSetCode",
                "PAY_DEPENDENT_SOURCE_ATTRIBUTE_NAME":"InputValueName",
                "PAY_CURRENCY_CODE_ATTRIBUTE_NAME":"InputValueDP.ElementTypeDPEO.InputCurrencyCode",
                "PAY_LOV_LOOKUP_TYPE_ATTRIBUTE_NAME":"LookupType",
                "PAY_REST_DYN_LOV_FINDER_ATTRIBUTE":"ScreenEntryDataURL",
                "PAY_DEPENDENT_DESTINATION_ATTRIBUTE_NAME":"ScreenEntryValue",
                "PAY_LOV_SCREEN_ENTRY_VALUE_ATTRIBUTE_NAME":"LovScreenEntryValue",
                "PAY_VALUE_SET_PARENT_ROW_ACCESSOR":"elementEntries",
                "PAY_LOV_VO_NAME_ATTRIBUTE_NAME":"VoName",
                "PAY_VALUE_SET_BASE_ATTRIBUTE_NAME":"ScreenEntryValue",
                "PAY_UOM_ATTRIBUTE_NAME":"InputValueDP.Uom",
                "controlType":"choice",
                "includeInCompactView":true,
                "PAY_REST_DYN_LOV_ENABLE":"Y",
                "PAY_LOV_DISPLAY_SEQUENCE_ATTRIBUTE_NAME":"DisplaySequence",
                "PAY_DEPENDENT_REQUIRED_ATTRIBUTE_NAME":"MandatoryFlag"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Number assigned to an input value that determines the sequence in which the values appear.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ElementEntryValueId":{
            "type":"integer",
            "description":"Unique identifier for an element entry value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InputValueId":{
            "type":"integer",
            "description":"Unique identifier for an input value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HotDefaultFlag":{
            "title":"Apply default at run time",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the existing entry values should be updated when the default value is updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InputValueName":{
            "type":"string",
            "description":"Name of the element's input value.",
            "nullable":true,
            "x-queryable":false
        },
        "MandatoryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a value is required for the input.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScreenEntryValue":{
            "maxLength":"60",
            "type":"string",
            "description":"Entry for input values available for each entry of the element.",
            "nullable":true,
            "x-hints":{
                "PAY_DEPENDENT_SOURCE_ATTRIBUTE_NAME":"InputValueName",
                "PAY_CURRENCY_CODE_ATTRIBUTE_NAME":"InputValueDP.ElementTypeDPEO.InputCurrencyCode",
                "PAY_UOM_ATTRIBUTE_NAME":"InputValueDP.Uom",
                "PAY_DEPENDENT_DESTINATION_ATTRIBUTE_NAME":"LovScreenEntryValue",
                "PAY_DEPENDENT_REQUIRED_ATTRIBUTE_NAME":"MandatoryFlag"
            },
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":"60",
            "type":"string",
            "description":"Default entry value for the element entry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the type of measurement that's applicable to a number displayed in a balance, amount, or other type of numeric field such as money, character or number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReservedInputValue":{
            "title":"Special Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier for the payroll",
            "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"
            }
        },
        "PAY_VALUE_SET_ValueSetScreenEntryValue_VALUE_SET_SWITCHER":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScreenEntryDataURL":{
            "maxLength":"255",
            "type":"string",
            "description":"Source location of the values contained within a list of values.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAY_VALUE_SET_ATTRIBUTE_NAME":"ValueSetCode",
                "PAY_LOV_VO_NAME_ATTRIBUTE_NAME":"VoName",
                "PAY_VALUE_SET_BASE_ATTRIBUTE_NAME":"ScreenEntryValue",
                "PAY_DEPENDENT_SOURCE_ATTRIBUTE_NAME":"InputValueName",
                "PAY_LOV_LOOKUP_TYPE_ATTRIBUTE_NAME":"LookupType",
                "PAY_DEPENDENT_DESTINATION_ATTRIBUTE_NAME":"ScreenEntryValue",
                "PAY_LOV_DISPLAY_SEQUENCE_ATTRIBUTE_NAME":"DisplaySequence",
                "PAY_LOV_SCREEN_ENTRY_VALUE_ATTRIBUTE_NAME":"ScreenEntryValue",
                "PAY_VALUE_SET_PARENT_ROW_ACCESSOR":"elementEntries",
                "PAY_LOV_BASE_ATTRIBUTE_NAME":"InputValueName",
                "PAY_DEPENDENT_REQUIRED_ATTRIBUTE_NAME":"MandatoryFlag"
            },
            "x-queryable":true
        },
        "UserEnterableFlag":{
            "title":"Allow User Entry",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the user can enter input values.",
            "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

ElementEntryHistory

Operation: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/ElementEntryHistory

Parameters:

• elementEntriesUniqID: $request.path.elementEntriesUniqID

The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.

creatorTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DPAY_CREATOR_TYPE%2CLookupCode%3D{CreatorType}

The following properties are defined on the LOV link relation:

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

elementEntryValues

Operation: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues

Parameters:

• elementEntriesUniqID: $request.path.elementEntriesUniqID

The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.

Back to Top