Jump to

• Request
• Response

Get all the workforce schedule shifts for the specified unit and period

get

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

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=

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the workforce schedule shift with the specified unique identifier.
    Finder Variables
    • ScheduleShiftId; integer; Workforce schedule shift with the specified schedule shift identifier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignedBy; integer; Person who assigned the open shift.
  • AssignmentDate; string; Date when the open shift was assigned.
  • AssignmentId; integer; Assignment identifier for the worker scheduled for the shift.
  • AssignmentMode; string; Method used to assign the shift to the worker.
  • BreakDuration; integer; Break duration in minutes.
  • Comments; string; Shift notes.
  • CompetencyName; string; Name of the shift competency.
  • ContentTypeId; integer; Unique identifier for the content type.
  • ContentTypeName; string; Name of the content type.
  • CreatedBy; string; Workforce schedule shift creator.
  • CreationDate; string; Date when the workforce schedule shift was created.
  • EndDateTime; string; Shift end date and time.
  • EndTimeTZOffset; integer; End time for the workforce schedule shift with time zone offset, for example, -360.
  • JobProfileName; string; Name of the job profile.
  • LastUpdateDate; string; Date when the workforce schedule shift was most recently updated.
  • LastUpdatedBy; string; Person who updated the workforce shift.
  • LockedFlag; boolean; Indicates whether a workforce schedule shift is locked for modifications. Valid values are Y and N. The default value is N.
  • ObjectVersionNumber; integer; Object version number.
  • PersonId; integer; Person identifier for the workforce schedule shift assignee.
  • PremiumShiftCode; string; Premium shift code for the scheduled shift type.
  • Productivity; number; Productivity percentage for the scheduled shift type.
  • ReferenceDate; string; 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; Unique identifier for the workforce schedule containing the shift.
  • ScheduleShiftId; integer; Unique identifier for the workforce schedule shift.
  • ScheduleUnitId; integer; Unique identifier for the department of workforce schedule shift.
  • ShiftCategory; string; Shift category.
  • ShiftCategoryMeaning; string; Meaning for the workforce schedule shift category.
  • ShiftEndTime; string; End time for the workforce schedule shift.
  • ShiftId; integer; Unique identifier for the enterprise shift.
  • ShiftName; string; Name of the workforce schedule shift.
  • ShiftType; string; Type for the scheduled shift, such as Regular or On-call.
  • ShiftTypeId; integer; Unique identifier for a workforce schedule shift type.
  • ShiftTypeLookupCode; string; Code for the shift type, such as Regular or On-Call
  • ShiftTypeMeaning; string; Meaning for the scheduled shift type, such as Regular or On-call.
  • SkillId; integer; Unique identifier for the job the shift applies to.
  • Source; string; Source for the workforce schedule shift, such as Manual entry or Automatically generated.
  • StartDateTime; string; Start date and time for the schedule shift.
  • StartTimeTZOffset; integer; Start time for the workforce schedule shift with time zone offset, for example, -360.
  • WorkDuration; integer; Duration, in hours and minutes, for the workforce schedule shift.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : workforceSchedules-workerShifts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/workforceSchedules-workerShifts-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/workforceSchedules-workerShifts-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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"
    }
}

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

Links

createOpenShifts

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

Parameters:

• ScheduleId: $request.path.ScheduleId

Creates workforce schedule open shifts for the specified workforce schedule.

Back to Top