Jump to

• Request
• Response

Create an absence entry detail

post

/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails

Request

Path Parameters

• absencesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Absences resource and used to uniquely identify an instance of Absences. The client should not generate the hash key value. Instead, the client should query on the Absences collection resource in order to navigate to a specific instance of Absences to get the hash key.

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AbsenceDate: string (date)
  Title: Start Date

  Date of the absence request.
• AbsenceDatetime: string (date-time)
  Date and time of the absence request.
• AbsenceEndDatetime: string (date-time)
  Title: End Date

  End date and time of the absence request.
• AssignmentId: integer (int64)
  Title: Job or Assignment or ID

  Unique identifier of the assignment for which the absence is recorded. When an employee has multiple active assignments, this attribute can be used to restrict the absence to a specific assignment. You can't change the assignment when editing an existing absence.
• AssignmentNumber: string
  Assignment number for the absence record which can be used when an employee has multiple assignments.
• Duration: number
  Title: Duration

  Duration of the absence request.
• DurationPreferenceCode: string
  Maximum Length: 30

  Code of the absence duration preference.
• EndTime: string
  Title: End Time

  Maximum Length: 30

  End time of the absence request.
• FormattedDuration: string
  Duration of the recorded absence for a single day.
• PersonAbsenceEntryDetailId: integer
  Unique identifier for the absence entry details.
• PersonAbsenceEntryId: integer (int64)
  Unique identifier for the absence entry.
• RowSequence: integer (int64)
  Row sequence of the absence entry details.
• Source: string
  Maximum Length: 10

  Source of the absence imported from other applications. For example, an absence may be recorded via Absence Management, Time and Labor, a data loader or through the REST process.
• StartTime: string
  Title: Start Time

  Maximum Length: 30

  Start time of the absence request.

{
    "type":"object",
    "properties":{
        "AbsenceDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date of the absence request.",
            "format":"date",
            "nullable":true
        },
        "AbsenceDatetime":{
            "type":"string",
            "description":"Date and time of the absence request.",
            "format":"date-time",
            "nullable":true
        },
        "AbsenceEndDatetime":{
            "title":"End Date",
            "type":"string",
            "description":"End date and time of the absence request.",
            "format":"date-time",
            "nullable":true
        },
        "AssignmentId":{
            "title":"Job or Assignment or ID",
            "type":"integer",
            "description":"Unique identifier of the assignment for which the absence is recorded. When an employee has multiple active assignments, this attribute can be used to restrict the absence to a specific assignment. You can't change the assignment when editing an existing absence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number for the absence record which can be used when an employee has multiple assignments.",
            "nullable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"number",
            "description":"Duration of the absence request.",
            "nullable":true
        },
        "DurationPreferenceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the absence duration preference.",
            "nullable":true
        },
        "EndTime":{
            "title":"End Time",
            "maxLength":30,
            "type":"string",
            "description":"End time of the absence request.",
            "nullable":true
        },
        "FormattedDuration":{
            "type":"string",
            "description":"Duration of the recorded absence for a single day.",
            "nullable":true
        },
        "PersonAbsenceEntryDetailId":{
            "type":"integer",
            "description":"Unique identifier for the absence entry details.",
            "nullable":false,
            "x-queryable":false
        },
        "PersonAbsenceEntryId":{
            "type":"integer",
            "description":"Unique identifier for the absence entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RowSequence":{
            "type":"integer",
            "description":"Row sequence of the absence entry details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Source":{
            "maxLength":10,
            "type":"string",
            "description":"Source of the absence imported from other applications. For example, an absence may be recorded via Absence Management, Time and Labor, a data loader or through the REST process.",
            "nullable":true
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":30,
            "type":"string",
            "description":"Start time of the absence request.",
            "nullable":true
        }
    }
}

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 : absences-absenceEntryDetails-item-response

Type: object

Show Source

• AbsenceDate: string (date)
  Title: Start Date

  Date of the absence request.
• AbsenceDatetime: string (date-time)
  Date and time of the absence request.
• AbsenceEndDatetime: string (date-time)
  Title: End Date

  End date and time of the absence request.
• AssignmentId: integer (int64)
  Title: Job or Assignment or ID

  Unique identifier of the assignment for which the absence is recorded. When an employee has multiple active assignments, this attribute can be used to restrict the absence to a specific assignment. You can't change the assignment when editing an existing absence.
• AssignmentNumber: string
  Assignment number for the absence record which can be used when an employee has multiple assignments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the person who created the absence transaction.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the absence transaction was created.
• Duration: number
  Title: Duration

  Duration of the absence request.
• DurationPreferenceCode: string
  Maximum Length: 30

  Code of the absence duration preference.
• DurationPreferenceMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description of the absence bid duration preference.
• EndTime: string
  Title: End Time

  Maximum Length: 30

  End time of the absence request.
• FormattedDuration: string
  Duration of the recorded absence for a single day.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the absence transaction was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the person who last updated the absence transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonAbsenceEntryDetailId: integer
  Unique identifier for the absence entry details.
• PersonAbsenceEntryId: integer (int64)
  Unique identifier for the absence entry.
• RowSequence: integer (int64)
  Row sequence of the absence entry details.
• Source: string
  Maximum Length: 10

  Source of the absence imported from other applications. For example, an absence may be recorded via Absence Management, Time and Labor, a data loader or through the REST process.
• StartTime: string
  Title: Start Time

  Maximum Length: 30

  Start time of the absence request.

{
    "type":"object",
    "properties":{
        "AbsenceDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date of the absence request.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AbsenceDatetime":{
            "type":"string",
            "description":"Date and time of the absence request.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AbsenceEndDatetime":{
            "title":"End Date",
            "type":"string",
            "description":"End date and time of the absence request.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Job or Assignment or ID",
            "type":"integer",
            "description":"Unique identifier of the assignment for which the absence is recorded. When an employee has multiple active assignments, this attribute can be used to restrict the absence to a specific assignment. You can't change the assignment when editing an existing absence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number for the absence record which can be used when an employee has multiple assignments.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who created the absence transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the absence transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"number",
            "description":"Duration of the absence request.",
            "nullable":true,
            "x-queryable":true
        },
        "DurationPreferenceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the absence duration preference.",
            "nullable":true,
            "x-queryable":true
        },
        "DurationPreferenceMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the absence bid duration preference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "maxLength":30,
            "type":"string",
            "description":"End time of the absence request.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedDuration":{
            "type":"string",
            "description":"Duration of the recorded absence for a single day.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the absence transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who last updated the absence transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonAbsenceEntryDetailId":{
            "type":"integer",
            "description":"Unique identifier for the absence entry details.",
            "nullable":false,
            "x-queryable":false
        },
        "PersonAbsenceEntryId":{
            "type":"integer",
            "description":"Unique identifier for the absence entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RowSequence":{
            "type":"integer",
            "description":"Row sequence of the absence entry details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Source":{
            "maxLength":10,
            "type":"string",
            "description":"Source of the absence imported from other applications. For example, an absence may be recorded via Absence Management, Time and Labor, a data loader or through the REST process.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":30,
            "type":"string",
            "description":"Start time of the absence request.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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