Jump to

• Request
• Response

Create a time event

post

/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents

Request

Path Parameters

• timeEventRequestId(required): integer(int64)
  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=

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

• deviceId: string
  Maximum Length: 40

  Identifier for the time collection device used to create the time event.
• eventDateTime(required): 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.
• reporterId(required): string
  Maximum Length: 80

  Identifier for the worker recording the time event with the time collection device.
• reporterIdType(required): 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.

{
    "required":[
        "eventDateTime",
        "reporterId",
        "reporterIdType"
    ],
    "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
        },
        "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"
            }
        },
        "reporterId":{
            "maxLength":80,
            "type":"string",
            "description":"Identifier for the worker recording the time event with the time collection device.",
            "nullable":false
        },
        "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"
            }
        },
        "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-post-request"
            }
        },
        "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
            }
        },
        "deviceId":{
            "maxLength":40,
            "type":"string",
            "description":"Identifier for the time collection device used to create the time event.",
            "nullable":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"
            }
        }
    }
}

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 schema

{
    "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-post-request"
    }
}

Nested Schema : schema

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.
• 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"
            }
        },
        "name":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the attribute associated with the time event, such as Payroll Time Type.",
            "nullable":false
        },
        "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
        },
        "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
        },
        "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
            }
        }
    }
}

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-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 : 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-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"
    }
}

Links

timeEventAttributes

Operation: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}/child/timeEventAttributes

Parameters:

• timeEventId: $request.path.timeEventId
• timeEventRequestId: $request.path.timeEventRequestId

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.

Back to Top