Jump to

• Request
• Response

Get all time event requests

get

/hcmRestApi/resources/11.13.18.05/timeEventRequests

Request

Query Parameters

• 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
• finder: string
  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 a time event request using its identifier.
    Finder Variables
    • timeEventRequestId; integer; Unique identifier for the time event request.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • requestNumber; string; Unique identifier for the time event request sent by the time collection device supplier.
  • requestTimestamp; string; Date and time when the time event request was created.
  • sourceId; string; Unique identifier for the source creating the data, for example, supplier name or facility identifier.
  • timeEventRequestId; integer; Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.
• totalResults: boolean
  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

• 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 : timeEventRequests

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/timeEventRequests-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object timeEventRequests-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/timeEventRequests-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 : timeEventRequests-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• requestNumber: string
  Maximum Length: 80

  Unique identifier for the time event request sent by the time collection device supplier.
• requestTimestamp: string
  Maximum Length: 80

  Date and time when the time event request was created.
• sourceId: string
  Maximum Length: 40

  Unique identifier for the source creating the data, for example, supplier name or facility identifier.
• timeEventRequestId: integer (int64)
  Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.
• timeEvents: array Time Events
  Title: Time Events

  The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device.

{
    "type":"object",
    "properties":{
        "sourceId":{
            "maxLength":40,
            "type":"string",
            "description":"Unique identifier for the source creating the data, for example, supplier name or facility identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "requestNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the time event request sent by the time collection device supplier.",
            "nullable":false,
            "x-queryable":true
        },
        "requestTimestamp":{
            "maxLength":80,
            "type":"string",
            "description":"Date and time when the time event request was created.",
            "nullable":false,
            "x-queryable":true
        },
        "timeEventRequestId":{
            "type":"integer",
            "description":"Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "timeEvents":{
            "title":"Time Events",
            "type":"array",
            "description":"The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device.",
            "items":{
                "$ref":"#/components/schemas/timeEventRequests-timeEvents-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 : Time Events

Type: array

Title: Time Events

The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device.

Show Source

• Array of: object timeEventRequests-timeEvents-item-response

{
    "title":"Time Events",
    "type":"array",
    "description":"The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device.",
    "items":{
        "$ref":"#/components/schemas/timeEventRequests-timeEvents-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 : timeEventRequests-timeEvents-item-response

Type: object

Show Source

• deviceId: string
  Maximum Length: 40

  Identifier for the time collection device used to create the time event.
• eventDateTime: string
  Maximum Length: 150

  Date and time when the time event was recorded by the time collection device. The time stamp in the request must use the ISO 8601 standard with the time zone offset information. The attribute can handle either a start or end time or a start time and duration.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• reporterId: string
  Maximum Length: 80

  Identifier for the worker recording the time event with the time collection device.
• reporterIdType: string
  Maximum Length: 30

  Type of reporter identifier that the time reporter uses with the time collection device. Valid values, defined in the ReporterIDTypeList1 list, are: BADGE, PERSON, PERSONID, and ASSIGNMENT.
• supplierDeviceEvent: string
  Maximum Length: 40

  Supplier-recognized time events mapped to Workforce Management application events. For example, the supplier device event Clock In is mapped to the application event In. Valid values are defined in the ORA_HWM_TCD_SUPPLIER_EVENTS lookup type. The lookup codes are user defined.
• timeEventAttributes: array Time Event Attributes
  Title: Time Event Attributes

  The timeEventAttributes resource is a child of the timeEvents resource and the grandchild of the timeEventsRequests resource. It's a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates if the time for payroll consumers must be paid.
• timeEventId: integer (int64)
  Unique identifier for the In or Out time event that the time reporter records using a time collection device.
• timeEventRequestId: integer (int64)
  Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.

{
    "type":"object",
    "properties":{
        "eventDateTime":{
            "maxLength":150,
            "type":"string",
            "description":"Date and time when the time event was recorded by the time collection device. The time stamp in the request must use the ISO 8601 standard with the time zone offset information. The attribute can handle either a start or end time or a start time and duration.",
            "nullable":false,
            "x-queryable":true
        },
        "reporterIdType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of reporter identifier that the time reporter uses with the time collection device. Valid values, defined in the ReporterIDTypeList1 list, are: BADGE, PERSON, PERSONID, and ASSIGNMENT.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "reporterId":{
            "maxLength":80,
            "type":"string",
            "description":"Identifier for the worker recording the time event with the time collection device.",
            "nullable":false,
            "x-queryable":true
        },
        "supplierDeviceEvent":{
            "maxLength":40,
            "type":"string",
            "description":"Supplier-recognized time events mapped to Workforce Management application events. For example, the supplier device event Clock In is mapped to the application event In. Valid values are defined in the ORA_HWM_TCD_SUPPLIER_EVENTS lookup type. The lookup codes are user defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "timeEventAttributes":{
            "title":"Time Event Attributes",
            "type":"array",
            "description":"The timeEventAttributes resource is a child of the timeEvents resource and the grandchild of the timeEventsRequests resource. It's a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates if the time for payroll consumers must be paid.",
            "items":{
                "$ref":"#/components/schemas/timeEventRequests-timeEvents-timeEventAttributes-item-response"
            }
        },
        "timeEventRequestId":{
            "type":"integer",
            "description":"Unique identifier for the time event request that the time collection device supplier sends. This request can contain one or more time events.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "deviceId":{
            "maxLength":40,
            "type":"string",
            "description":"Identifier for the time collection device used to create the time event.",
            "nullable":true,
            "x-queryable":true
        },
        "timeEventId":{
            "type":"integer",
            "description":"Unique identifier for the In or Out time event that the time reporter records using a time collection device.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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 : Time Event Attributes

Type: array

Title: Time Event Attributes

The timeEventAttributes resource is a child of the timeEvents resource and the grandchild of the timeEventsRequests resource. It's a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates if the time for payroll consumers must be paid.

Show Source

• Array of: object timeEventRequests-timeEvents-timeEventAttributes-item-response

{
    "title":"Time Event Attributes",
    "type":"array",
    "description":"The timeEventAttributes resource is a child of the timeEvents resource and the grandchild of the timeEventsRequests resource. It's a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates if the time for payroll consumers must be paid.",
    "items":{
        "$ref":"#/components/schemas/timeEventRequests-timeEvents-timeEventAttributes-item-response"
    }
}

Nested Schema : timeEventRequests-timeEvents-timeEventAttributes-item-response

Type: object

Show Source

• facet: string
  Maximum Length: 150

  Attribute identifying the In or Out time event of a paired device event. Used to default a qualifier only on the In or Out facet.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• name: string
  Maximum Length: 240

  Name of the attribute associated with the time event, such as Payroll Time Type.
• timeEventAttributeId: integer (int64)
  Qualifier associated with the time event that reflects how the time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates whether time for payroll consumers should be paid.
• timeEventId: integer (int64)
  Unique identifier for the In or Out time event that the time reporter records using a time collection device.
• value: string
  Maximum Length: 150

  Value for the time event attribute, for example, Regular is a value for the Payroll Time Type time attribute.

{
    "type":"object",
    "properties":{
        "timeEventAttributeId":{
            "type":"integer",
            "description":"Qualifier associated with the time event that reflects how the time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates whether time for payroll consumers should be paid.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "name":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the attribute associated with the time event, such as Payroll Time Type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "value":{
            "maxLength":150,
            "type":"string",
            "description":"Value for the time event attribute, for example, Regular is a value for the Payroll Time Type time attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "facet":{
            "maxLength":150,
            "type":"string",
            "description":"Attribute identifying the In or Out time event of a paired device event. Used to default a qualifier only on the In or Out facet.",
            "nullable":true,
            "x-queryable":true
        },
        "timeEventId":{
            "type":"integer",
            "description":"Unique identifier for the In or Out time event that the time reporter records using a time collection device.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Back to Top