Jump to

• Request
• Response

Create an attendance violation

post

/hcmRestApi/resources/11.13.18.05/attendanceViolations

Request

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

• AbsenceId: integer (int64)
  Unique identifier for the absence entry.
• AbsenceReportingTime: string (date-time)
  Date and time when the absence was reported.
• AttendanceViolationDate: string (date)
  Date for the attendance violation.
• AttendanceViolationId: integer (int64)
  Unique identifier for the attendance violation.
• Comments: string
  Maximum Length: 2000

  Comments associated with the acknowledgment or dismissal of the attendance violation.
• EntryStartTime: string (date-time)
  Start time for the reported time entry with an attendance violation.
• EntryStopTime: string (date-time)
  Stop time for the reported time entry with an attendance violation.
• ExcusedBy: integer (int64)
  Manager who dismissed the attendance violation.
• ExcusedTime: string (date-time)
  Date and time when the manager dismissed the attendance violation.
• ObjectVersionNumber: integer (int32)
  Version for the attendance violation.
• PersonId: integer (int64)
  Unique identifier for the person associated with the attendance violation.
• Points: number
  Points related to the attendance violation.
• RuleId: integer (int64)
  Unique identifier for the attendance rule.
• RuleSetId: integer (int64)
  Unique identifier for the attendance rule set.
• RuleType: string
  Maximum Length: 64

  Rule associated with the attendance violation, such as Tardy or Leave early.
• ShiftId: integer (int64)
  Unique identifier for the schedule shift.
• ShiftStartTime: string (date-time)
  Start time for the schedule shift.
• ShiftStopTime: string (date-time)
  Stop time for the schedule shift.
• Status: string
  Maximum Length: 30

  Status for the attendance violation, such as not reviewed or dismissed.
• ThresholdPeriodStartDate: string (date)
  Start date for the period when attendance violations are counted.
• ThresholdPeriodStopDate: string (date)
  End date for the period when attendance violations are counted.
• ThresholdViolatedFlag: boolean
  Maximum Length: 1

  Indicates whether the violation exceeds the number of allowed occurrences. Valid values are true and false. The default value is false.
• TimeEntryId: integer (int64)
  Unique identifier for the time entry.
• TimeEntryVersion: integer (int32)
  Version for the time entry.
• TimeEventId: integer (int64)
  Unique identifier for the time event.

{
    "type":"object",
    "properties":{
        "AbsenceId":{
            "type":"integer",
            "description":"Unique identifier for the absence entry.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AbsenceReportingTime":{
            "type":"string",
            "description":"Date and time when the absence was reported.",
            "format":"date-time",
            "nullable":true
        },
        "AttendanceViolationDate":{
            "type":"string",
            "description":"Date for the attendance violation.",
            "format":"date",
            "nullable":false
        },
        "AttendanceViolationId":{
            "type":"integer",
            "description":"Unique identifier for the attendance violation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Comments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments associated with the acknowledgment or dismissal of the attendance violation.",
            "nullable":true
        },
        "EntryStartTime":{
            "type":"string",
            "description":"Start time for the reported time entry with an attendance violation.",
            "format":"date-time",
            "nullable":true
        },
        "EntryStopTime":{
            "type":"string",
            "description":"Stop time for the reported time entry with an attendance violation.",
            "format":"date-time",
            "nullable":true
        },
        "ExcusedBy":{
            "type":"integer",
            "description":"Manager who dismissed the attendance violation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExcusedTime":{
            "type":"string",
            "description":"Date and time when the manager dismissed the attendance violation.",
            "format":"date-time",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version for the attendance violation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for the person associated with the attendance violation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Points":{
            "type":"number",
            "description":"Points related to the attendance violation.",
            "nullable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Unique identifier for the attendance rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleSetId":{
            "type":"integer",
            "description":"Unique identifier for the attendance rule set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleType":{
            "maxLength":64,
            "type":"string",
            "description":"Rule associated with the attendance violation, such as Tardy or Leave early.",
            "nullable":false
        },
        "ShiftId":{
            "type":"integer",
            "description":"Unique identifier for the schedule shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShiftStartTime":{
            "type":"string",
            "description":"Start time for the schedule shift.",
            "format":"date-time",
            "nullable":true
        },
        "ShiftStopTime":{
            "type":"string",
            "description":"Stop time for the schedule shift.",
            "format":"date-time",
            "nullable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the attendance violation, such as not reviewed or dismissed.",
            "nullable":false
        },
        "ThresholdPeriodStartDate":{
            "type":"string",
            "description":"Start date for the period when attendance violations are counted.",
            "format":"date",
            "nullable":true
        },
        "ThresholdPeriodStopDate":{
            "type":"string",
            "description":"End date for the period when attendance violations are counted.",
            "format":"date",
            "nullable":true
        },
        "ThresholdViolatedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation exceeds the number of allowed occurrences. Valid values are true and false. The default value is false.",
            "nullable":true
        },
        "TimeEntryId":{
            "type":"integer",
            "description":"Unique identifier for the time entry.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TimeEntryVersion":{
            "type":"integer",
            "description":"Version for the time entry.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "TimeEventId":{
            "type":"integer",
            "description":"Unique identifier for the time event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• AbsenceId: integer (int64)
  Unique identifier for the absence entry.
• AbsenceReportingTime: string (date-time)
  Date and time when the absence was reported.
• AcknowledgmentRequired: string
  Read Only: true

  Maximum Length: 240

  Indicates whether an acknowledgment of the attendance violation is required from the manager. Valid values are true and false. The default value is false.
• AttendanceViolationDate: string (date)
  Date for the attendance violation.
• AttendanceViolationId: integer (int64)
  Unique identifier for the attendance violation.
• Comments: string
  Maximum Length: 2000

  Comments associated with the acknowledgment or dismissal of the attendance violation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Violations generated by the attendance rules process.
• CreationDate: string (date-time)
  Read Only: true

  Date when the attendance violation was generated.
• Department: string
  Read Only: true

  Maximum Length: 240

  Department criteria available to filter attendance violations.
• DepartmentId: integer (int64)
  Read Only: true

  Identifier for the department used to filter attendance violations.
• EntryStartTime: string (date-time)
  Start time for the reported time entry with an attendance violation.
• EntryStopTime: string (date-time)
  Stop time for the reported time entry with an attendance violation.
• ExcusedBy: integer (int64)
  Manager who dismissed the attendance violation.
• ExcusedTime: string (date-time)
  Date and time when the manager dismissed the attendance violation.
• IdentificationKey: integer (int64)
  Read Only: true

  Identification key used to get the approval task details for the attendance violation.
• Job: string
  Read Only: true

  Maximum Length: 240

  Job criteria available to filter attendance violations.
• JobId: integer (int64)
  Read Only: true

  Identifier for the job used to filter attendance violations.
• LastUpdateDate: string (date-time)
  Read Only: true

  Most recent date when the attendance violation was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Most recent manager who updated the attendance violation.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Most recent user who updated the attendance violation.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  Location criteria available to filter attendance violations.
• LocationId: integer (int64)
  Read Only: true

  Identifier for the location used to filter attendance violations.
• LoggedInUserId: integer
  Read Only: true

  Identifier for the user who's logged in.
• ObjectVersionNumber: integer (int32)
  Version for the attendance violation.
• PersonId: integer (int64)
  Unique identifier for the person associated with the attendance violation.
• PersonName: string
  Read Only: true

  Maximum Length: 240

  Name of the person associated with the attendance violation.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  Number for the person associated with the attendance violation.
• Points: number
  Points related to the attendance violation.
• RuleId: integer (int64)
  Unique identifier for the attendance rule.
• RuleSetId: integer (int64)
  Unique identifier for the attendance rule set.
• RuleType: string
  Maximum Length: 64

  Rule associated with the attendance violation, such as Tardy or Leave early.
• RuleTypeName: string
  Read Only: true

  Maximum Length: 64

  Name for the rule associated to the attendance violation, such as Tardy or Leave early.
• ShiftId: integer (int64)
  Unique identifier for the schedule shift.
• ShiftStartTime: string (date-time)
  Start time for the schedule shift.
• ShiftStopTime: string (date-time)
  Stop time for the schedule shift.
• Status: string
  Maximum Length: 30

  Status for the attendance violation, such as not reviewed or dismissed.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Code for the status of the attendance violation, such as ACKNOWLEDGED or DISMISSED.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 30

  Status of the attendance violation, such as Acknowledged or Dismissed.
• ThresholdPeriodStartDate: string (date)
  Start date for the period when attendance violations are counted.
• ThresholdPeriodStopDate: string (date)
  End date for the period when attendance violations are counted.
• ThresholdViolatedFlag: boolean
  Maximum Length: 1

  Indicates whether the violation exceeds the number of allowed occurrences. Valid values are true and false. The default value is false.
• TimeEntryId: integer (int64)
  Unique identifier for the time entry.
• TimeEntryVersion: integer (int32)
  Version for the time entry.
• TimeEventId: integer (int64)
  Unique identifier for the time event.
• TotalPoints: number
  Read Only: true

  Total number of points the worker is being granted as of the date of the attendance violation.

{
    "type":"object",
    "properties":{
        "AbsenceId":{
            "type":"integer",
            "description":"Unique identifier for the absence entry.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AbsenceReportingTime":{
            "type":"string",
            "description":"Date and time when the absence was reported.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AcknowledgmentRequired":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates whether an acknowledgment of the attendance violation is required from the manager. Valid values are true and false. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttendanceViolationDate":{
            "type":"string",
            "description":"Date for the attendance violation.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AttendanceViolationId":{
            "type":"integer",
            "description":"Unique identifier for the attendance violation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments associated with the acknowledgment or dismissal of the attendance violation.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Violations generated by the attendance rules process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the attendance violation was generated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Department":{
            "maxLength":240,
            "type":"string",
            "description":"Department criteria available to filter attendance violations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Identifier for the department used to filter attendance violations.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EntryStartTime":{
            "type":"string",
            "description":"Start time for the reported time entry with an attendance violation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EntryStopTime":{
            "type":"string",
            "description":"Stop time for the reported time entry with an attendance violation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExcusedBy":{
            "type":"integer",
            "description":"Manager who dismissed the attendance violation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExcusedTime":{
            "type":"string",
            "description":"Date and time when the manager dismissed the attendance violation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "IdentificationKey":{
            "type":"integer",
            "description":"Identification key used to get the approval task details for the attendance violation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Job":{
            "maxLength":240,
            "type":"string",
            "description":"Job criteria available to filter attendance violations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Identifier for the job used to filter attendance violations.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Most recent date when the attendance violation was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Most recent user who updated the attendance violation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Most recent manager who updated the attendance violation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "maxLength":240,
            "type":"string",
            "description":"Location criteria available to filter attendance violations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Identifier for the location used to filter attendance violations.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoggedInUserId":{
            "type":"integer",
            "description":"Identifier for the user who's logged in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version for the attendance violation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for the person associated with the attendance violation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the person associated with the attendance violation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number for the person associated with the attendance violation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Points":{
            "type":"number",
            "description":"Points related to the attendance violation.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Unique identifier for the attendance rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleSetId":{
            "type":"integer",
            "description":"Unique identifier for the attendance rule set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleType":{
            "maxLength":64,
            "type":"string",
            "description":"Rule associated with the attendance violation, such as Tardy or Leave early.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleTypeName":{
            "maxLength":64,
            "type":"string",
            "description":"Name for the rule associated to the attendance violation, such as Tardy or Leave early.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "description":"Unique identifier for the schedule shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftStartTime":{
            "type":"string",
            "description":"Start time for the schedule shift.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ShiftStopTime":{
            "type":"string",
            "description":"Stop time for the schedule shift.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the attendance violation, such as not reviewed or dismissed.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the status of the attendance violation, such as ACKNOWLEDGED or DISMISSED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the attendance violation, such as Acknowledged or Dismissed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThresholdPeriodStartDate":{
            "type":"string",
            "description":"Start date for the period when attendance violations are counted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ThresholdPeriodStopDate":{
            "type":"string",
            "description":"End date for the period when attendance violations are counted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ThresholdViolatedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the violation exceeds the number of allowed occurrences. Valid values are true and false. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "TimeEntryId":{
            "type":"integer",
            "description":"Unique identifier for the time entry.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimeEntryVersion":{
            "type":"integer",
            "description":"Version for the time entry.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TimeEventId":{
            "type":"integer",
            "description":"Unique identifier for the time event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalPoints":{
            "type":"number",
            "description":"Total number of points the worker is being granted as of the date of the attendance violation.",
            "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"
            }
        }
    }
}

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