Jump to

• Request
• Response

Get all time record event requests

get

/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a time record event request using its unique identifier.
    Finder Variables
    • timeRecordEventRequestId; integer; Unique identifier for the time record event request.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • processInline; string; Indicates whether to process the time record events inline or asynchronously.
  • processMode; string; Mode--Save, Submit, or Enter--for processing time records stored in the WFM time repository.
  • timeRecordEventRequestId; integer; Unique identifier for the time record event request.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : timeRecordEventRequests

Type: object

Show Source

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

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

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

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object timeRecordEventRequests-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/timeRecordEventRequests-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : timeRecordEventRequests-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• processInline: string
  Maximum Length: 30

  Indicates whether to process the time record events inline or asynchronously.
• processMode: string
  Maximum Length: 20

  Mode--Save, Submit, or Enter--for processing time records stored in the WFM time repository.
• timeRecordEvent: array Time Record Events
  Title: Time Record Events

  The timeRecordEvents resource is a child of the timeRecordEventRequests resource. It's a unique identifier for a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.
• timeRecordEventRequestId: integer (int64)
  Unique identifier for the time record event request.

{
    "type":"object",
    "properties":{
        "timeRecordEventRequestId":{
            "type":"integer",
            "description":"Unique identifier for the time record event request.",
            "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"
            }
        },
        "timeRecordEvent":{
            "title":"Time Record Events",
            "type":"array",
            "description":"The timeRecordEvents resource is a child of the timeRecordEventRequests resource. It's a unique identifier for a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.",
            "items":{
                "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-item-response"
            }
        },
        "processMode":{
            "maxLength":"20",
            "type":"string",
            "description":"Mode--Save, Submit, or Enter--for processing time records stored in the WFM time repository.",
            "nullable":true,
            "x-queryable":true
        },
        "processInline":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether to process the time record events inline or asynchronously.",
            "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 Events

Type: array

Title: Time Record Events

The timeRecordEvents resource is a child of the timeRecordEventRequests resource. It's a unique identifier for a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.

Show Source

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

{
    "title":"Time Record Events",
    "type":"array",
    "description":"The timeRecordEvents resource is a child of the timeRecordEventRequests resource. It's a unique identifier for a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.",
    "items":{
        "$ref":"#/components/schemas/timeRecordEventRequests-timeRecordEvent-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-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 : 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

createFavorite

Operation: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/action/createFavorite

Identifies a time card as a favorite for easy copying of time card data. For example, marks the time card for the time card period June 1, 2019 -- June 7, 2019 as a favorite with the name Regular Worked Time.

deleteFavorite

Operation: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/action/deleteFavorite

Stops identifying the time card as a favorite, including removing the unique name given to the time card when it was identified as a favorite.

Back to Top