Jump to

• Request
• Response

Get all absence types for a worker

get

/hcmRestApi/resources/11.13.18.05/absenceTypesLOV

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 the absence types that match the specified primary key criteria..
    Finder Variables
    • CompositeKey; string; Unique combination identifier for the numeric identifier of the person and the person's work relationship, separated by an underscore.
  • findByWord Finds all the absence types that match the specified criteria. You need to specify the personId to get a result.
    Finder Variables
    • AbsenceTypeEffectiveDate; string; Effective date of the absence type. It defaults to current date.
    • FilterAttributes; string; Space separated list of fields to query on.
    • PersonId; integer; Unique numeric identifier for the person. You must specify this to get results.
    • SearchTerms; string; Search phrase to query with. It can be a single word or multiple words separated by space.
  • findDefaultAbsenceType Finds all the default absence types defined by the configuration option.
    Finder Variables
    • AbsenceTypeEffectiveDate; string; Effective date of the absence type. It defaults to current date.
    • LEFlag; string; Legal employer of the absence type.
    • PersonId; integer; Unique numeric identifier for the person.
• 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:
  

  • AbsTypeWithEmployerName; string; Name of the absence type, if the employee has a single work relationship. For employees with multiple work relationships, it's name of the absence type and legal name of the employer, separated with a hyphen. For example: Vacation - Vision Corporation.
  • AbsenceTypeId; integer; Unique numeric identifier of the absence type.
  • AbsenceTypeName; string; Name of the absence type, such as Vacation.
  • BiddingFlag; boolean; Indicates whether bidding is enabled for the absence type. Valid values are Y and N. The default value is null.
  • CompositeKey; string; Unique combination identifier for the numeric identifier of the person and the person's work relationship that are separated by an underscore.
  • Description; string; Description of the absence type.
  • DisplaySequence; integer; Absence type display order for absence and bid entry.
  • EmployerId; integer; Unique numeric identifier of the employer.
  • EmployerName; string; Legal name of the employer, such as Vision Corporation.
  • LegislationCode; string; Legislation code of the legislative data group for the absence type.
• 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:
  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.

There's no request body for this operation.

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 : absenceTypesLOV

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/absenceTypesLOV-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object absenceTypesLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/absenceTypesLOV-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 : absenceTypesLOV-item-response

Type: object

Show Source

• AbsenceTypeAgreement: string
  Read Only: true

  Maximum Length: 255

  Name of the agreement.
• AbsenceTypeBasicAssignmentFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates basic assignment of the absence type. Valid values are Y and N. The default value is null.
• AbsenceTypeId: integer
  Read Only: true

  Unique numeric identifier of the absence type.
• AbsenceTypeMapEventTypeCd: string
  Read Only: true

  Maximum Length: 255

  Event type of the absence type.
• AbsenceTypeName: string
  Read Only: true

  Maximum Length: 240

  Name of the absence type, such as Vacation.
• AbsenceTypePartialDay: string
  Read Only: true

  Maximum Length: 255

  Partial day of absence type.
• AbsenceTypePatternCode: string
  Read Only: true

  Maximum Length: 255

  Pattern code of the absence type.
• AbsTypeWithEmployerName: string
  Read Only: true

  Maximum Length: 483

  Name of the absence type, if the employee has a single work relationship. For employees with multiple work relationships, it's name of the absence type and legal name of the employer, separated with a hyphen. For example: Vacation - Vision Corporation.
• AttachmentDurationFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the attachment duration exceeds a specific period. Valid values are Y and N. The default value is null.
• AttachmentDurationPeriod: number
  Read Only: true

  Duration period of the absence type.
• AttachmentEmployeeFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the Employee option for the Attachments rule on the absence type is selected. Valid values are Y and N. The default value is null.
• AttachmentManagerFlag: boolean
  Read Only: true

  Maximum Length: 255

  Manager option for the Attachments rule on the absence type. Valid values are Y and N. The default value is null.
• AttachmentType: string
  Read Only: true

  Maximum Length: 255

  Absence type configured with attachment.
• BiddingFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether bidding is enabled for the absence type. Valid values are Y and N. The default value is null.
• CompositeKey: string
  Read Only: true

  Maximum Length: 37

  Unique combination identifier for the numeric identifier of the person and the person's work relationship that are separated by an underscore.
• Description: string
  Read Only: true

  Maximum Length: 2000

  Description of the absence type.
• DisplaySequence: integer (int64)
  Read Only: true

  Absence type display order for absence and bid entry.
• DurationUOMCode: string
  Read Only: true

  Maximum Length: 255

  Unit of measure for absence duration.
• DurationUOMCodeMeaning: string
  Read Only: true

  Maximum Length: 255

  Description of the unit of measure (UOM) for absence duration.
• EmployeeAllowUpdatesFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether an employee can update the absence record.
• EmployeeLockIfConfirmFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the Lock if completed for employee option for the absence type is selected. Valid values are Y and N. The default value is N.
• EmployerId: integer (int64)
  Read Only: true

  Unique numeric identifier of the employer.
• EmployerName: string
  Read Only: true

  Maximum Length: 240

  Legal name of the employer, such as Vision Corporation.
• LegislationCode: string
  Read Only: true

  Maximum Length: 30

  Legislation code of the legislative data group for the absence type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerAllowUpdatesFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether a manager can update the absence record.
• ManagerLockIfConfirmFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether absence record is locked if completed for manager. Valid values are Y and N. The default value is N.
• MaximumDuration: number
  Read Only: true

  Maximum duration value of the absence type.
• MaximumDurationRuleCode: string
  Read Only: true

  Maximum Length: 255

  Maximum duration rule code of the absence type.
• MinimumDuration: number
  Read Only: true

  Minimum duration value of the absence type.
• MinimumDurationRuleCode: string
  Read Only: true

  Maximum Length: 255

  Minimum duration rule code of the absence type.
• PreventMultipleAssignmentFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether multiple assignments are allowed for this absence type. Valid values are Y and N. The default value is null.
• SpecialCondition: string
  Read Only: true

  Maximum Length: 255

  Special conditions entered for the absence request.

{
    "type":"object",
    "properties":{
        "EmployerId":{
            "type":"integer",
            "description":"Unique numeric identifier of the employer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AbsenceTypePartialDay":{
            "maxLength":255,
            "type":"string",
            "description":"Partial day of absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code of the legislative data group for the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AbsenceTypeMapEventTypeCd":{
            "maxLength":255,
            "type":"string",
            "description":"Event type of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Absence type display order for absence and bid entry.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManagerAllowUpdatesFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether a manager can update the absence record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PreventMultipleAssignmentFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether multiple assignments are allowed for this absence type. Valid values are Y and N. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BiddingFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether bidding is enabled for the absence type. Valid values are Y and N. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeAllowUpdatesFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether an employee can update the absence record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CompositeKey":{
            "maxLength":37,
            "type":"string",
            "description":"Unique combination identifier for the numeric identifier of the person and the person's work relationship that are separated by an underscore.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SpecialCondition":{
            "maxLength":255,
            "type":"string",
            "description":"Special conditions entered for the absence request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DurationUOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for absence duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DurationUOMCodeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the unit of measure (UOM) for absence duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttachmentDurationFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the attachment duration exceeds a specific period. Valid values are Y and N. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AbsTypeWithEmployerName":{
            "maxLength":483,
            "type":"string",
            "description":"Name of the absence type, if the employee has a single work relationship. For employees with multiple work relationships, it's name of the absence type and legal name of the employer, separated with a hyphen. For example: Vacation - Vision Corporation.",
            "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"
            }
        },
        "MaximumDurationRuleCode":{
            "maxLength":255,
            "type":"string",
            "description":"Maximum duration rule code of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AbsenceTypePatternCode":{
            "maxLength":255,
            "type":"string",
            "description":"Pattern code of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AbsenceTypeName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the absence type, such as Vacation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentType":{
            "maxLength":255,
            "type":"string",
            "description":"Absence type configured with attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AbsenceTypeBasicAssignmentFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates basic assignment of the absence type. Valid values are Y and N. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttachmentDurationPeriod":{
            "type":"number",
            "description":"Duration period of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AbsenceTypeAgreement":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttachmentEmployeeFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the Employee option for the Attachments rule on the absence type is selected. Valid values are Y and N. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MinimumDuration":{
            "type":"number",
            "description":"Minimum duration value of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MinimumDurationRuleCode":{
            "maxLength":255,
            "type":"string",
            "description":"Minimum duration rule code of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AbsenceTypeId":{
            "type":"integer",
            "description":"Unique numeric identifier of the absence type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerLockIfConfirmFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether absence record is locked if completed for manager. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MaximumDuration":{
            "type":"number",
            "description":"Maximum duration value of the absence type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttachmentManagerFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Manager option for the Attachments rule on the absence type. Valid values are Y and N. The default value is null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmployeeLockIfConfirmFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the Lock if completed for employee option for the absence type is selected. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmployerName":{
            "maxLength":240,
            "type":"string",
            "description":"Legal name of the employer, such as Vision Corporation.",
            "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"
    }
}

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