Get all attendance violations
get
/hcmRestApi/resources/11.13.18.05/attendanceViolations
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all attendance violations based on the specified primary key criteria.
Finder Variables- AttendanceViolationId; integer; Unique identifier for the attendance violation.
- PrimaryKey Finds all attendance violations based on the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AbsenceId; integer; Unique identifier for the absence entry.
- AbsenceReportingTime; string; Date and time when the absence was reported.
- AcknowledgmentRequired; string; 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 for the attendance violation.
- AttendanceViolationId; integer; Unique identifier for the attendance violation.
- Comments; string; Comments associated with the acknowledgment or dismissal of the attendance violation.
- CreatedBy; string; Violations generated by the attendance rules process.
- CreationDate; string; Date when the attendance violation was generated.
- Department; string; Department criteria available to filter attendance violations.
- DepartmentId; integer; Identifier for the department used to filter attendance violations.
- EntryStartTime; string; Start time for the reported time entry with an attendance violation.
- EntryStopTime; string; Stop time for the reported time entry with an attendance violation.
- ExcusedBy; integer; Manager who dismissed the attendance violation.
- ExcusedTime; string; Date and time when the manager dismissed the attendance violation.
- IdentificationKey; integer; Identification key used to get the approval task details for the attendance violation.
- Job; string; Job criteria available to filter attendance violations.
- JobId; integer; Identifier for the job used to filter attendance violations.
- LastUpdateDate; string; Most recent date when the attendance violation was updated.
- LastUpdateLogin; string; Most recent user who updated the attendance violation.
- LastUpdatedBy; string; Most recent manager who updated the attendance violation.
- Location; string; Location criteria available to filter attendance violations.
- LocationId; integer; Identifier for the location used to filter attendance violations.
- LoggedInUserId; integer; Identifier for the user who's logged in.
- ObjectVersionNumber; integer; Version for the attendance violation.
- PersonId; integer; Unique identifier for the person associated with the attendance violation.
- PersonName; string; Name of the person associated with the attendance violation.
- PersonNumber; string; Number for the person associated with the attendance violation.
- Points; number; Points related to the attendance violation.
- RuleId; integer; Unique identifier for the attendance rule.
- RuleSetId; integer; Unique identifier for the attendance rule set.
- RuleType; string; Rule associated with the attendance violation, such as Tardy or Leave early.
- RuleTypeName; string; Name for the rule associated to the attendance violation, such as Tardy or Leave early.
- ShiftId; integer; Unique identifier for the schedule shift.
- ShiftStartTime; string; Start time for the schedule shift.
- ShiftStopTime; string; Stop time for the schedule shift.
- Status; string; Status for the attendance violation, such as not reviewed or dismissed.
- StatusCode; string; Code for the status of the attendance violation, such as ACKNOWLEDGED or DISMISSED.
- StatusMeaning; string; Status of the attendance violation, such as Acknowledged or Dismissed.
- ThresholdPeriodStartDate; string; Start date for the period when attendance violations are counted.
- ThresholdPeriodStopDate; string; End date for the period when attendance violations are counted.
- ThresholdViolatedFlag; boolean; Indicates whether the violation exceeds the number of allowed occurrences. Valid values are true and false. The default value is false.
- TimeEntryId; integer; Unique identifier for the time entry.
- TimeEntryVersion; integer; Version for the time entry.
- TimeEventId; integer; Unique identifier for the time event.
- TotalPoints; number; Total number of points the worker is being granted as of the date of the attendance violation.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : attendanceViolations
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : attendanceViolations-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- findByAdvancedSearchQuery
-
Finds the attendance violations that match the advanced search query.
- processViolationsByActionWithComment
-
Operation: /hcmRestApi/resources/11.13.18.05/attendanceViolations/action/processViolationsByActionWithCommentAcknowledges or dismisses attendance violations.