Jump to

• Request
• Response

Update a time event

patch

/hcmRestApi/resources/11.13.18.05/timeEvents/{TimeEventId}

Request

Path Parameters

• TimeEventId(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=

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• timeEventAttributeValues: array Time Event Attribute Values
  Title: Time Event Attribute Values

  The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.

{
    "type":"object",
    "properties":{
        "timeEventAttributeValues":{
            "title":"Time Event Attribute Values",
            "type":"array",
            "description":"The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.",
            "items":{
                "$ref":"#/components/schemas/timeEvents-timeEventAttributeValues-item-patch-request"
            }
        }
    }
}

Nested Schema : Time Event Attribute Values

Type: array

Title: Time Event Attribute Values

The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.

Show Source

• Array of: object timeEvents-timeEventAttributeValues-item-patch-request

{
    "title":"Time Event Attribute Values",
    "type":"array",
    "description":"The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.",
    "items":{
        "$ref":"#/components/schemas/timeEvents-timeEventAttributeValues-item-patch-request"
    }
}

Nested Schema : timeEvents-timeEventAttributeValues-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : timeEvents-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 255

  User name for the person who created the time event.
• CreationDate: string (date-time)
  Read Only: true

  Creation date and time for the time event.
• DeviceId: string
  Read Only: true

  Maximum Length: 255

  Device that the time event was recorded on, such as Web Clock.
• EventTime: string
  Read Only: true

  Maximum Length: 255

  Time of the event that was recorded.
• EventType: string
  Read Only: true

  Maximum Length: 255

  Type for the time event, such as In or Out.
• GeolocationExistFlag: boolean
  Read Only: true

  Indicates whether a geolocation exists for the event. Valid values are Y or N. The default value is N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer
  Read Only: true

  Unique identifier for the person who recorded the time event.
• PersonName: string
  Read Only: true

  Maximum Length: 255

  Person name for the time event.
• PersonNumber: string
  Read Only: true

  Maximum Length: 255

  Person number for the time event.
• SourceIdentifier: string
  Read Only: true

  Maximum Length: 255

  Identifier for the source of the reporter associated with the time event.
• SourceIdentifierType: string
  Read Only: true

  Maximum Length: 255

  Type of identifier for the source of the reporter associated with the time event such as PERSONID, ASSIGNMENTID, or PERSON.
• Status: string
  Read Only: true

  Maximum Length: 255

  Status for the time event, such as New, Completed, or Processing.
• StatusCode: string
  Read Only: true

  Maximum Length: 255

  Status code for the time event, such as NEW, COMPLETED, or PROCESSING.
• timeEventAttributeValues: array Time Event Attribute Values
  Title: Time Event Attribute Values

  The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.
• TimeEventId: integer
  Read Only: true

  Unique identifier for the time event.
• TimeEventVersion: integer
  Read Only: true

  Version for the time event.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Person number for the time event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status for the time event, such as New, Completed, or Processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date and time for the time event.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "maxLength":255,
            "type":"string",
            "description":"Person name for the time event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User name for the person who created the time event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventType":{
            "maxLength":255,
            "type":"string",
            "description":"Type for the time event, such as In or Out.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeviceId":{
            "maxLength":255,
            "type":"string",
            "description":"Device that the time event was recorded on, such as Web Clock.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Identifier for the source of the reporter associated with the time event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceIdentifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of identifier for the source of the reporter associated with the time event such as PERSONID, ASSIGNMENTID, or PERSON.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Status code for the time event, such as NEW, COMPLETED, or PROCESSING.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeEventVersion":{
            "type":"integer",
            "description":"Version for the time event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for the person who recorded the time event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time of the event that was recorded.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeolocationExistFlag":{
            "type":"boolean",
            "description":"Indicates whether a geolocation exists for the event. Valid values are Y or N. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeEventId":{
            "type":"integer",
            "description":"Unique identifier for the time event.",
            "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"
            }
        },
        "timeEventAttributeValues":{
            "title":"Time Event Attribute Values",
            "type":"array",
            "description":"The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.",
            "items":{
                "$ref":"#/components/schemas/timeEvents-timeEventAttributeValues-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 Event Attribute Values

Type: array

Title: Time Event Attribute Values

The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.

Show Source

• Array of: object timeEvents-timeEventAttributeValues-item-response

{
    "title":"Time Event Attribute Values",
    "type":"array",
    "description":"The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.",
    "items":{
        "$ref":"#/components/schemas/timeEvents-timeEventAttributeValues-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 : timeEvents-timeEventAttributeValues-item-response

Type: object

Show Source

• AttributeCode: string
  Read Only: true

  Maximum Length: 255

  Code for the time event attribute.
• AttributeId: integer
  Read Only: true

  Unique identifier for the time event attribute.
• AttributeName: string
  Read Only: true

  Maximum Length: 255

  Display name for the time event attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TimeEventId: integer
  Read Only: true

  Unique identifier for the time event.

{
    "type":"object",
    "properties":{
        "TimeEventId":{
            "type":"integer",
            "description":"Unique identifier for the time event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code for the time event attribute.",
            "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":255,
            "type":"string",
            "description":"Display name for the time event attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Unique identifier for the time event attribute.",
            "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

timeEventAttributeValues

Operation: /hcmRestApi/resources/11.13.18.05/timeEvents/{TimeEventId}/child/timeEventAttributeValues

Parameters:

• TimeEventId: $request.path.TimeEventId

The timeEventAttributeValues resource is a child of the timeEvents resource. It provides all time event attribute values.

Back to Top