Jump to

• Request
• Response
• Examples

Create a time record event

post

/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent

Request

Path Parameters

• timeRecordEventRequestId(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

• assignmentNumber: string
  Assignment number for the person associated with the time record event. Valid values are defined in the AssignmentPVO1 lookup type.
• changeReason: string
  Maximum Length: 64

  Reason for the audited change associated with the time record event, such as missing time entry or incorrect time entry. Valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.
• comment: string
  Maximum Length: 1000

  Comment associated with the time record event.
• crudStatusValue: integer
  Numeric value for the type of operation, such as 1 for Create, 2 for Update, or 3 for Delete, to apply when importing the time record event.
• eventStatus: string
  Processing status for the time record event, such as New, In process, or Complete.
• eventStatusValue: integer
  Numeric value for the processing status, such as 0 for New, 4 for In process, or 5 for Complete, of the time record event.
• measure: number
  Quantity, in hours or units, for the time record event.
• operationType: string
  Type of operation, such as Create, Update, or Delete, to apply when importing the time record event.
• personId: string
  Unique identifier for the person associated with the time record event.
• referenceDate: string (date)
  Date to use to process a time record event that spans multiple days.
• reporterId: string
  Maximum Length: 80

  Unique identifier for the worker associated with the time record event.
• reporterIdType: string
  Maximum Length: 20

  Type of identifier for the time reporter, such as Person or Badge.
• startTime: string
  Maximum Length: 150

  Start time for the time record event to import.
• stopTime: string
  Maximum Length: 150

  End time for the time record event to import.
• subresourceId: integer
  Identifier for the work assignment of the person associated with the time record event.
• timeRecordEventAttribute: array Time Record Event Attributes
  Title: Time Record Event Attributes

  The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..
• timeRecordEventId: integer
  Unique identifier for the time record event.
• timeRecordEventMessage: array Time Record Event Messages
  Title: Time Record Event Messages

  The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.
• timeRecordEventRequestId(required): integer
  Unique identifier for the time record event request.
• timeRecordId: integer
  Unique identifier for the time record to update or delete.
• timeRecordVersion: integer
  Version number for the time record stored in the Workforce Management time repository.

{
    "required":[
        "timeRecordEventRequestId"
    ],
    "type":"object",
    "properties":{
        "changeReason":{
            "maxLength":64,
            "type":"string",
            "description":"Reason for the audited change associated with the time record event, such as missing time entry or incorrect time entry. Valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "timeRecordEventMessage":{
            "title":"Time Record Event Messages",
            "type":"array",
            "description":"The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.",
            "items":{
                "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-post-request"
            }
        },
        "crudStatusValue":{
            "type":"integer",
            "description":"Numeric value for the type of operation, such as 1 for Create, 2 for Update, or 3 for Delete, to apply when importing the time record event.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "timeRecordEventAttribute":{
            "title":"Time Record Event Attributes",
            "type":"array",
            "description":"The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..",
            "items":{
                "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-post-request"
            }
        },
        "subresourceId":{
            "type":"integer",
            "description":"Identifier for the work assignment of the person associated with the time record event.",
            "nullable":true
        },
        "timeRecordEventRequestId":{
            "type":"integer",
            "description":"Unique identifier for the time record event request.",
            "nullable":false
        },
        "timeRecordId":{
            "type":"integer",
            "description":"Unique identifier for the time record to update or delete.",
            "nullable":true
        },
        "reporterIdType":{
            "maxLength":20,
            "type":"string",
            "description":"Type of identifier for the time reporter, such as Person or Badge.",
            "nullable":true
        },
        "measure":{
            "type":"number",
            "description":"Quantity, in hours or units, for the time record event.",
            "nullable":true
        },
        "timeRecordVersion":{
            "type":"integer",
            "description":"Version number for the time record stored in the Workforce Management time repository.",
            "nullable":true
        },
        "eventStatus":{
            "type":"string",
            "description":"Processing status for the time record event, such as New, In process, or Complete.",
            "nullable":true
        },
        "comment":{
            "maxLength":1000,
            "type":"string",
            "description":"Comment associated with the time record event.",
            "nullable":true
        },
        "personId":{
            "type":"string",
            "description":"Unique identifier for the person associated with the time record event.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "reporterId":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the worker associated with the time record event.",
            "nullable":true
        },
        "startTime":{
            "maxLength":150,
            "type":"string",
            "description":"Start time for the time record event to import.",
            "nullable":true
        },
        "stopTime":{
            "maxLength":150,
            "type":"string",
            "description":"End time for the time record event to import.",
            "nullable":true
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation, such as Create, Update, or Delete, to apply when importing the time record event.",
            "nullable":true
        },
        "eventStatusValue":{
            "type":"integer",
            "description":"Numeric value for the processing status, such as 0 for New, 4 for In process, or 5 for Complete, of the time record event.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "timeRecordEventId":{
            "type":"integer",
            "description":"Unique identifier for the time record event.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "referenceDate":{
            "type":"string",
            "description":"Date to use to process a time record event that spans multiple days.",
            "format":"date",
            "nullable":true
        },
        "assignmentNumber":{
            "type":"string",
            "description":"Assignment number for the person associated with the time record event. Valid values are defined in the AssignmentPVO1 lookup type.",
            "nullable":true
        }
    }
}

Nested Schema : Time Record Event Attributes

Type: array

Title: Time Record Event Attributes

The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..

Show Source

• Array of: object timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-post-request

{
    "title":"Time Record Event Attributes",
    "type":"array",
    "description":"The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..",
    "items":{
        "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-post-request"
    }
}

Nested Schema : Time Record Event Messages

Type: array

Title: Time Record Event Messages

The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.

Show Source

• Array of: object timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-post-request

{
    "title":"Time Record Event Messages",
    "type":"array",
    "description":"The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.",
    "items":{
        "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-post-request"
    }
}

Nested Schema : timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-post-request

Type: object

Show Source

• attributeName: string
  Maximum Length: 240

  Name of the attribute to import with the time record event, such as Payroll Time Type or Absence Management Type. Valid values are defined in the TimeAttibuteFieldPVO1 lookup type.
• attributeValue: string
  Maximum Length: 150

  Value for the attribute to import with the time record event, such as Regular or Overtime.
• changeReason: string
  Maximum Length: 64

  Reason for the audited change associated with the time record event attribute, such as missing time entry or incorrect time entry. The valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.
• timeAttributeFieldId: integer (int64)
  Unique identifier for the field that the time attribute is associated with.
• timeRecordEventAttributeId: integer (int64)
  Unique identifier for the time record event attribute.
• timeRecordEventId: integer
  Unique identifier for the time record event.

{
    "type":"object",
    "properties":{
        "changeReason":{
            "maxLength":64,
            "type":"string",
            "description":"Reason for the audited change associated with the time record event attribute, such as missing time entry or incorrect time entry. The valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "attributeValue":{
            "maxLength":150,
            "type":"string",
            "description":"Value for the attribute to import with the time record event, such as Regular or Overtime.",
            "nullable":false
        },
        "timeRecordEventAttributeId":{
            "type":"integer",
            "description":"Unique identifier for the time record event attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "timeAttributeFieldId":{
            "type":"integer",
            "description":"Unique identifier for the field that the time attribute is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "attributeName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the attribute to import with the time record event, such as Payroll Time Type or Absence Management Type. Valid values are defined in the TimeAttibuteFieldPVO1 lookup type.",
            "nullable":true
        },
        "timeRecordEventId":{
            "type":"integer",
            "description":"Unique identifier for the time record event.",
            "nullable":false
        }
    }
}

Nested Schema : timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-post-request

Type: object

Show Source

• allowException: string
  Maximum Length: 1

  Indicates whether to allow the exception associated with the time record. Valid values are true and false. The default value is false.
• attributeType: string
  Maximum Length: 20

  Type for the attribute that the message is related to, such as Timestamp for startTime.
• messageField: string
  Maximum Length: 256

  Unique identifier for the field that the message is associated with.
• messageId: integer (int64)
  Unique identifier for the message associated with the time record.
• messageName: string
  Maximum Length: 256

  Name of the message associated with the time record.
• timeBldgBlkVersion: integer (int32)
  Version number for the time record event with the specified message.
• timeRecordEventMessageId: integer (int64)
  Unique identifier for the message associated with the time record event.
• timeRecordId: integer (int64)
  Unique identifier for the time record associated with the message.

{
    "type":"object",
    "properties":{
        "messageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the message associated with the time record.",
            "nullable":false
        },
        "messageField":{
            "maxLength":256,
            "type":"string",
            "description":"Unique identifier for the field that the message is associated with.",
            "nullable":true
        },
        "timeRecordId":{
            "type":"integer",
            "description":"Unique identifier for the time record associated with the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "allowException":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether to allow the exception associated with the time record. Valid values are true and false. The default value is false.",
            "nullable":true
        },
        "attributeType":{
            "maxLength":20,
            "type":"string",
            "description":"Type for the attribute that the message is related to, such as Timestamp for startTime.",
            "nullable":true
        },
        "timeBldgBlkVersion":{
            "type":"integer",
            "description":"Version number for the time record event with the specified message.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "messageId":{
            "type":"integer",
            "description":"Unique identifier for the message associated with the time record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "timeRecordEventMessageId":{
            "type":"integer",
            "description":"Unique identifier for the message associated with the time record event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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 : timeRecordEventRequests-timeRecordEvent-item-response

Type: object

Show Source

• assignmentNumber: string
  Assignment number for the person associated with the time record event. Valid values are defined in the AssignmentPVO1 lookup type.
• changeReason: string
  Maximum Length: 64

  Reason for the audited change associated with the time record event, such as missing time entry or incorrect time entry. Valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.
• comment: string
  Maximum Length: 1000

  Comment associated with the time record event.
• crudStatusValue: integer
  Numeric value for the type of operation, such as 1 for Create, 2 for Update, or 3 for Delete, to apply when importing the time record event.
• eventStatus: string
  Processing status for the time record event, such as New, In process, or Complete.
• eventStatusValue: integer
  Numeric value for the processing status, such as 0 for New, 4 for In process, or 5 for Complete, of the time record event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measure: number
  Quantity, in hours or units, for the time record event.
• operationType: string
  Type of operation, such as Create, Update, or Delete, to apply when importing the time record event.
• personId: string
  Unique identifier for the person associated with the time record event.
• referenceDate: string (date)
  Date to use to process a time record event that spans multiple days.
• reporterId: string
  Maximum Length: 80

  Unique identifier for the worker associated with the time record event.
• reporterIdType: string
  Maximum Length: 20

  Type of identifier for the time reporter, such as Person or Badge.
• startTime: string
  Maximum Length: 150

  Start time for the time record event to import.
• stopTime: string
  Maximum Length: 150

  End time for the time record event to import.
• subresourceId: integer
  Identifier for the work assignment of the person associated with the time record event.
• timeRecordEventAttribute: array Time Record Event Attributes
  Title: Time Record Event Attributes

  The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..
• timeRecordEventId: integer
  Unique identifier for the time record event.
• timeRecordEventMessage: array Time Record Event Messages
  Title: Time Record Event Messages

  The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.
• timeRecordEventRequestId: integer
  Unique identifier for the time record event request.
• timeRecordId: integer
  Unique identifier for the time record to update or delete.
• timeRecordVersion: integer
  Version number for the time record stored in the Workforce Management time repository.

{
    "type":"object",
    "properties":{
        "changeReason":{
            "maxLength":64,
            "type":"string",
            "description":"Reason for the audited change associated with the time record event, such as missing time entry or incorrect time entry. Valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "timeRecordEventMessage":{
            "title":"Time Record Event Messages",
            "type":"array",
            "description":"The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.",
            "items":{
                "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-response"
            }
        },
        "crudStatusValue":{
            "type":"integer",
            "description":"Numeric value for the type of operation, such as 1 for Create, 2 for Update, or 3 for Delete, to apply when importing the time record event.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "timeRecordEventAttribute":{
            "title":"Time Record Event Attributes",
            "type":"array",
            "description":"The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..",
            "items":{
                "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-response"
            }
        },
        "subresourceId":{
            "type":"integer",
            "description":"Identifier for the work assignment of the person associated with the time record event.",
            "nullable":true,
            "x-queryable":true
        },
        "timeRecordEventRequestId":{
            "type":"integer",
            "description":"Unique identifier for the time record event request.",
            "nullable":false,
            "x-queryable":true
        },
        "timeRecordId":{
            "type":"integer",
            "description":"Unique identifier for the time record to update or delete.",
            "nullable":true,
            "x-queryable":true
        },
        "reporterIdType":{
            "maxLength":20,
            "type":"string",
            "description":"Type of identifier for the time reporter, such as Person or Badge.",
            "nullable":true,
            "x-queryable":true
        },
        "measure":{
            "type":"number",
            "description":"Quantity, in hours or units, for the time record event.",
            "nullable":true,
            "x-queryable":true
        },
        "timeRecordVersion":{
            "type":"integer",
            "description":"Version number for the time record stored in the Workforce Management time repository.",
            "nullable":true,
            "x-queryable":true
        },
        "eventStatus":{
            "type":"string",
            "description":"Processing status for the time record event, such as New, In process, or Complete.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "comment":{
            "maxLength":1000,
            "type":"string",
            "description":"Comment associated with the time record event.",
            "nullable":true,
            "x-queryable":true
        },
        "personId":{
            "type":"string",
            "description":"Unique identifier for the person associated with the time record event.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "reporterId":{
            "maxLength":80,
            "type":"string",
            "description":"Unique identifier for the worker associated with the time record event.",
            "nullable":true,
            "x-queryable":true
        },
        "startTime":{
            "maxLength":150,
            "type":"string",
            "description":"Start time for the time record event to import.",
            "nullable":true,
            "x-queryable":true
        },
        "stopTime":{
            "maxLength":150,
            "type":"string",
            "description":"End time for the time record event to import.",
            "nullable":true,
            "x-queryable":true
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation, such as Create, Update, or Delete, to apply when importing the time record event.",
            "nullable":true,
            "x-queryable":true
        },
        "eventStatusValue":{
            "type":"integer",
            "description":"Numeric value for the processing status, such as 0 for New, 4 for In process, or 5 for Complete, of the time record event.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "timeRecordEventId":{
            "type":"integer",
            "description":"Unique identifier for the time record event.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "referenceDate":{
            "type":"string",
            "description":"Date to use to process a time record event that spans multiple days.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "assignmentNumber":{
            "type":"string",
            "description":"Assignment number for the person associated with the time record event. Valid values are defined in the AssignmentPVO1 lookup type.",
            "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 Record Event Attributes

Type: array

Title: Time Record Event Attributes

The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..

Show Source

• Array of: object timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-response

{
    "title":"Time Record Event Attributes",
    "type":"array",
    "description":"The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..",
    "items":{
        "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-response"
    }
}

Nested Schema : Time Record Event Messages

Type: array

Title: Time Record Event Messages

The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.

Show Source

• Array of: object timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-response

{
    "title":"Time Record Event Messages",
    "type":"array",
    "description":"The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.",
    "items":{
        "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-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 : timeRecordEventRequests-timeRecordEvent-timeRecordEventAttribute-item-response

Type: object

Show Source

• attributeName: string
  Maximum Length: 240

  Name of the attribute to import with the time record event, such as Payroll Time Type or Absence Management Type. Valid values are defined in the TimeAttibuteFieldPVO1 lookup type.
• attributeValue: string
  Maximum Length: 150

  Value for the attribute to import with the time record event, such as Regular or Overtime.
• changeReason: string
  Maximum Length: 64

  Reason for the audited change associated with the time record event attribute, such as missing time entry or incorrect time entry. The valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• timeAttributeFieldId: integer (int64)
  Unique identifier for the field that the time attribute is associated with.
• timeRecordEventAttributeId: integer (int64)
  Unique identifier for the time record event attribute.
• timeRecordEventId: integer
  Unique identifier for the time record event.

{
    "type":"object",
    "properties":{
        "changeReason":{
            "maxLength":64,
            "type":"string",
            "description":"Reason for the audited change associated with the time record event attribute, such as missing time entry or incorrect time entry. The valid values are defined in the HcmLookupPVO1 lookup type. The lookup codes are user defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "attributeValue":{
            "maxLength":150,
            "type":"string",
            "description":"Value for the attribute to import with the time record event, such as Regular or Overtime.",
            "nullable":false,
            "x-queryable":true
        },
        "timeRecordEventAttributeId":{
            "type":"integer",
            "description":"Unique identifier for the time record event attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "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"
            }
        },
        "timeAttributeFieldId":{
            "type":"integer",
            "description":"Unique identifier for the field that the time attribute is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "attributeName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the attribute to import with the time record event, such as Payroll Time Type or Absence Management Type. Valid values are defined in the TimeAttibuteFieldPVO1 lookup type.",
            "nullable":true,
            "x-queryable":true
        },
        "timeRecordEventId":{
            "type":"integer",
            "description":"Unique identifier for the time record event.",
            "nullable":false,
            "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 : timeRecordEventRequests-timeRecordEvent-timeRecordEventMessage-item-response

Type: object

Show Source

• allowException: string
  Maximum Length: 1

  Indicates whether to allow the exception associated with the time record. Valid values are true and false. The default value is false.
• attributeType: string
  Maximum Length: 20

  Type for the attribute that the message is related to, such as Timestamp for startTime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• messageField: string
  Maximum Length: 256

  Unique identifier for the field that the message is associated with.
• messageId: integer (int64)
  Unique identifier for the message associated with the time record.
• messageName: string
  Maximum Length: 256

  Name of the message associated with the time record.
• timeBldgBlkVersion: integer (int32)
  Version number for the time record event with the specified message.
• timeRecordEventMessageId: integer (int64)
  Unique identifier for the message associated with the time record event.
• timeRecordId: integer (int64)
  Unique identifier for the time record associated with the message.

{
    "type":"object",
    "properties":{
        "messageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the message associated with the time record.",
            "nullable":false,
            "x-queryable":true
        },
        "messageField":{
            "maxLength":256,
            "type":"string",
            "description":"Unique identifier for the field that the message is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "timeRecordId":{
            "type":"integer",
            "description":"Unique identifier for the time record associated with the message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "allowException":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether to allow the exception associated with the time record. Valid values are true and false. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "attributeType":{
            "maxLength":20,
            "type":"string",
            "description":"Type for the attribute that the message is related to, such as Timestamp for startTime.",
            "nullable":true,
            "x-queryable":true
        },
        "timeBldgBlkVersion":{
            "type":"integer",
            "description":"Version number for the time record event with the specified message.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "messageId":{
            "type":"integer",
            "description":"Unique identifier for the message associated with the time record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "timeRecordEventMessageId":{
            "type":"integer",
            "description":"Unique identifier for the message associated with the time record event.",
            "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"
    }
}

Links

timeRecordEventAttribute

Operation: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventAttribute

Parameters:

• timeRecordEventId: $request.path.timeRecordEventId
• timeRecordEventRequestId: $request.path.timeRecordEventRequestId

The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..

timeRecordEventMessage

Operation: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventMessage

Parameters:

• timeRecordEventId: $request.path.timeRecordEventId
• timeRecordEventRequestId: $request.path.timeRecordEventRequestId

The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.

Back to Top

Examples

The following example shows how to create a time record event by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://host:port/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests

Example of Payload

The following is an example of the payload.

{
"processInline": "Y",
"processMode": "TIME_SUBMIT",
"timeRecordEvent":
[{
"timeRecordId":"",
"timeRecordVersion":"",
"startTime":"2017-11-07T13:00:00.000-08:00",
"stopTime":"2017-11-07T16:00:00.000-08:00",
"reporterIdType":"PERSON",
"reporterId":"955160008184353",
"assignmentNumber":"",
"comment":"Missing entry due to clock down",
"operationType":"ADD",
"measure":"3",
"timeRecordEventAttribute":
[{
"attributeName":"PayrollTimeType",
"attributeValue":"ZOTL_Regular"
}]
}]
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 201  Created
Content-Type : application/json

Example of Response Body

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

{
    "timeRecordEventRequestId": 300100145540850,
    "processMode": "TIME_SUBMIT",
    "processInline": "Y",
    "timeRecordEvent": [
        {
            "comment": "Missing entry due to clock down",
            "crudStatusValue": 0,
            "personId": "300100074978533",
            "referenceDate": null,
            "reporterId": "955160008184353",
            "reporterIdType": "PERSON",
            "startTime": "2017-11-07T13:00:00.000-08:00",
            "stopTime": "2017-11-07T16:00:00.000-08:00",
            "subresourceId": null,
            "timeRecordEventId": 300100145540851,
            "timeRecordEventRequestId": 300100145540850,
            "timeRecordId": null,
            "timeRecordVersion": null,
            "operationType": "ADD",
            "assignmentNumber": "",
            "eventStatusValue": 5,
            "eventStatus": "COMPLETE",
            "measure": 3,
            "changeReason": null,
            "timeRecordEventAttribute": [
                {
                    "timeAttributeFieldId": 300100028326158,
                    "timeRecordEventAttributeId": 300100145540852,
                    "timeRecordEventId": 300100145540851,
                    "attributeValue": "ZOTL_Regular",
                    "attributeName": "PayrollTimeType",
                    "changeReason": null,
                    "links": [...]
}

Back to Top