Jump to

• Request
• Response

Update a single workforce schedule

patch

/hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}

Request

Path Parameters

• ScheduleId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Comments: string
  Maximum Length: 4000

  Schedule notes.
• DeleteOpenShiftsFlag: boolean
  Maximum Length: 80

  Option on the publish drawer to delete all open shifts in the period.
• Discriminator: integer
  Determines the source of populated information, only for internal use.
• EndDate: string (date)
  End date for the workforce schedule period.
• ObjectVersionNumber: integer (int32)
  Object version number.
• OpenDate: string (date)
  Open date for the workforce schedule generation period.
• PublishDueDate: string (date)
  Publish due date for the workforce schedule.
• PublishedBy: integer
  Person who published the workforce schedule.
• PublishedDate: string (date)
  Date when the workforce schedule was published.
• SchedGenProfileId: integer
  Foreign key reference to the schedule generation profile.
• ScheduleUnitId: integer
  Foreign key reference to the workforce schedule department.
• ScheduleUpdateDate: string (date-time)
  Date when the workforce schedule was updated.
• SelfScheduleCloseDate: string (date)
  Date when the self-scheduling window closes.
• SelfScheduleOpenDate: string (date)
  Date when the self-scheduling window opens.
• StartDate: string (date)
  Start date for the workforce schedule.
• StatusCode: string
  Maximum Length: 30

  Status code for the workforce schedules.
• workerShifts: array Schedule Shifts Migration
  Title: Schedule Shifts Migration

  The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.
• WorkloadUpdateDate: string (date-time)
  Date when the workload was updated.

{
    "type":"object",
    "properties":{
        "SelfScheduleOpenDate":{
            "type":"string",
            "description":"Date when the self-scheduling window opens.",
            "format":"date",
            "nullable":true
        },
        "ScheduleUnitId":{
            "type":"integer",
            "description":"Foreign key reference to the workforce schedule department.",
            "nullable":false
        },
        "OpenDate":{
            "type":"string",
            "description":"Open date for the workforce schedule generation period.",
            "format":"date",
            "nullable":true
        },
        "ScheduleUpdateDate":{
            "type":"string",
            "description":"Date when the workforce schedule was updated.",
            "format":"date-time",
            "nullable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Schedule notes.",
            "nullable":true
        },
        "SchedGenProfileId":{
            "type":"integer",
            "description":"Foreign key reference to the schedule generation profile.",
            "nullable":false
        },
        "PublishedBy":{
            "type":"integer",
            "description":"Person who published the workforce schedule.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the workforce schedule period.",
            "format":"date",
            "nullable":false
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code for the workforce schedules.",
            "nullable":true
        },
        "SelfScheduleCloseDate":{
            "type":"string",
            "description":"Date when the self-scheduling window closes.",
            "format":"date",
            "nullable":true
        },
        "Discriminator":{
            "type":"integer",
            "description":"Determines the source of populated information, only for internal use.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the workforce schedule.",
            "format":"date",
            "nullable":false
        },
        "PublishDueDate":{
            "type":"string",
            "description":"Publish due date for the workforce schedule.",
            "format":"date",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "DeleteOpenShiftsFlag":{
            "maxLength":80,
            "type":"boolean",
            "description":"Option on the publish drawer to delete all open shifts in the period.",
            "nullable":true,
            "x-queryable":false
        },
        "workerShifts":{
            "title":"Schedule Shifts Migration",
            "type":"array",
            "description":"The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.",
            "items":{
                "$ref":"#/components/schemas/workforceSchedules-workerShifts-item-patch-request"
            }
        },
        "PublishedDate":{
            "type":"string",
            "description":"Date when the workforce schedule was published.",
            "format":"date",
            "nullable":true
        },
        "WorkloadUpdateDate":{
            "type":"string",
            "description":"Date when the workload was updated.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : Schedule Shifts Migration

Type: array

Title: Schedule Shifts Migration

The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.

Show Source

• Array of: object workforceSchedules-workerShifts-item-patch-request

{
    "title":"Schedule Shifts Migration",
    "type":"array",
    "description":"The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.",
    "items":{
        "$ref":"#/components/schemas/workforceSchedules-workerShifts-item-patch-request"
    }
}

Nested Schema : workforceSchedules-workerShifts-item-patch-request

Type: object

Show Source

• AssignedBy: integer (int64)
  Person who assigned the open shift.
• AssignmentDate: string (date-time)
  Date when the open shift was assigned.
• AssignmentId: integer (int64)
  Default Value: -1

  Assignment identifier for the worker scheduled for the shift.
• AssignmentMode: string
  Title: Assignment Source

  Maximum Length: 30

  Method used to assign the shift to the worker.
• BreakDuration: integer (int32)
  Title: Break Duration

  Break duration in minutes.
• Comments: string
  Title: What else do people need to know about this shift?

  Maximum Length: 4000

  Shift notes.
• CompetencyId: integer
  Unique identifier for the competency.
• DeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the workforce schedule shift needs to be deleted.
• EndDateTime: string (date-time)
  Shift end date and time.
• EndTimeTZOffset: integer (int32)
  End time for the workforce schedule shift with time zone offset, for example, -360.
• JobProfileCode: string
  Maximum Length: 30

  Unique identifier for the job profile code.
• JobProfileId: integer
  Unique identifier for the job profile.
• JobProfileType: string
  Maximum Length: 80

  Type for the job profile.
• LockedFlag: boolean
  Maximum Length: 1

  Indicates whether a workforce schedule shift is locked for modifications. Valid values are Y and N. The default value is N.
• ObjectVersionNumber: integer (int32)
  Object version number.
• PersonId: integer (int64)
  Default Value: -1

  Person identifier for the workforce schedule shift assignee.
• PremiumShiftCode: string
  Maximum Length: 30

  Premium shift code for the scheduled shift type.
• ReferenceDate: string (date)
  Earned date of the workforce schedule shift that spans midnight, or where the shift is part of a shift group with at least 1 shift on the previous or next day.
• ScheduleId: integer (int64)
  Unique identifier for the workforce schedule containing the shift.
• ScheduleUnitId: integer (int64)
  Unique identifier for the department of workforce schedule shift.
• ShiftCategory: string
  Title: Shift Category

  Maximum Length: 30

  Shift category.
• ShiftDate: string (date)
  Title: Date

  Date for the workforce schedule shift.
• ShiftId: integer (int64)
  Unique identifier for the enterprise shift.
• ShiftStartTime: string
  Maximum Length: 80

  Start time for the workforce schedule shift.
• ShiftType: string
  Title: Shift Type Code

  Maximum Length: 30

  Type for the scheduled shift, such as Regular or On-call.
• ShiftTypeId: integer (int64)
  Title: Shift Type

  Unique identifier for a workforce schedule shift type.
• SkillId: integer (int64)
  Unique identifier for the job the shift applies to.
• SkipValidationFlag: boolean
  Indicates whether the workforce schedule shift needs to be validated.
• Source: string
  Title: Source

  Maximum Length: 30

  Default Value: ORA_MANUAL

  Source for the workforce schedule shift, such as Manual entry or Automatically generated.
• StartDateTime: string (date-time)
  Start date and time for the schedule shift.
• StartTimeTZOffset: integer (int32)
  Start time for the workforce schedule shift with time zone offset, for example, -360.
• WorkDuration: integer (int32)
  Title: Work Duration

  Duration, in hours and minutes, for the workforce schedule shift.

{
    "type":"object",
    "properties":{
        "ScheduleUnitId":{
            "type":"integer",
            "description":"Unique identifier for the department of workforce schedule shift.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "JobProfileType":{
            "maxLength":80,
            "type":"string",
            "description":"Type for the job profile.",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftId":{
            "type":"integer",
            "description":"Unique identifier for the enterprise shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EndTimeTZOffset":{
            "type":"integer",
            "description":"End time for the workforce schedule shift with time zone offset, for example, -360.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "ShiftType":{
            "title":"Shift Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Type for the scheduled shift, such as Regular or On-call.",
            "nullable":true
        },
        "Source":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"Source for the workforce schedule shift, such as Manual entry or Automatically generated.",
            "nullable":true,
            "default":"ORA_MANUAL"
        },
        "WorkDuration":{
            "title":"Work Duration",
            "type":"integer",
            "description":"Duration, in hours and minutes, for the workforce schedule shift.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "AssignmentDate":{
            "type":"string",
            "description":"Date when the open shift was assigned.",
            "format":"date-time",
            "nullable":true
        },
        "EndDateTime":{
            "type":"string",
            "description":"Shift end date and time.",
            "format":"date-time",
            "nullable":true
        },
        "StartTimeTZOffset":{
            "type":"integer",
            "description":"Start time for the workforce schedule shift with time zone offset, for example, -360.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ShiftCategory":{
            "title":"Shift Category",
            "maxLength":30,
            "type":"string",
            "description":"Shift category.",
            "nullable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment identifier for the worker scheduled for the shift.",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "ShiftDate":{
            "title":"Date",
            "type":"string",
            "description":"Date for the workforce schedule shift.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SkillId":{
            "type":"integer",
            "description":"Unique identifier for the job the shift applies to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssignmentMode":{
            "title":"Assignment Source",
            "maxLength":30,
            "type":"string",
            "description":"Method used to assign the shift to the worker.",
            "nullable":true
        },
        "AssignedBy":{
            "type":"integer",
            "description":"Person who assigned the open shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShiftStartTime":{
            "maxLength":80,
            "type":"string",
            "description":"Start time for the workforce schedule shift.",
            "nullable":true,
            "x-queryable":false
        },
        "JobProfileId":{
            "type":"integer",
            "description":"Unique identifier for the job profile.",
            "nullable":true,
            "x-queryable":false
        },
        "CompetencyId":{
            "type":"integer",
            "description":"Unique identifier for the competency.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"What else do people need to know about this shift?",
            "maxLength":4000,
            "type":"string",
            "description":"Shift notes.",
            "nullable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule containing the shift.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the workforce schedule shift needs to be deleted.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "LockedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a workforce schedule shift is locked for modifications. Valid values are Y and N. The default value is N.",
            "nullable":true
        },
        "StartDateTime":{
            "type":"string",
            "description":"Start date and time for the schedule shift.",
            "format":"date-time",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier for the workforce schedule shift assignee.",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "SkipValidationFlag":{
            "type":"boolean",
            "description":"Indicates whether the workforce schedule shift needs to be validated.",
            "nullable":true,
            "x-queryable":false
        },
        "BreakDuration":{
            "title":"Break Duration",
            "type":"integer",
            "description":"Break duration in minutes.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "ShiftTypeId":{
            "title":"Shift Type",
            "type":"integer",
            "description":"Unique identifier for a workforce schedule shift type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReferenceDate":{
            "type":"string",
            "description":"Earned date of the workforce schedule shift that spans midnight, or where the shift is part of a shift group with at least 1 shift on the previous or next day.",
            "format":"date",
            "nullable":true
        },
        "PremiumShiftCode":{
            "maxLength":30,
            "type":"string",
            "description":"Premium shift code for the scheduled shift type.",
            "nullable":true
        },
        "JobProfileCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the job profile code.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• Comments: string
  Maximum Length: 4000

  Schedule notes.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Workforce schedule shift creator.
• CreationDate: string (date-time)
  Read Only: true

  Date when the workforce schedule shift was created.
• DeleteOpenShiftsFlag: boolean
  Maximum Length: 80

  Option on the publish drawer to delete all open shifts in the period.
• Discriminator: integer
  Determines the source of populated information, only for internal use.
• EndDate: string (date)
  End date for the workforce schedule period.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the workforce schedule shift was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who updated the workforce schedule.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  User name for the person who updated the workforce schedule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Object version number.
• OpenDate: string (date)
  Open date for the workforce schedule generation period.
• PublishDueDate: string (date)
  Publish due date for the workforce schedule.
• PublishedBy: integer
  Person who published the workforce schedule.
• PublishedDate: string (date)
  Date when the workforce schedule was published.
• SchedGenProfileId: integer
  Foreign key reference to the schedule generation profile.
• ScheduleId: integer
  Unique identifier for the workforce schedule containing the shift.
• ScheduleUnitId: integer
  Foreign key reference to the workforce schedule department.
• ScheduleUpdateDate: string (date-time)
  Date when the workforce schedule was updated.
• SelfScheduleCloseDate: string (date)
  Date when the self-scheduling window closes.
• SelfScheduleOpenDate: string (date)
  Date when the self-scheduling window opens.
• StartDate: string (date)
  Start date for the workforce schedule.
• StatusCode: string
  Maximum Length: 30

  Status code for the workforce schedules.
• workerShifts: array Schedule Shifts Migration
  Title: Schedule Shifts Migration

  The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.
• WorkloadUpdateDate: string (date-time)
  Date when the workload was updated.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the workforce schedule shift was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleUnitId":{
            "type":"integer",
            "description":"Foreign key reference to the workforce schedule department.",
            "nullable":false,
            "x-queryable":true
        },
        "OpenDate":{
            "type":"string",
            "description":"Open date for the workforce schedule generation period.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleUpdateDate":{
            "type":"string",
            "description":"Date when the workforce schedule was updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SchedGenProfileId":{
            "type":"integer",
            "description":"Foreign key reference to the schedule generation profile.",
            "nullable":false,
            "x-queryable":true
        },
        "PublishedBy":{
            "type":"integer",
            "description":"Person who published the workforce schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code for the workforce schedules.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the workforce schedule.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PublishDueDate":{
            "type":"string",
            "description":"Publish due date for the workforce schedule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "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"
            }
        },
        "WorkloadUpdateDate":{
            "type":"string",
            "description":"Date when the workload was updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who updated the workforce schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Workforce schedule shift creator.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SelfScheduleOpenDate":{
            "type":"string",
            "description":"Date when the self-scheduling window opens.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Schedule notes.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule containing the shift.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the workforce schedule period.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SelfScheduleCloseDate":{
            "type":"string",
            "description":"Date when the self-scheduling window closes.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Discriminator":{
            "type":"integer",
            "description":"Determines the source of populated information, only for internal use.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteOpenShiftsFlag":{
            "maxLength":80,
            "type":"boolean",
            "description":"Option on the publish drawer to delete all open shifts in the period.",
            "nullable":true,
            "x-queryable":false
        },
        "workerShifts":{
            "title":"Schedule Shifts Migration",
            "type":"array",
            "description":"The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.",
            "items":{
                "$ref":"#/components/schemas/workforceSchedules-workerShifts-item-response"
            }
        },
        "PublishedDate":{
            "type":"string",
            "description":"Date when the workforce schedule was published.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the workforce schedule shift was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"User name for the person who updated the workforce schedule.",
            "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 : Schedule Shifts Migration

Type: array

Title: Schedule Shifts Migration

The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.

Show Source

• Array of: object workforceSchedules-workerShifts-item-response

{
    "title":"Schedule Shifts Migration",
    "type":"array",
    "description":"The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.",
    "items":{
        "$ref":"#/components/schemas/workforceSchedules-workerShifts-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 : workforceSchedules-workerShifts-item-response

Type: object

Show Source

• AssignedBy: integer (int64)
  Person who assigned the open shift.
• AssignmentDate: string (date-time)
  Date when the open shift was assigned.
• AssignmentId: integer (int64)
  Default Value: -1

  Assignment identifier for the worker scheduled for the shift.
• AssignmentMode: string
  Title: Assignment Source

  Maximum Length: 30

  Method used to assign the shift to the worker.
• AssignmentModeMeaning: string
  Title: Assignment Source

  Read Only: true

  Maximum Length: 80

  Method used to assign the shift to the worker.
• BreakDuration: integer (int32)
  Title: Break Duration

  Break duration in minutes.
• Comments: string
  Title: What else do people need to know about this shift?

  Maximum Length: 4000

  Shift notes.
• CompetencyId: integer
  Unique identifier for the competency.
• CompetencyName: string
  Title: Qualification

  Read Only: true

  Maximum Length: 255

  Name of the shift competency.
• ContentTypeId: integer
  Read Only: true

  Unique identifier for the content type.
• ContentTypeName: string
  Read Only: true

  Maximum Length: 255

  Name of the content type.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Workforce schedule shift creator.
• CreationDate: string (date-time)
  Read Only: true

  Date when the workforce schedule shift was created.
• DeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the workforce schedule shift needs to be deleted.
• EndDateTime: string (date-time)
  Shift end date and time.
• EndTimeTZOffset: integer (int32)
  End time for the workforce schedule shift with time zone offset, for example, -360.
• JobProfileCode: string
  Maximum Length: 30

  Unique identifier for the job profile code.
• JobProfileId: integer
  Unique identifier for the job profile.
• JobProfileName: string
  Read Only: true

  Maximum Length: 255

  Name of the job profile.
• JobProfileType: string
  Maximum Length: 80

  Type for the job profile.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the workforce schedule shift was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who updated the workforce shift.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockedFlag: boolean
  Maximum Length: 1

  Indicates whether a workforce schedule shift is locked for modifications. Valid values are Y and N. The default value is N.
• ObjectVersionNumber: integer (int32)
  Object version number.
• PersonId: integer (int64)
  Default Value: -1

  Person identifier for the workforce schedule shift assignee.
• PremiumShiftCode: string
  Maximum Length: 30

  Premium shift code for the scheduled shift type.
• Productivity: number
  Title: Productivity Percentage

  Read Only: true

  Productivity percentage for the scheduled shift type.
• ReferenceDate: string (date)
  Earned date of the workforce schedule shift that spans midnight, or where the shift is part of a shift group with at least 1 shift on the previous or next day.
• ScheduleId: integer (int64)
  Unique identifier for the workforce schedule containing the shift.
• ScheduleShiftId: integer (int64)
  Unique identifier for the workforce schedule shift.
• ScheduleUnitId: integer (int64)
  Unique identifier for the department of workforce schedule shift.
• ShiftCategory: string
  Title: Shift Category

  Maximum Length: 30

  Shift category.
• ShiftCategoryMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning for the workforce schedule shift category.
• ShiftDate: string (date)
  Title: Date

  Date for the workforce schedule shift.
• ShiftEndTime: string
  Read Only: true

  Maximum Length: 255

  End time for the workforce schedule shift.
• ShiftId: integer (int64)
  Unique identifier for the enterprise shift.
• ShiftName: string
  Read Only: true

  Maximum Length: 240

  Name of the workforce schedule shift.
• ShiftStartTime: string
  Maximum Length: 80

  Start time for the workforce schedule shift.
• ShiftType: string
  Title: Shift Type Code

  Maximum Length: 30

  Type for the scheduled shift, such as Regular or On-call.
• ShiftTypeId: integer (int64)
  Title: Shift Type

  Unique identifier for a workforce schedule shift type.
• ShiftTypeLookupCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Code for the shift type, such as Regular or On-Call
• ShiftTypeMeaning: string
  Title: Shift Type

  Read Only: true

  Maximum Length: 80

  Meaning for the scheduled shift type, such as Regular or On-call.
• SkillId: integer (int64)
  Unique identifier for the job the shift applies to.
• SkipValidationFlag: boolean
  Indicates whether the workforce schedule shift needs to be validated.
• Source: string
  Title: Source

  Maximum Length: 30

  Default Value: ORA_MANUAL

  Source for the workforce schedule shift, such as Manual entry or Automatically generated.
• SourceMeaning: string
  Title: Source

  Read Only: true

  Maximum Length: 80

  Source for the workforce schedule shift, such as Manual entry or Automatically generated.
• StartDateTime: string (date-time)
  Start date and time for the schedule shift.
• StartTimeTZOffset: integer (int32)
  Start time for the workforce schedule shift with time zone offset, for example, -360.
• WorkDuration: integer (int32)
  Title: Work Duration

  Duration, in hours and minutes, for the workforce schedule shift.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the workforce schedule shift was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentTypeId":{
            "type":"integer",
            "description":"Unique identifier for the content type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "description":"Unique identifier for the enterprise shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndTimeTZOffset":{
            "type":"integer",
            "description":"End time for the workforce schedule shift with time zone offset, for example, -360.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ShiftType":{
            "title":"Shift Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Type for the scheduled shift, such as Regular or On-call.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkDuration":{
            "title":"Work Duration",
            "type":"integer",
            "description":"Duration, in hours and minutes, for the workforce schedule shift.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AssignmentDate":{
            "type":"string",
            "description":"Date when the open shift was assigned.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ShiftCategory":{
            "title":"Shift Category",
            "maxLength":30,
            "type":"string",
            "description":"Shift category.",
            "nullable":true,
            "x-queryable":true
        },
        "ShiftDate":{
            "title":"Date",
            "type":"string",
            "description":"Date for the workforce schedule shift.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SkillId":{
            "type":"integer",
            "description":"Unique identifier for the job the shift applies to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobProfileName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the job profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMode":{
            "title":"Assignment Source",
            "maxLength":30,
            "type":"string",
            "description":"Method used to assign the shift to the worker.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignedBy":{
            "type":"integer",
            "description":"Person who assigned the open shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who updated the workforce shift.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Productivity":{
            "title":"Productivity Percentage",
            "type":"number",
            "description":"Productivity percentage for the scheduled shift type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_DVT_InformationCategory__FR_HRX_FR_SENIORITY_BRACKET":"C",
                "FND_ACFF_VF_InformationCategory__FR_HRX_FR_AGE_BRACKET":"n 2 null",
                "FND_ACFF_VF_InformationCategory__ORA_HTS_SHIFT_TYPE_PROPERTIES":"n 3 null",
                "FND_ACFF_DV_InformationCategory__FR_HRX_FR_AGE_BRACKET":"0",
                "FND_ACFF_DVT_InformationCategory__FR_HRX_FR_AGE_BRACKET":"C",
                "FND_ACFF_DVT_InformationCategory__ORA_HTS_SHIFT_TYPE_PROPERTIES":"C",
                "FND_ACFF_DV_InformationCategory__ORA_HTS_SHIFT_TYPE_PROPERTIES":"100",
                "FND_ACFF_DV_InformationCategory__FR_HRX_FR_SENIORITY_BRACKET":"0",
                "FND_ACFF_VF_InformationCategory__FR_HRX_FR_SENIORITY_BRACKET":"n 2 null"
            },
            "x-queryable":true
        },
        "JobProfileId":{
            "type":"integer",
            "description":"Unique identifier for the job profile.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Workforce schedule shift creator.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the workforce schedule shift.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompetencyName":{
            "title":"Qualification",
            "maxLength":255,
            "type":"string",
            "description":"Name of the shift competency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the workforce schedule shift needs to be deleted.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier for the workforce schedule shift assignee.",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SkipValidationFlag":{
            "type":"boolean",
            "description":"Indicates whether the workforce schedule shift needs to be validated.",
            "nullable":true,
            "x-queryable":false
        },
        "BreakDuration":{
            "title":"Break Duration",
            "type":"integer",
            "description":"Break duration in minutes.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ShiftTypeId":{
            "title":"Shift Type",
            "type":"integer",
            "description":"Unique identifier for a workforce schedule shift type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobProfileCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the job profile code.",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftCategoryMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning for the workforce schedule shift category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftTypeLookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the shift type, such as Regular or On-Call",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleUnitId":{
            "type":"integer",
            "description":"Unique identifier for the department of workforce schedule shift.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobProfileType":{
            "maxLength":80,
            "type":"string",
            "description":"Type for the job profile.",
            "nullable":true,
            "x-queryable":false
        },
        "Source":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"Source for the workforce schedule shift, such as Manual entry or Automatically generated.",
            "nullable":true,
            "default":"ORA_MANUAL",
            "x-queryable":true
        },
        "AssignmentModeMeaning":{
            "title":"Assignment Source",
            "maxLength":80,
            "type":"string",
            "description":"Method used to assign the shift to the worker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDateTime":{
            "type":"string",
            "description":"Shift end date and time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartTimeTZOffset":{
            "type":"integer",
            "description":"Start time for the workforce schedule shift with time zone offset, for example, -360.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment identifier for the worker scheduled for the shift.",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftEndTime":{
            "maxLength":255,
            "type":"string",
            "description":"End time for the workforce schedule shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftStartTime":{
            "maxLength":80,
            "type":"string",
            "description":"Start time for the workforce schedule shift.",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftTypeMeaning":{
            "title":"Shift Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning for the scheduled shift type, such as Regular or On-call.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CompetencyId":{
            "type":"integer",
            "description":"Unique identifier for the competency.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"What else do people need to know about this shift?",
            "maxLength":4000,
            "type":"string",
            "description":"Shift notes.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the content type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleShiftId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule shift.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule containing the shift.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceMeaning":{
            "title":"Source",
            "maxLength":80,
            "type":"string",
            "description":"Source for the workforce schedule shift, such as Manual entry or Automatically generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LockedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a workforce schedule shift is locked for modifications. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "type":"string",
            "description":"Start date and time for the schedule shift.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceDate":{
            "type":"string",
            "description":"Earned date of the workforce schedule shift that spans midnight, or where the shift is part of a shift group with at least 1 shift on the previous or next day.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PremiumShiftCode":{
            "maxLength":30,
            "type":"string",
            "description":"Premium shift code for the scheduled shift type.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the workforce schedule shift was most recently updated.",
            "format":"date-time",
            "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"
    }
}

Links

claimShift

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/claimShift

Parameters:

• ScheduleId: $request.path.ScheduleId

Claims an open shift matching the criteria, to one of their assignments.

createOpenShifts

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/createOpenShifts

Parameters:

• ScheduleId: $request.path.ScheduleId

Creates workforce schedule open shifts for the specified workforce schedule.

dropShift

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/dropShift

Parameters:

• ScheduleId: $request.path.ScheduleId

Drops an assigned shift with the specified schedule shift ID after the schedule is published.

shiftConflicts

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/shiftConflicts

Parameters:

• ScheduleId: $request.path.ScheduleId

Lists the conflicts for an open shift.

validateSchedule

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/validateSchedule

Parameters:

• ScheduleId: $request.path.ScheduleId

Runs full schedule validation for a schedule period.

weeklyTotals

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/weeklyTotals

Parameters:

• ScheduleId: $request.path.ScheduleId

Gets the weekly scheduled and contracted hours for the signed in worker.

withdrawShift

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/action/withdrawShift

Parameters:

• ScheduleId: $request.path.ScheduleId

Withdraws the claimed shift with the specified schedule shift ID during the self-scheduling period.

workerShifts

Operation: /hcmRestApi/resources/11.13.18.05/workforceSchedules/{ScheduleId}/child/workerShifts

Parameters:

• ScheduleId: $request.path.ScheduleId

The workerShifts resource provides information about the workforce schedule shifts. It lets schedulers view and manage schedules for a given period, open shifts, and worker assignments.

Back to Top