Jump to

• Request
• Response

Create a web clock event

post

/hcmRestApi/resources/11.13.18.05/webClockEvents

Request

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• buttonId(required): integer (int64)
  Unique identifier for the web clock button associated with the event.
• 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(required): string
  Maximum Length: 40

  Unique identifier for the source of the event, such as ORA_HWM_WEBCLOCK.
• 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.
• personId(required): integer (int64)
  Unique identifier for the person associated with the web clock event.
• serverClickTime: string
  Web clock event time in server time.
• 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.

{
    "required":[
        "buttonId",
        "eventSource",
        "personId"
    ],
    "type":"object",
    "properties":{
        "DeviceType":{
            "maxLength":30,
            "type":"string",
            "description":"Source of the web clock event, such as Mobile online, Mobile offline, or Desktop.",
            "nullable":true
        },
        "timeCardFields":{
            "title":"Time Card Fields",
            "type":"array",
            "description":"The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event.",
            "items":{
                "$ref":"#/components/schemas/webClockEvents-timeCardFields-item-post-request"
            }
        },
        "buttonId":{
            "type":"integer",
            "description":"Unique identifier for the web clock button associated with the event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TimeEventId":{
            "type":"integer",
            "description":"Unique identifier for the time event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "eventSource":{
            "maxLength":40,
            "type":"string",
            "description":"Unique identifier for the source of the event, such as ORA_HWM_WEBCLOCK.",
            "nullable":false
        },
        "webClockClickId":{
            "type":"integer",
            "description":"Unique identifier for the web clock event.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "personId":{
            "type":"integer",
            "description":"Unique identifier for the person associated with the web clock event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "deviceClickTime":{
            "maxLength":80,
            "type":"string",
            "description":"Web clock event time in device time.",
            "nullable":true
        },
        "GeoLocation":{
            "maxLength":150,
            "type":"string",
            "description":"Geolocation for the web clock event, provided by the online mobile app or mobile device browser.",
            "nullable":true
        },
        "GeoLocationException":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies why the geolocation information is missing for the web clock event.",
            "nullable":true
        },
        "timeTamperedFlag":{
            "type":"boolean",
            "description":"Indicates whether the time reporter manipulated the device time. Valid values are true and false. The default value is false.",
            "nullable":true
        },
        "serverClickTime":{
            "type":"string",
            "description":"Web clock event time in server time.",
            "nullable":true
        }
    }
}

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

• Array of: object webClockEvents-timeCardFields-item-post-request

{
    "title":"Time Card Fields",
    "type":"array",
    "description":"The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event.",
    "items":{
        "$ref":"#/components/schemas/webClockEvents-timeCardFields-item-post-request"
    }
}

Nested Schema : webClockEvents-timeCardFields-item-post-request

Type: object

Show Source

• timeCardFieldId: integer (int64)
  Unique identifier for the time card field.
• timeCardFieldValueId: string
  Maximum Length: 150

  Default Value: -1

  Unique identifier for the value of the time card field.

{
    "type":"object",
    "properties":{
        "timeCardFieldId":{
            "type":"integer",
            "description":"Unique identifier for the time card field.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "timeCardFieldValueId":{
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier for the value of the time card field.",
            "nullable":false,
            "default":"-1"
        }
    }
}

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

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status for the time event, such as NEW, INPROCESS, or COMPLETE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "iconName":{
            "maxLength":150,
            "type":"string",
            "description":"Icon to show on the web clock button.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":255,
            "type":"string",
            "description":"Data type for the web clock event, such as In or Out.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "eventSource":{
            "maxLength":40,
            "type":"string",
            "description":"Unique identifier for the source of the event, such as ORA_HWM_WEBCLOCK.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeRequestPendingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there is a change request pending for the time event. Valid values are true and false. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "deviceClickTime":{
            "maxLength":80,
            "type":"string",
            "description":"Web clock event time in device time.",
            "nullable":true,
            "x-queryable":true
        },
        "GeoLocationException":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies why the geolocation information is missing for the web clock event.",
            "nullable":true,
            "x-queryable":true
        },
        "timeTamperedFlag":{
            "type":"boolean",
            "description":"Indicates whether the time reporter manipulated the device time. Valid values are true and false. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "buttonLabel":{
            "maxLength":150,
            "type":"string",
            "description":"Label to show on the web clock button.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeviceType":{
            "maxLength":30,
            "type":"string",
            "description":"Source of the web clock event, such as Mobile online, Mobile offline, or Desktop.",
            "nullable":true,
            "x-queryable":true
        },
        "timeCardFields":{
            "title":"Time Card Fields",
            "type":"array",
            "description":"The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event.",
            "items":{
                "$ref":"#/components/schemas/webClockEvents-timeCardFields-item-response"
            }
        },
        "buttonId":{
            "type":"integer",
            "description":"Unique identifier for the web clock button associated with the event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimeEventId":{
            "type":"integer",
            "description":"Unique identifier for the time event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "webClockClickId":{
            "type":"integer",
            "description":"Unique identifier for the web clock event.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "personId":{
            "type":"integer",
            "description":"Unique identifier for the person associated with the web clock event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeoLocation":{
            "maxLength":150,
            "type":"string",
            "description":"Geolocation for the web clock event, provided by the online mobile app or mobile device browser.",
            "nullable":true,
            "x-queryable":true
        },
        "serverClickTime":{
            "type":"string",
            "description":"Web clock event time in server time.",
            "nullable":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 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

• Array of: object webClockEvents-timeCardFields-item-response

{
    "title":"Time Card Fields",
    "type":"array",
    "description":"The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event.",
    "items":{
        "$ref":"#/components/schemas/webClockEvents-timeCardFields-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 : webClockEvents-timeCardFields-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "timeCardFieldDisplayName":{
            "maxLength":150,
            "type":"string",
            "description":"Display name for the time card field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeCardFieldName":{
            "maxLength":500,
            "type":"string",
            "description":"Name of the time card field.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "timeCardFieldId":{
            "type":"integer",
            "description":"Unique identifier for the time card field.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "timeCardFieldValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the time card field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeCardFieldValueId":{
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier for the value of the time card field.",
            "nullable":false,
            "default":"-1",
            "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

timeCardFields

Operation: /hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}/child/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.

Back to Top