Jump to

• Request
• Response

Get a workforce schedule shift

get

/hcmRestApi/resources/11.13.18.05/workforceScheduleShifts/{ScheduleShiftId}

Request

Path Parameters

• ScheduleShiftId(required): integer(int64)
  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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Type: object

Show Source

• AllowOvertimeFlag: boolean
  Read Only: true

  Maximum Length: 1

  Specify if the shift assignee can go over their weekly assignment hours.
• ApprovalRequiredToClaimFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether approval is required for the worker to request the shift.
• AssignmentId: integer (int64)
  Read Only: true

  Unique identifier for the assignment of the worker assigned to the shift.
• AssignmentMode: string
  Read Only: true

  Maximum Length: 30

  Method used to assign the shift to the worker, such as Automatic, Manual, or Self-Scheduled.
• AssignmentNumber: string
  Read Only: true

  Maximum Length: 50

  Person number for the shift assignee.
• CalendarDate: string (date)
  Read Only: true

  Date for the shift.
• Comments: string
  Read Only: true

  Maximum Length: 4000

  Notes for the shift.
• ContentItemCode: string
  Read Only: true

  Maximum Length: 30

  Code for the content item needed for the shift assignee.
• ContentTypeId: integer (int64)
  Read Only: true

  Unique identifier for the content type needed for the shift assignee.
• CreationDate: string (date-time)
  Read Only: true

  Date when the shift detail was created for the workforce schedule.
• DepartmentId: integer (int64)
  Read Only: true

  Unique identifier for the workforce schedule department.
• DepartmentName: string
  Read Only: true

  Maximum Length: 240

  Name of the workforce schedule department.
• DisplayName: string
  Read Only: true

  Maximum Length: 240

  Display name of the shift.
• EndDateTime: string (date-time)
  Read Only: true

  End time for the shift.
• JobCode: string
  Read Only: true

  Maximum Length: 30

  Code for the job needed by the shift assignee.
• JobFamilyName: string
  Read Only: true

  Maximum Length: 240

  Name of the job family needed by the shift assignee.
• JobId: integer (int64)
  Read Only: true

  Unique identifier for the job needed by the shift assignee.
• JobName: string
  Read Only: true

  Maximum Length: 240

  Name of the job needed by the shift assignee.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the shift was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Read Only: true

  Maximum Length: 60

  Code for the workforce schedule location.
• LocationId: integer (int64)
  Read Only: true

  Unique identifier for the workforce schedule location.
• LocationName: string
  Read Only: true

  Maximum Length: 240

  Name of the workforce schedule location.
• OtherDepartmentFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether to include the shift in float workers self-scheduling.
• PaidBreakDuration: integer
  Read Only: true

  Paid break duration in minutes.
• PersonId: integer (int64)
  Read Only: true

  Unique identifier for the shift assignee.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  Person number for the shift assignee.
• PositionCode: string
  Read Only: true

  Maximum Length: 30

  Code for the position needed by the shift assignee.
• PositionId: integer (int64)
  Read Only: true

  Unique identifier for the position needed by the shift assignee.
• PositionName: string
  Read Only: true

  Maximum Length: 240

  Name of the position needed by shift assignee.
• PremiumShiftCode: string
  Read Only: true

  Maximum Length: 30

  Premium code for the shift.
• PremiumShiftCodeMeaning: string
  Read Only: true

  Maximum Length: 80

  Premium name of the shift.
• Productivity: number
  Read Only: true

  Productivity percentage for the shift type selected for the shift.
• QualificationId: integer (int64)
  Read Only: true

  Unique identifier for the other qualification needed by the shift assignee.
• QualificationName: string
  Read Only: true

  Maximum Length: 700

  Name of the other qualification needed by the shift assignee.
• QualificationType: string
  Read Only: true

  Maximum Length: 240

  Type for the other qualification needed by the shift assignee, such as competency, license or certification, or language.
• ReferenceDate: string (date)
  Read Only: true

  Reference date for the shift.
• ScheduleGroupCode: string
  Read Only: true

  Maximum Length: 30

  Code for the schedule group needed by the shift assignee.
• ScheduleGroupCodeMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the schedule group needed by the shift assignee.
• ScheduleId: integer (int64)
  Read Only: true

  Unique identifier for the workforce schedule.
• ScheduleShiftId: integer (int64)
  Read Only: true

  Unique identifier for the workforce schedule shift.
• ScheduleUnitId: integer (int64)
  Read Only: true

  Unique identifier for the schedule unit of the workforce schedule.
• ShiftCategory: string
  Read Only: true

  Maximum Length: 80

  Category name for the shift.
• ShiftCategoryCode: string
  Read Only: true

  Maximum Length: 30

  Category code for the shift.
• ShiftIncentive: number
  Read Only: true

  Monetary amount a worker will get when assigned to the shift.
• ShiftName: string
  Read Only: true

  Maximum Length: 240

  Name of the shift.
• ShiftType: string
  Read Only: true

  Maximum Length: 30

  Shift type selected for the shift.
• ShiftTypeId: integer (int64)
  Read Only: true

  Unique identifier for the shift type selected for the shift.
• ShiftTypeLookupCode: string
  Read Only: true

  Maximum Length: 30

  Code for the shift type
• ShiftTypeName: string
  Read Only: true

  Maximum Length: 80

  Meaning for the shift type.
• Source: string
  Read Only: true

  Maximum Length: 30

  Method used to create the shift, such as Manual or Automatic.
• StartDateTime: string (date-time)
  Read Only: true

  Start time for the shift.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Code for the workforce schedule status, such as ORA_HTS_PUBLISHED, ORA_HTS_UNPUBLISHED, ORA_HTS_IN_PROGRESS, ORA_HTS_NOT_STARTED, or ORA_HTS_GEN_ERROR.
• UnpaidBreakDuration: integer (int32)
  Read Only: true

  Unpaid break duration in minutes.
• WorkDuration: integer (int32)
  Read Only: true

  Work duration in minutes.

{
    "type":"object",
    "properties":{
        "PaidBreakDuration":{
            "type":"integer",
            "description":"Paid break duration in minutes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the shift detail was created for the workforce schedule.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentTypeId":{
            "type":"integer",
            "description":"Unique identifier for the content type needed for the shift assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualificationId":{
            "type":"integer",
            "description":"Unique identifier for the other qualification needed by the shift assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftType":{
            "maxLength":30,
            "type":"string",
            "description":"Shift type selected for the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnpaidBreakDuration":{
            "type":"integer",
            "description":"Unpaid break duration in minutes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the workforce schedule status, such as ORA_HTS_PUBLISHED, ORA_HTS_UNPUBLISHED, ORA_HTS_IN_PROGRESS, ORA_HTS_NOT_STARTED, or ORA_HTS_GEN_ERROR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarDate":{
            "type":"string",
            "description":"Date for the shift.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDuration":{
            "type":"integer",
            "description":"Work duration in minutes.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ShiftCategory":{
            "maxLength":80,
            "type":"string",
            "description":"Category name for the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignmentMode":{
            "maxLength":30,
            "type":"string",
            "description":"Method used to assign the shift to the worker, such as Automatic, Manual, or Self-Scheduled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the position needed by the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Productivity":{
            "type":"number",
            "description":"Productivity percentage for the shift type selected for the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationName":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the other qualification needed by the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the position needed by shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftTypeName":{
            "maxLength":80,
            "type":"string",
            "description":"Meaning for the shift type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationCode":{
            "maxLength":60,
            "type":"string",
            "description":"Code for the workforce schedule location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentItemCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the content item needed for the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Category code for the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier for the shift assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the workforce schedule department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftTypeId":{
            "type":"integer",
            "description":"Unique identifier for the shift type selected for the shift.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftTypeLookupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the shift type",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleUnitId":{
            "type":"integer",
            "description":"Unique identifier for the schedule unit of the workforce schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the job needed by the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Source":{
            "maxLength":30,
            "type":"string",
            "description":"Method used to create the shift, such as Manual or Automatic.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the workforce schedule location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the job family needed by the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowOvertimeFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Specify if the shift assignee can go over their weekly assignment hours.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateTime":{
            "type":"string",
            "description":"End time for the shift.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the job needed by the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker assigned to the shift.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Person number for the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalRequiredToClaimFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether approval is required for the worker to request the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Unique identifier for the job needed by the shift assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Person number for the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionId":{
            "type":"integer",
            "description":"Unique identifier for the position needed by the shift assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Notes for the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleShiftId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule shift.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleGroupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the schedule group needed by the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleGroupCodeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the schedule group needed by the shift assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateTime":{
            "type":"string",
            "description":"Start time for the shift.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationType":{
            "maxLength":240,
            "type":"string",
            "description":"Type for the other qualification needed by the shift assignee, such as competency, license or certification, or language.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PremiumShiftCodeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Premium name of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Unique identifier for the workforce schedule department.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftIncentive":{
            "type":"number",
            "description":"Monetary amount a worker will get when assigned to the shift.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9,
                "scale":3
            },
            "x-queryable":true
        },
        "ReferenceDate":{
            "type":"string",
            "description":"Reference date for the shift.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OtherDepartmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to include the shift in float workers self-scheduling.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PremiumShiftCode":{
            "maxLength":30,
            "type":"string",
            "description":"Premium code for the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the shift was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top