Jump to

• Request
• Response

Get all availability patterns

get

/hcmRestApi/resources/11.13.18.05/availabilityPatterns

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 availability patterns that match the specified primary key criteria.
    Finder Variables
    • AssignmentAvailabilityId; integer; Unique identifier of the availability pattern.
  • findByAssignmentId Finds all availability patterns that match the specified assignment identifier.
    Finder Variables
    • AssignmentId; integer; Unique identifier of the assignment of an employee.
  • findByDateRange Finds all availability patterns based on the specified date range and returns any exception shifts with exception dates that fall within the date range.
    Finder Variables
    • DateFrom; string; Start of date range of the availability pattern.
    • DateTo; string; End of date range of the availability pattern.
  • findByPersonId Finds all availability patterns that match the specified person identifier.
    Finder Variables
    • PersonId; integer; Unique identifier of the employee.
  • findByPersonIdTypeIdEffectiveDate Finds all availability patterns that match the specified criteria.
    Finder Variables
    • AvailabilityTypeId; integer; Unique identifier of the availability type.
    • EffectiveDate; string; Date that the availability pattern must be active on.
    • PersonId; integer; Unique identifier of the employee.
  • getByAvailabilityId Finds all availability patterns that match the specified unique identifier.
    Finder Variables
    • AssignmentAvailabilityId; integer; Unique identifier of the availability pattern.
• 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:
  

  • AnchorDate; string; Any date belonging to a week which follows Week 1 of the multiweek cycle.
  • AssignmentAvailabilityId; integer; Unique identifier of the availability pattern.
  • AssignmentId; integer; Unique identifier of the assignment of an employee.
  • AssignmentNumber; string; Assignment number of the employee.
  • AvailabilityType; string; Name of the availability type, such as CA-Nurse-Contracted or UK Retail Overtime.
  • AvailabilityTypeId; integer; Unique identifier of the availability type.
  • CreatedBy; string; Name of the user who created the pattern.
  • CreationDate; string; Date when the pattern was created.
  • DateFrom; string; Date from which the availability pattern is valid.
  • DateTo; string; Date to which the availability pattern is valid.
  • LastUpdateDate; string; Date when the pattern was last updated.
  • LastUpdateLogin; string; Unique identifier of the last update login.
  • LastUpdatedBy; string; Name of the user who last updated the pattern.
  • ObjectVersionNumber; integer; Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • PaidBreakDuration; string; Computed total paid break duration of all shifts in the pattern, in hours, for example, 0.5.
  • PaidDuration; string; Computed total paid duration of all shifts in the pattern, in hours, for example, 8.5.
  • PersonId; integer; Unique identifier of the employee.
  • PersonNumber; string; Unique numeric identifier of the employee.
  • RepeatNumber; integer; Length of the period for which the pattern is repeated, for example, 1 or 2.
  • RepeatPeriod; string; Unit of measure for the repeating period length, for example ORA_HTS_WEEKS for Weeks.
  • ScheduledDuration; string; Computed total scheduled duration of all shifts in the pattern, in hours, for example, 8.5.
  • ShiftCount; integer; Total count of the shifts in the pattern.
  • UnpaidBreakDuration; string; Computed total unpaid break duration of all shifts in the pattern, in hours, for example, 1.5.
• 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 : availabilityPatterns

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/availabilityPatterns-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object availabilityPatterns-item-response

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

Type: object

Show Source

• AnchorDate: string (date)
  Any date belonging to a week which follows Week 1 of the multiweek cycle.
• AssignmentAvailabilityId: integer (int64)
  Unique identifier of the availability pattern.
• AssignmentId: integer (int64)
  Unique identifier of the assignment of an employee.
• AssignmentNumber: string
  Assignment number of the employee.
• AvailabilityType: string
  Name of the availability type, such as CA-Nurse-Contracted or UK Retail Overtime.
• AvailabilityTypeId: integer (int64)
  Unique identifier of the availability type.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the pattern.
• CreationDate: string (date-time)
  Read Only: true

  Date when the pattern was created.
• DateFrom: string (date)
  Date from which the availability pattern is valid.
• DateTo: string (date)
  Date to which the availability pattern is valid.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the pattern was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the pattern.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Unique identifier of the last update login.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PaidBreakDuration: string
  Maximum Length: 255

  Computed total paid break duration of all shifts in the pattern, in hours, for example, 0.5.
• PaidDuration: string
  Maximum Length: 255

  Computed total paid duration of all shifts in the pattern, in hours, for example, 8.5.
• PersonId: integer (int64)
  Unique identifier of the employee.
• PersonNumber: string
  Unique numeric identifier of the employee.
• RepeatNumber: integer (int64)
  Length of the period for which the pattern is repeated, for example, 1 or 2.
• RepeatPeriod: string
  Maximum Length: 32

  Default Value: ORA_HTS_WEEKS

  Unit of measure for the repeating period length, for example ORA_HTS_WEEKS for Weeks.
• ScheduledDuration: string
  Maximum Length: 255

  Computed total scheduled duration of all shifts in the pattern, in hours, for example, 8.5.
• ShiftCount: integer
  Total count of the shifts in the pattern.
• shifts: array Shifts
  Title: Shifts

  The shifts resource is a child of the availabilityPatterns resource. It includes a list of all of the shifts that constitute the availability pattern.
• UnpaidBreakDuration: string
  Maximum Length: 255

  Computed total unpaid break duration of all shifts in the pattern, in hours, for example, 1.5.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the pattern was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaidBreakDuration":{
            "maxLength":255,
            "type":"string",
            "description":"Computed total paid break duration of all shifts in the pattern, in hours, for example, 0.5.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatNumber":{
            "type":"integer",
            "description":"Length of the period for which the pattern is repeated, for example, 1 or 2.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaidDuration":{
            "maxLength":255,
            "type":"string",
            "description":"Computed total paid duration of all shifts in the pattern, in hours, for example, 8.5.",
            "nullable":true,
            "x-queryable":true
        },
        "ShiftCount":{
            "type":"integer",
            "description":"Total count of the shifts in the pattern.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledDuration":{
            "maxLength":255,
            "type":"string",
            "description":"Computed total scheduled duration of all shifts in the pattern, in hours, for example, 8.5.",
            "nullable":true,
            "x-queryable":true
        },
        "UnpaidBreakDuration":{
            "maxLength":255,
            "type":"string",
            "description":"Computed total unpaid break duration of all shifts in the pattern, in hours, for example, 1.5.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentAvailabilityId":{
            "type":"integer",
            "description":"Unique identifier of the availability pattern.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the assignment of an employee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "type":"string",
            "description":"Assignment number of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnchorDate":{
            "type":"string",
            "description":"Any date belonging to a week which follows Week 1 of the multiweek cycle.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "shifts":{
            "title":"Shifts",
            "type":"array",
            "description":"The shifts resource is a child of the availabilityPatterns resource. It includes a list of all of the shifts that constitute the availability pattern.",
            "items":{
                "$ref":"#/components/schemas/availabilityPatterns-shifts-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "type":"string",
            "description":"Unique numeric identifier of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the pattern.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailabilityTypeId":{
            "type":"integer",
            "description":"Unique identifier of the availability type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "RepeatPeriod":{
            "maxLength":32,
            "type":"string",
            "description":"Unit of measure for the repeating period length, for example ORA_HTS_WEEKS for Weeks.",
            "nullable":true,
            "default":"ORA_HTS_WEEKS",
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the employee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "DateFrom":{
            "type":"string",
            "description":"Date from which the availability pattern is valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AvailabilityType":{
            "type":"string",
            "description":"Name of the availability type, such as CA-Nurse-Contracted or UK Retail Overtime.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the pattern was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the last update login.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateTo":{
            "type":"string",
            "description":"Date to which the availability pattern is valid.",
            "format":"date",
            "nullable":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 : Shifts

Type: array

Title: Shifts

The shifts resource is a child of the availabilityPatterns resource. It includes a list of all of the shifts that constitute the availability pattern.

Show Source

• Array of: object availabilityPatterns-shifts-item-response

{
    "title":"Shifts",
    "type":"array",
    "description":"The shifts resource is a child of the availabilityPatterns resource. It includes a list of all of the shifts that constitute the availability pattern.",
    "items":{
        "$ref":"#/components/schemas/availabilityPatterns-shifts-item-response"
    }
}

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."
        }
    }
}

Nested Schema : availabilityPatterns-shifts-item-response

Type: object

Show Source

• AssignmentAvailabilityId: integer (int64)
  Unique identifier of the availability pattern.
• AvailabilityDetailId: integer (int64)
  Unique identifier of the shift in an availability pattern.
• breaks: array Breaks
  Title: Breaks

  The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the shift.
• CreationDate: string (date-time)
  Read Only: true

  Date when the shift was created.
• DayOfWeek: string
  Number specifying the day of the week, or day of the cycle for multiweek patterns. For example, 1 for Sunday, 2 for Monday, 8 for the Monday of the second week, 14 for the Saturday for the second week.
• Duration: string
  Duration of the shift in hours. Value must be between 0 and 24. For example, 8.
• EndTime: string
  Time when a shift ends, entered in HH24:MI format. For example, 21:00.
• ExceptionDate: string (date)
  Date when an exception applies.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the shift was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the shift.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Unique identifier of the last update login.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NonWorkExceptionFlag: boolean
  Maximum Length: 255

  Default Value: false

  Indicates weather the flag for the exception shift represents a nonworking day. Possible values are true and false.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PatternException: string
  Maximum Length: 255

  Type differentiating a pattern from an exception. Possible values are PATTERN and EXCEPTION.
• StartTime: string
  Time when a shift starts, entered in HH24:MI format. For example, 14:00.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the shift.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the shift was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DayOfWeek":{
            "type":"string",
            "description":"Number specifying the day of the week, or day of the cycle for multiweek patterns. For example, 1 for Sunday, 2 for Monday, 8 for the Monday of the second week, 14 for the Saturday for the second week.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the shift.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailabilityDetailId":{
            "type":"integer",
            "description":"Unique identifier of the shift in an availability pattern.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"Time when a shift ends, entered in HH24:MI format. For example, 21:00.",
            "nullable":true,
            "x-queryable":true
        },
        "breaks":{
            "title":"Breaks",
            "type":"array",
            "description":"The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift.",
            "items":{
                "$ref":"#/components/schemas/availabilityPatterns-shifts-breaks-item-response"
            }
        },
        "StartTime":{
            "type":"string",
            "description":"Time when a shift starts, entered in HH24:MI format. For example, 14:00.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternException":{
            "maxLength":255,
            "type":"string",
            "description":"Type differentiating a pattern from an exception. Possible values are PATTERN and EXCEPTION.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Duration":{
            "type":"string",
            "description":"Duration of the shift in hours. Value must be between 0 and 24. For example, 8.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentAvailabilityId":{
            "type":"integer",
            "description":"Unique identifier of the availability pattern.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExceptionDate":{
            "type":"string",
            "description":"Date when an exception applies.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the shift was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the last update login.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NonWorkExceptionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates weather the flag for the exception shift represents a nonworking day. Possible values are true and false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Breaks

Type: array

Title: Breaks

The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift.

Show Source

• Array of: object availabilityPatterns-shifts-breaks-item-response

{
    "title":"Breaks",
    "type":"array",
    "description":"The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift.",
    "items":{
        "$ref":"#/components/schemas/availabilityPatterns-shifts-breaks-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 : availabilityPatterns-shifts-breaks-item-response

Type: object

Show Source

• AssignmentAvailabilityId: integer (int64)
  Unique identifier of the availability pattern.
• AvailabilityDetailId: integer (int64)
  Unique identifier of the break belonging to a shift in an availability pattern.
• BreakId: integer (int64)
  Unique identifier of the break.
• BreakName: string
  Maximum Length: 240

  Name of the break, as identified in availability type setup, for example, Lunch or Tea.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the break.
• CreationDate: string (date-time)
  Read Only: true

  Date when the break was created.
• Duration: string
  Duration of the break in minutes, for example, 15 or 30.
• EndTime: string
  Time when a break ends, entered in HH24:MI format, for example, 14:30.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the break was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the break.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Unique identifier of the last update login.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• StartTime: string
  Time when a break starts, entered in HH24:MI format, for example, 14:30.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the break was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailabilityDetailId":{
            "type":"integer",
            "description":"Unique identifier of the break belonging to a shift in an availability pattern.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndTime":{
            "type":"string",
            "description":"Time when a break ends, entered in HH24:MI format, for example, 14:30.",
            "nullable":true,
            "x-queryable":true
        },
        "BreakName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the break, as identified in availability type setup, for example, Lunch or Tea.",
            "nullable":true,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Time when a break starts, entered in HH24:MI format, for example, 14:30.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"string",
            "description":"Duration of the break in minutes, for example, 15 or 30.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentAvailabilityId":{
            "type":"integer",
            "description":"Unique identifier of the availability pattern.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BreakId":{
            "type":"integer",
            "description":"Unique identifier of the break.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the break was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the last update login.",
            "nullable":false,
            "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"
    }
}

Back to Top