Jump to

• Request
• Response

Get a time record group message

get

/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId}

Request

Path Parameters

• messageId(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=
• timeRecordGroupId(required): integer
  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=
• timeRecordId(required): number
  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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : timeRecordGroups-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/timeRecordGroups-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 timeRecordGroups-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/timeRecordGroups-timeRecords-timeMessages-timeMessageTokens-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 : timeRecordGroups-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"
    }
}

Links

timeMessageTokens

Operation: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId}/child/timeMessageTokens

Parameters:

• messageId4: $request.path.messageId4
• timeRecordGroupId: $request.path.timeRecordGroupId
• timeRecordId2: $request.path.timeRecordId2

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.

Back to Top