Jump to

• Request
• Response
• Examples

Create a time record event attribute

post

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

Request

Path Parameters

• timeRecordEventId(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=
• timeRecordEventRequestId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• attributeName: string
  Maximum Length: 240

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

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

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

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : timeRecordEventRequests-timeRecordEvent-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 : 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."
        }
    }
}

Back to Top

Examples

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

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

Example of Payload

The following is an example of the payload.

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

Example of Response Header

The following is an example of the response header.

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

Example of Response Body

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

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

Back to Top