Create Shift

post https://{hostname}/api/v1/scheduling/schedule/shifts

This operation creates a shift according to the parameters provided.

Body Params

postedNotified

boolean

A Boolean indicator of whether or not the employee has been notified of the posted shift.

locked

boolean

A Boolean indicator of whether or not the shift is locked.

shiftGroup

object

The object reference model which contains an ID and qualifier.

modifiedDateTime

string

The version of the shift in date-time format.

deleted

boolean

A Boolean indicator of whether or not the shift is deleted.

postedNotificationPending

boolean

A Boolean indicator of whether or not the notification to the employee of the posted shift is pending.

segments

array of objects

The list of segments of this shift ordered by start date and time.

segments

endDateTime

string

The inclusive end date and time of the shift in ISO_LOCAL_DATE format (YYYY-MM-DD).

generated

boolean

A Boolean indicator of whether or not the shift was generated by the Scheduling engine.

relations

array of objects

The list of relations of the shift.

relations

label

string

The label of this shift.

commentNotes

array of objects

The list of IDs of commentNote objects attached to this shift.

commentNotes

version

int64

The version of this shift.

startDateTime

string

The inclusive start date and time of the shift in ISO_LOCAL_DATE format (YYYY-MM-DD).

position

object

The object reference model which contains an ID and qualifier.

employee

object

The object reference model which contains an ID and qualifier.

onCall

boolean

open

boolean

A Boolean indicator of whether or not the shift is open.

int64

The ID of the shift.

selfServiced

boolean

A Boolean indicator of whether or not a shift is self-service. This property is read only.

posted

boolean

A Boolean indicator of whether or not the shift is posted.

Headers

scratchpad-id

string

The ID of the current business interaction.

Responses

Response body

array of objects

object

postedNotified

boolean

A Boolean indicator of whether or not the employee has been notified of the posted shift.

locked

boolean

A Boolean indicator of whether or not the shift is locked.

shiftGroup

object

The object reference model which contains an ID and qualifier.

modifiedDateTime

string

The version of the shift in date-time format.

deleted

boolean

A Boolean indicator of whether or not the shift is deleted.

postedNotificationPending

boolean

A Boolean indicator of whether or not the notification to the employee of the posted shift is pending.

segments

array of objects

The list of segments of this shift ordered by start date and time.

segments

object

endDateTime

string

The inclusive end date and time of the shift segment in ISO_LOCAL_DATE format (YYYY-MM-DD).

segmentTypeRef

object

The object reference model which contains an ID and qualifier.

workruleRef

object

The object reference model which contains an ID and qualifier.

transferString

string

An ordered, semi-colon separated list of Labor Category Entries and Cost Center.

coverageSpans

array of objects

coverageSpans

object

contributingHours

double

workloadSpan

object

A workload span.

spanDate

date

uniqueId

string

SchedulingShiftCoverageSpansId

string

userEnteredLaborCategories

object

Contains the reference to the labor category entries of a timekeeping labor account.

orgJobRef

object

The object reference model which contains an ID and qualifier.

int64

The ID for the shift segment.

transferLaborCategories

boolean

A Boolean indicator of whether or not a the labor category is a transfer.

transferWorkrule

boolean

A Boolean indicator of whether or not the work rule is a transfer.

userEnteredCostCenter

boolean

A Boolean indicator of whether or not a cost center was entered by the user for this shift segment.

primaryWorkruleRef

object

The object reference model which contains an ID and qualifier.

primaryLaborCategories

object

Contains the reference to the labor category entries of a timekeeping labor account.

costCenter

object

Contains the reference to the cost center of a timekeeping labor account.

orgJobProperties

object

Has additional fields

userEnteredOrgJob

boolean

A Boolean indicator of whether or not a business structure job for this shift segment was entered by the user.

transferOrgJob

boolean

A Boolean indicator of whether or not the business structure job is a transfer.

skillCertProfileRefs

array of objects

A list of references to the skill certifications required for this shift segment.

skillCertProfileRefs

object

int64

The unique ID of an object.

qualifier

string

The qualifier of an object.

localizedQualifier

string

The localized qualifier of an object reference. The value of this property is imported from the Setup Data component by means of an XLS file.

transferCostCenter

boolean

A Boolean indicator of whether or not there is a transfer cost center for this shift segment.

shiftSegmentDetailTypeId

object

The object reference model which contains an ID and qualifier.

SchedulingShiftSegmentId

string

primaryOrgJobRef

object

The object reference model which contains an ID and qualifier.

userEnteredWorkrule

boolean

A Boolean indicator of whether or not a work rule for this shift segment was entered by the user.

laborCategories

object

Contains the reference to the labor category entries of a timekeeping labor account.

startDateTime

string

The inclusive start date and time of the shift segment in ISO_LOCAL_DATE format (YYYY-MM-DD).

primaryCostCenter

object

Contains the reference to the cost center of a timekeeping labor account.

segmentTags

array of objects

A collection of the segment tags of this shift segment.

segmentTags

object

color

string

The color of this shift segment tag.

tagDefinitionRef

object

The object reference model which contains an ID and qualifier.

shiftSegmentTagIconClass

string

The tag icon class of this shift segment tag.

int64

The ID for the shift segment tag.

ScheduleShiftSegmentTagId

string

endDateTime

string

The inclusive end date and time of the shift in ISO_LOCAL_DATE format (YYYY-MM-DD).

generated

boolean

A Boolean indicator of whether or not the shift was generated by the Scheduling engine.

relations

array of objects

The list of relations of the shift.

relations

object

from

object

The object reference model which contains an ID and qualifier.

type

string

The shift source type, such as pattern or schedule group.

FROM_GROUPITEM_TO_ITEM FROM_PCE_TO_ORIGINAL_SHIFT FROM_PCE_TO_CURRENT_SHIFT FROM_PATTERNITEM_TO_ITEM FROM_SHIFTTEMPLATE_TO_SHIFT FROM_SCHEDULE_ITEM_TO_CALENDAR_DATE FROM_SCHEDULE_ITEM_TO_EXTERNAL_ID FROM_SHIFT_TO_SELF_SCHEDULE_REQUEST FROM_SHIFT_TO_OPEN_SHIFT_REQUEST FROM_SHIFT_TO_PREDICTIVE_SCHEDULING_TAG FROM_SHIFT_TO_COVER_REQUEST_INITIATOR FROM_SHIFT_TO_COVER_REQUEST_RECIPIENT FROM_SHIFT_TO_SWAP_SHIFT_REQUEST FROM_PARTIAL_SHIFT_TO_ORIGINAL_SHIFT FROM_OSR_PARTIAL_SHIFT_TO_ORIGINAL_SHIFT FROM_COVER_PARTIAL_SHIFT_TO_ORIGINAL_SHIFT FROM_ITEM_TO_ANCESTOR_SHIFT FROM_SHIFT_TO_INCENTIVE FROM_SHIFT_TO_INCENTIVE_PCE FROM_SHIFT_TO_SHIFT_GROUP

relationType

string

Entity relation type.

targetRef

object

The object reference model which contains an ID and qualifier.

SchedulingEntityRelationId

string

active

boolean

Boolean flag indicating that the relation to the shift's source is active.

targetVersion

int64

The version of the source pay code edit.

label

string

The label of this shift.

commentNotes

array of objects

The list of IDs of commentNote objects attached to this shift.

commentNotes

object

comment

object

Entity containing necessary data to fetch and update Comment transactions.

notes

array of objects

A list of notes that are attached to a comment.

notes

object

SchedulingNoteId

string

text

string

The text of the note.

commentNoteId

int64

The ID for the note.

timestamp

string

The date and time when the note was created or modified; in ISO_LOCAL_DATE format (YYYY-MM-DD).

string

The ID of a note, which consists of the identifier of a comment and the timestamp of a note. For example: 1982020-09-21T08:01:32

dataSourceDisplayName

string

The name of the person who entered the note.

SchedulingCommentNoteId

string

int64

The ID for the comment and attached notes.

version

int64

The version of this shift.

startDateTime

string

The inclusive start date and time of the shift in ISO_LOCAL_DATE format (YYYY-MM-DD).

position

object

The object reference model which contains an ID and qualifier.

employee

object

The object reference model which contains an ID and qualifier.

onCall

boolean

open

boolean

A Boolean indicator of whether or not the shift is open.

int64

The ID of the shift.

selfServiced

boolean

A Boolean indicator of whether or not a shift is self-service. This property is read only.

posted

boolean

A Boolean indicator of whether or not the shift is posted.

400

Shift creation unsuccessful.

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/api/v1/scheduling/schedule/shifts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200Successful creation of a shift.