Get a web clock event
get
/hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}
Request
Path Parameters
-
webClockClickId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 TopResponse
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.
Root Schema : webClockEvents-item-response
Type:
Show Source
object
-
buttonId: integer
(int64)
Unique identifier for the web clock button associated with the event.
-
buttonLabel: string
Read Only:
true
Maximum Length:150
Label to show on the web clock button. -
ChangeRequestPendingFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether there is a change request pending for the time event. Valid values are true and false. The default value is false. -
deviceClickTime: string
Maximum Length:
80
Web clock event time in device time. -
DeviceType: string
Maximum Length:
30
Source of the web clock event, such as Mobile online, Mobile offline, or Desktop. -
eventSource: string
Maximum Length:
40
Unique identifier for the source of the event, such as ORA_HWM_WEBCLOCK. -
EventType: string
Read Only:
true
Maximum Length:255
Data type for the web clock event, such as In or Out. -
GeoLocation: string
Maximum Length:
150
Geolocation for the web clock event, provided by the online mobile app or mobile device browser. -
GeoLocationException: string
Maximum Length:
30
Identifies why the geolocation information is missing for the web clock event. -
iconName: string
Read Only:
true
Maximum Length:150
Icon to show on the web clock button. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
personId: integer
(int64)
Unique identifier for the person associated with the web clock event.
-
serverClickTime: string
Web clock event time in server time.
-
Status: string
Read Only:
true
Maximum Length:255
Status for the time event, such as NEW, INPROCESS, or COMPLETE. -
timeCardFields: array
Time Card Fields
Title:
Time Card Fields
The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event. -
TimeEventId: integer
(int64)
Unique identifier for the time event.
-
timeTamperedFlag: boolean
Indicates whether the time reporter manipulated the device time. Valid values are true and false. The default value is false.
-
webClockClickId: integer
Unique identifier for the web clock event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Card Fields
Type:
array
Title:
Time Card Fields
The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : webClockEvents-timeCardFields-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
timeCardFieldDisplayName: string
Read Only:
true
Maximum Length:150
Display name for the time card field. -
timeCardFieldId: integer
(int64)
Unique identifier for the time card field.
-
timeCardFieldName: string
Read Only:
true
Maximum Length:500
Name of the time card field. -
timeCardFieldValue: string
Read Only:
true
Maximum Length:4000
Value for the time card field. -
timeCardFieldValueId: string
Maximum Length:
150
Default Value:-1
Unique identifier for the value of the time card field.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- timeCardFields
-
Parameters:
- webClockClickId:
$request.path.webClockClickId
The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event. - webClockClickId: