1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Time Attributes

Get all time attributes

get

/hcmRestApi/resources/11.13.18.05/timeAttributes

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all time attributes that Time and Labor REST services can use.
      Finder Variables
      • tmAtrbFldId; integer; Unique identifier for the field associated with the time attribute, it's used to retrieve related time attributes.
    • filterByAttrContext Finds all time attributes using the REST context.
      Finder Variables
      • contextCode; string; Value for the context, such as TIME_RECORDS_REST, used to retrieve related time attributes.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • attributeName; string; Name of the time attribute, such as PayrollTimeType, which isn't translated.
    • contextCode; string; Code for the REST context, such as TIME_EVENTS_REST or TIME_RECORDS_REST, used to get the list of time attributes and their corresponding values.
    • description; string; Description of the time attribute.
    • displayName; string; Display name for the time attribute, such as Work Type for the PayrollTimeType attribute.
    • name; string; Name of the time attribute, such as Payroll Time Type.
    • tmAtrbFldId; integer; Unique identifier for the field that the time attribute is associated with.
    • tmAtrbFldUsageId; integer; Unique Identifier for the time attribute field context usage.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : timeAttributes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : timeAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 240
    Name of the time attribute, such as PayrollTimeType, which isn't translated.
  • Maximum Length: 64
    Code for the REST context, such as TIME_EVENTS_REST or TIME_RECORDS_REST, used to get the list of time attributes and their corresponding values.
  • Data Source Usages
    Title: Data Source Usages
    The dataSourceUsages resource is a child of the time attributes resource. It retrieves the data source usage details using the time attribute field identifier. The identifier is also used to get the time attribute values.
  • Read Only: true
    Maximum Length: 240
    Description of the time attribute.
  • Read Only: true
    Maximum Length: 240
    Display name for the time attribute, such as Work Type for the PayrollTimeType attribute.
  • Links
  • Read Only: true
    Maximum Length: 240
    Name of the time attribute, such as Payroll Time Type.
  • Read Only: true
    Unique identifier for the field that the time attribute is associated with.
  • Read Only: true
    Unique Identifier for the time attribute field context usage.
Nested Schema : Data Source Usages
Type: array
Title: Data Source Usages
The dataSourceUsages resource is a child of the time attributes resource. It retrieves the data source usage details using the time attribute field identifier. The identifier is also used to get the time attribute values.
Show Source
Nested Schema : timeAttributes-dataSourceUsages-item-response
Type: object
Show Source
Nested Schema : Data Source Criteria Binds
Type: array
Title: Data Source Criteria Binds
The dataSourceCriteriaBinds resource is the child of the data source usages resource, and the grandchild of the time attributes resource. It exposes the bind variables and finders required to get some time attribute values.
Show Source
Nested Schema : timeAttributes-dataSourceUsages-dataSourceCriteriaBinds-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Name of the bind variable, such as pAssignmentId for the worker's assignment, used to get eligible values of the time attribute.
  • Maximum Length: 80
    Name of the finder used to get the time attribute values.
  • Read Only: true
    Maximum Length: 30
    Data type of the bind variable, such as VARCHAR or LONG.
  • Links
Back to Top

Examples

The following example shows how to get all time attributes 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 "Effective-Of:RangeStartDate=2010-10-12" -X  GET -d <payload> https://host:port/hcmRestApi/resources/11.13.18.05/timeAttributes

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200  OK
Content-Type : application/json

Example of Response Body

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

{
    "items": [
        {
            "contextCode": "ORA_HWM_TIME_RECORDS_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026382,
            "displayName": "Business Unit",
            "tmAtrbFldId": 300100028324327,
            "attributeName": "BUSINESS_UNIT",
            "description": "A segment of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy.",
            "links": [...]
        },
        {
            "contextCode": "ORA_HWM_TIME_RECORDS_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026383,
            "displayName": "Department ID",
            "tmAtrbFldId": 300100028324342,
            "attributeName": "ORGANIZATION_ID",
            "description": "Unique identifier for the internal structures of an enterprise for legal reporting, financial control, management reporting, and so on.",
            "links": [...]
        },
        {
            "contextCode": "ORA_HWM_TIME_RECORDS_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026384,
            "displayName": "Enterprise ID",
            "tmAtrbFldId": 300100028324333,
            "attributeName": "ENTERPRISE_ID",
            "description": "Unique identifier for the highest-level organization responsible for all other organizational structures.",
            "links": [...]
        },
        {
            "contextCode": "ORA_HTS_SCHEDULES_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026385,
            "displayName": "Allow Edits to Imported Schedule",
            "tmAtrbFldId": 300100110527708,
            "attributeName": "AllowEdit",
            "description": "Indicates whether the scheduler can edit the imported schedule using the Manage Planned Schedule task.",
            "links": [...]
        },
        {
            "contextCode": "ORA_HWM_TIME_RECORDS_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026386,
            "displayName": "Allow Edits to Imported Schedule",
            "tmAtrbFldId": 300100110527708,
            "attributeName": "AllowEdit",
            "description": "Indicates whether the scheduler can edit the imported schedule using the Manage Planned Schedule task.",
            "links": [...]
        },
        {
            "contextCode": "ORA_HTS_SCHEDULES_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026387,
            "displayName": "External Shift Number",
            "tmAtrbFldId": 300100110527710,
            "attributeName": "ExternalShiftNumber",
            "description": "Identifier for the shift coming from a third-party scheduling application.",
            "links": [...]
        },
        {
            "contextCode": "ORA_HWM_TIME_RECORDS_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026388,
            "displayName": "External Shift Number",
            "tmAtrbFldId": 300100110527710,
            "attributeName": "ExternalShiftNumber",
            "description": "Identifier for the shift coming from a third-party scheduling application.",
            "links": [...]
        },
        {
            "contextCode": "ORA_HTS_SCHEDULES_REST",
            "name": null,
            "tmAtrbFldUsageId": 300100111026389,
            "displayName": "Reference Date",
            "tmAtrbFldId": 300100050753732,
            "attributeName": "RefDate",
            "description": "Date used to group shifts that span multiple work days into a single work day for processing.",
            "links": [...]
        },
Back to Top