Jump to

• Request
• Response

Get all time records

get

/hcmRestApi/resources/11.13.18.05/timeRecords

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 using its unique identifier.
    Finder Variables
    • timeRecordId; number; Unique identifier of the time record.
  • filterByGroupType Finds time records using a specific time record layer.
    Finder Variables
    • groupType; string; Layer where time records are retrieved from, such as processed time or absence entry details.
  • filterByPerIdTimeGrp Finds time records using the person identifier and the start and end times.
    Finder Variables
    • groupType; string; Layer where time records are retrieved from, such as processed time or absence entry details.
    • personId; integer; Unique identifier for the person associated with the time record.
    • startTime; string; Start time for the range containing the time record groups to retrieve.
    • stopTime; string; End time for the range containing the time record groups to retrieve.
  • filterByPerNumTimeGrp Finds time records using the person number and the start and end times.
    Finder Variables
    • groupType; string; Layer where time records are retrieved from, such as processed time or absence entry details.
    • personNumber; string; Number for the person associated with the time record.
    • startTime; string; Start time for the range containing the time records to retrieve.
    • stopTime; string; End time for the range containing the time records to retrieve.
  • filterByTmRecGrpId Finds time records for a defined time record group identifier.
    Finder Variables
    • timeRecordGroupId; integer; Unique identifier for the time record group.
  • filterByTmRecId Finds a time record using its time record identifier.
    Finder Variables
    • timeRecordId; number; Unique identifier for the time record.
• 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:
  

  • assignmentNumber; string; Assignment number for the person associated with the time record.
  • comment; string; Comment associated with the time record.
  • earnedDate; string; Time entry date determined by the earned day rule configuration.
  • groupType; string; Layer where time record groups are retrieved from, such as processed time or posted schedule shift.
  • measure; number; Quantity, in hours or units, for the time record.
  • overtimeDate; string; Time entry date determined by the overtime day rule and start time configuration.
  • personId; integer; Unique identifier for the person associated with the time record.
  • personNumber; string; Number for the person associated with the time record.
  • recordType; string; Type for the time record, either measure or range.
  • startTime; string; Start time for the range containing the time records to retrieve.
  • stopTime; string; End time for the range containing the time records to retrieve.
  • timeRecordGroupId; integer; Unique identifier for the time record group containing the reported time record.
  • timeRecordGroupVersion; integer; Version number for the time record group stored in the Workforce Management time repository.
  • timeRecordId; number; Unique identifier for the time record.
  • timeRecordVersion; integer; Version number for the time record stored in the Workforce Management time repository.
  • unitOfMeasure; string; Unit of measure for the time record, such as hours or units.
• 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 : timeRecords

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/timeRecords-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object timeRecords-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/timeRecords-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 : timeRecords-item-response

Type: object

Show Source

• assignmentNumber: string
  Read Only: true

  Maximum Length: 50

  Assignment number for the person associated with the time record.
• comment: string
  Read Only: true

  Maximum Length: 1000

  Comment associated with the time record.
• earnedDate: string (date)
  Read Only: true

  Time entry date determined by the earned day rule configuration.
• groupType: string
  Read Only: true

  Maximum Length: 255

  Layer where time record groups are retrieved from, such as processed time or posted schedule shift.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measure: number
  Read Only: true

  Quantity, in hours or units, for the time record.
• overtimeDate: string (date)
  Read Only: true

  Time entry date determined by the overtime day rule and start time configuration.
• personId: integer (int64)
  Read Only: true

  Unique identifier for the person associated with the time record.
• personNumber: string
  Read Only: true

  Maximum Length: 30

  Number for the person associated with the time record.
• recordType: string
  Read Only: true

  Maximum Length: 30

  Type for the time record, either measure or range.
• startTime: string (date-time)
  Read Only: true

  Start time for the range containing the time records to retrieve.
• stopTime: string (date-time)
  Read Only: true

  End time for the range containing the time records to retrieve.
• timeAttributes: array Time Attributes
  Title: Time Attributes

  The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.
• timeMessages: array Time Messages
  Title: Time Messages

  The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.
• timeRecordGroupId: integer (int64)
  Read Only: true

  Unique identifier for the time record group containing the reported time record.
• timeRecordGroupVersion: integer (int32)
  Read Only: true

  Version number for the time record group stored in the Workforce Management time repository.
• timeRecordId: number
  Read Only: true

  Unique identifier for the time record.
• timeRecordVersion: integer (int32)
  Read Only: true

  Version number for the time record stored in the Workforce Management time repository.
• timeStatuses: array Time Statuses
  Title: Time Statuses

  The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.
• unitOfMeasure: string
  Read Only: true

  Maximum Length: 80

  Unit of measure for the time record, such as hours or units.

{
    "type":"object",
    "properties":{
        "groupType":{
            "maxLength":255,
            "type":"string",
            "description":"Layer where time record groups are retrieved from, such as processed time or posted schedule shift.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "unitOfMeasure":{
            "maxLength":80,
            "type":"string",
            "description":"Unit of measure for the time record, such as hours or units.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "overtimeDate":{
            "type":"string",
            "description":"Time entry date determined by the overtime day rule and start time configuration.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "recordType":{
            "maxLength":30,
            "type":"string",
            "description":"Type for the time record, either measure or range.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "timeRecordGroupVersion":{
            "type":"integer",
            "description":"Version number for the time record group stored in the Workforce Management time repository.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "timeStatuses":{
            "title":"Time Statuses",
            "type":"array",
            "description":"The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.",
            "items":{
                "$ref":"#/components/schemas/timeRecords-timeStatuses-item-response"
            }
        },
        "timeRecordGroupId":{
            "type":"integer",
            "description":"Unique identifier for the time record group containing the reported time record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "personNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number for the person associated with the time record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "timeRecordId":{
            "type":"number",
            "description":"Unique identifier for the time record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "measure":{
            "type":"number",
            "description":"Quantity, in hours or units, for the time record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "earnedDate":{
            "type":"string",
            "description":"Time entry date determined by the earned day rule configuration.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeRecordVersion":{
            "type":"integer",
            "description":"Version number for the time record stored in the Workforce Management time repository.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "timeMessages":{
            "title":"Time Messages",
            "type":"array",
            "description":"The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.",
            "items":{
                "$ref":"#/components/schemas/timeRecords-timeMessages-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "startTime":{
            "type":"string",
            "description":"Start time for the range containing the time records to retrieve.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "stopTime":{
            "type":"string",
            "description":"End time for the range containing the time records to retrieve.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "personId":{
            "type":"integer",
            "description":"Unique identifier for the person associated with the time record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "comment":{
            "maxLength":1000,
            "type":"string",
            "description":"Comment associated with the time record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignmentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Assignment number for the person associated with the time record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeAttributes":{
            "title":"Time Attributes",
            "type":"array",
            "description":"The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.",
            "items":{
                "$ref":"#/components/schemas/timeRecords-timeAttributes-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 : Time Attributes

Type: array

Title: Time Attributes

The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.

Show Source

• Array of: object timeRecords-timeAttributes-item-response

{
    "title":"Time Attributes",
    "type":"array",
    "description":"The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.",
    "items":{
        "$ref":"#/components/schemas/timeRecords-timeAttributes-item-response"
    }
}

Nested Schema : Time Messages

Type: array

Title: Time Messages

The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.

Show Source

• Array of: object timeRecords-timeMessages-item-response

{
    "title":"Time Messages",
    "type":"array",
    "description":"The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.",
    "items":{
        "$ref":"#/components/schemas/timeRecords-timeMessages-item-response"
    }
}

Nested Schema : Time Statuses

Type: array

Title: Time Statuses

The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.

Show Source

• Array of: object timeRecords-timeStatuses-item-response

{
    "title":"Time Statuses",
    "type":"array",
    "description":"The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.",
    "items":{
        "$ref":"#/components/schemas/timeRecords-timeStatuses-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 : timeRecords-timeAttributes-item-response

Type: object

Show Source

• attributeId: number
  Read Only: true

  Unique identifier for the time record group attribute.
• attributeName: string
  Read Only: true

  Maximum Length: 240

  Name of the time record group attribute, such as Comment.
• attributeType: string
  Read Only: true

  Maximum Length: 240

  Type for the time record group attribute, such as Varchar.
• attributeValue: string
  Read Only: true

  Maximum Length: 240

  Value for the time record group attribute, such as a comment text.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• timeBuildingBlockId: number
  Read Only: true

  Unique identifier for the time record group with the specified attributes.
• timeBuildingBlockVersion: integer (int32)
  Read Only: true

  Version number for the time record group with the specified attributes.

{
    "type":"object",
    "properties":{
        "attributeId":{
            "type":"number",
            "description":"Unique identifier for the time record group attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeBuildingBlockVersion":{
            "type":"integer",
            "description":"Version number for the time record group with the specified attributes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "attributeValue":{
            "maxLength":240,
            "type":"string",
            "description":"Value for the time record group attribute, such as a comment text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attributeType":{
            "maxLength":240,
            "type":"string",
            "description":"Type for the time record group attribute, such as Varchar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeBuildingBlockId":{
            "type":"number",
            "description":"Unique identifier for the time record group with the specified attributes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "attributeName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the time record group attribute, such as Comment.",
            "nullable":true,
            "readOnly":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 : timeRecords-timeMessages-item-response

Type: object

Show Source

• allowedException: string
  Read Only: true

  Maximum Length: 1

  Indicates whether to allow the exception associated with the time record group. Valid values are true and false. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• messageCode: string
  Read Only: true

  Maximum Length: 256

  Code for the message associated with the time record group.
• messageId: integer (int64)
  Read Only: true

  Unique identifier for the message associated with the time record group.
• messageText: string
  Read Only: true

  Maximum Length: 240

  Text for the message associated with the time record group.
• ruleId: integer (int64)
  Read Only: true

  Unique identifier for the rule from which messages were generated.
• ruleSetId: integer (int64)
  Read Only: true

  Unique identifier for the rule set containing the rules from which messages were generated.
• ruleSetType: string
  Read Only: true

  Maximum Length: 32

  Type of the rule set containing the rules that messages were generated from, such as TCR for time calculation rule.
• severity: string
  Read Only: true

  Maximum Length: 30

  Severity for the message associated with the time record group.
• tag: string
  Read Only: true

  Maximum Length: 120

  Label attached to the message related to the time record group for identification.
• timeBuildingBlockId: integer (int64)
  Read Only: true

  Unique identifier for the time record group with the specified messages.
• timeBuildingBlockVersion: integer (int32)
  Read Only: true

  Version number for the time record group with the specified messages.
• timeMessageTokens: array Time Message Tokens
  Title: Time Message Tokens

  The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.

{
    "type":"object",
    "properties":{
        "severity":{
            "maxLength":30,
            "type":"string",
            "description":"Severity for the message associated with the time record group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "timeMessageTokens":{
            "title":"Time Message Tokens",
            "type":"array",
            "description":"The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.",
            "items":{
                "$ref":"#/components/schemas/timeRecords-timeMessages-timeMessageTokens-item-response"
            }
        },
        "timeBuildingBlockVersion":{
            "type":"integer",
            "description":"Version number for the time record group with the specified messages.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "messageText":{
            "maxLength":240,
            "type":"string",
            "description":"Text for the message associated with the time record group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ruleSetType":{
            "maxLength":32,
            "type":"string",
            "description":"Type of the rule set containing the rules that messages were generated from, such as TCR for time calculation rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeBuildingBlockId":{
            "type":"integer",
            "description":"Unique identifier for the time record group with the specified messages.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "messageId":{
            "type":"integer",
            "description":"Unique identifier for the message associated with the time record group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "allowedException":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether to allow the exception associated with the time record group. Valid values are true and false. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "messageCode":{
            "maxLength":256,
            "type":"string",
            "description":"Code for the message associated with the time record group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "tag":{
            "maxLength":120,
            "type":"string",
            "description":"Label attached to the message related to the time record group for identification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ruleId":{
            "type":"integer",
            "description":"Unique identifier for the rule from which messages were generated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ruleSetId":{
            "type":"integer",
            "description":"Unique identifier for the rule set containing the rules from which messages were generated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Nested Schema : Time Message Tokens

Type: array

Title: Time Message Tokens

The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.

Show Source

• Array of: object timeRecords-timeMessages-timeMessageTokens-item-response

{
    "title":"Time Message Tokens",
    "type":"array",
    "description":"The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.",
    "items":{
        "$ref":"#/components/schemas/timeRecords-timeMessages-timeMessageTokens-item-response"
    }
}

Nested Schema : timeRecords-timeMessages-timeMessageTokens-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• messageId: integer (int64)
  Read Only: true

  Unique identifier for the message of the defined token.
• messageTokenId: integer (int64)
  Read Only: true

  Unique identifier for the message token.
• tokenName: string
  Read Only: true

  Maximum Length: 256

  Name of the token for the message associated with the time record group.
• tokenValue: string
  Read Only: true

  Maximum Length: 256

  Value for the token of the message associated with the time record group.

{
    "type":"object",
    "properties":{
        "messageTokenId":{
            "type":"integer",
            "description":"Unique identifier for the message token.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "tokenName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the token for the message associated with the time record group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "messageId":{
            "type":"integer",
            "description":"Unique identifier for the message of the defined token.",
            "format":"int64",
            "nullable":false,
            "readOnly":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"
            }
        },
        "tokenValue":{
            "maxLength":256,
            "type":"string",
            "description":"Value for the token of the message associated with the time record group.",
            "nullable":true,
            "readOnly":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 : timeRecords-timeStatuses-item-response

Type: object

Show Source

• displayValue: string
  Read Only: true

  Maximum Length: 80

  Value displayed for the time record group status, such as Submitted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• statusCode: string
  Read Only: true

  Maximum Length: 32

  Code for the time record group status, such as D_TM_UI_STATUS for Time Card UI status.
• statusId: integer (int64)
  Read Only: true

  Unique identifier for the time record group status.
• statusName: string
  Read Only: true

  Maximum Length: 255

  Name of the time record group status, such as Time Card UI Status.
• statusValue: string
  Read Only: true

  Maximum Length: 30

  Value for the time record group status, such as SUBMITTED.
• timeBuildingBlockId: integer (int64)
  Read Only: true

  Unique identifier for the time record group with the specified status.
• timeBuildingBlockVersion: integer (int32)
  Read Only: true

  Version number for the time record group with the specified status.

{
    "type":"object",
    "properties":{
        "displayValue":{
            "maxLength":80,
            "type":"string",
            "description":"Value displayed for the time record group status, such as Submitted.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "timeBuildingBlockVersion":{
            "type":"integer",
            "description":"Version number for the time record group with the specified status.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "statusId":{
            "type":"integer",
            "description":"Unique identifier for the time record group status.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "statusValue":{
            "maxLength":30,
            "type":"string",
            "description":"Value for the time record group status, such as SUBMITTED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "timeBuildingBlockId":{
            "type":"integer",
            "description":"Unique identifier for the time record group with the specified status.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "statusName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the time record group status, such as Time Card UI Status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "statusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Code for the time record group status, such as D_TM_UI_STATUS for Time Card UI status.",
            "nullable":true,
            "readOnly":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"
    }
}

Back to Top