Jump to

• Request
• Response

Get all workload plans

get

/hcmRestApi/resources/11.13.18.05/workloadPlans

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the workload plan by the primary key
    Finder Variables
    • WorkloadPlanId; integer; Unique primary key identifier of the workload plan
  • findByWorkloadPlanCode Finds the workload plan using the specified workload plan code.
    Finder Variables
    • WorkloadPlanCode; string; Code for the workload plan.
  • findByWorkloadPlanId Finds the workload plan using the specified workload plan ID.
    Finder Variables
    • WorkloadPlanId; integer; Unique identifier for the workload plan
• 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:
  

  • EndDate; string; End Date
  • FridayIncludedFlag; boolean; Indicates whether Friday is selected for the workload plan.
  • IsConsolidatedFlag; boolean; Indicator for the workload requirement describing when the record was consolidated.
  • MondayIncludedFlag; boolean; Indicates whether Mondays is selected for the workload plan.
  • SaturdayIncludedFlag; boolean; Indicates whether Saturday is selected for the workload plan.
  • ShiftId; integer; Unique identifier for the shift.
  • ShiftTypeId; integer; Unique identifier for the shift type.
  • StartDate; string; Start Date
  • SundayIncludedFlag; boolean; Indicates whether Sunday is selected for the workload plan.
  • ThursdayIncludedFlag; boolean; Indicates whether Thursday is selected for the workload plan.
  • TuesdayIncludedFlag; boolean; Indicates whether Tuesday is selected for the workload plan.
  • WednesdayIncludedFlag; boolean; Indicates whether Wednesday is selected for the workload plan.
  • WorkloadImportTag; string; Tag used to uniquely identify the workload import.
  • WorkloadMode; string; Type of workload import, such as Shift or Time.
  • WorkloadPlanCode; string; Workload Plan Code
  • WorkloadPlanId; integer; Workload Plan ID
  • WorkloadType; string; Workload Type
  • WorkloadUOM; string; UOM Code
  • WorkloadValue; number; Workload Value
• 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 : workloadPlans

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object workloadPlans-item-response

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

Type: object

Show Source

• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 80

  Business Unit Name
• CompetencyId: integer
  Unique identifier for the competency.
• DepartmentId: integer
  Title: Department Identifier

  Unique identifier for the department.
• DepartmentName: string
  Maximum Length: 80

  Name of the schedule department.
• EndAfterMidnightFlag: boolean
  Indicates whether the workload plan ends after midnight.
• EndDate: string (date)
  Title: End Date

  End Date
• EndTime: string
  Title: End Time

  Maximum Length: 80

  End Time
• FridayIncludedFlag: boolean
  Title: Friday

  Maximum Length: 1

  Indicates whether Friday is selected for the workload plan.
• IsConsolidatedFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicator for the workload requirement describing when the record was consolidated.
• JobCode: string
  Maximum Length: 80

  Code that uniquely identifies the HCM job used to identify the workload import record.
• JobFamilyId: integer
  Unique identifier for the job family.
• JobFamilyName: string
  Maximum Length: 80

  Code that uniquely identifies the HCM job family used to identify the workload import record.
• JobId: integer
  Unique identifier for the job.
• JobProfileType: string
  Title: Job Profile Type

  Maximum Length: 80

  Job Profile Code
• JobSetCode: string
  Title: Job Set Code

  Maximum Length: 80

  Job Set Code
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Title: Location Code

  Maximum Length: 80

  Location Code
• LocationId: integer
  Title: Workload Location Identifier

  Unique identifier for the location.
• LocationName: string
  Maximum Length: 80

  Name of the location.
• LocationSetCode: string
  Title: Location Set Code

  Maximum Length: 80

  Location Set Code
• MondayIncludedFlag: boolean
  Title: Monday

  Maximum Length: 1

  Indicates whether Mondays is selected for the workload plan.
• OtherQualification: string
  Maximum Length: 250

  Competency, license or certification, or language value for the selected qualification type for the workload.
• OtherQualificationId: integer
  Unique identifier for the other qualification.
• OtherQualificationType: string
  Maximum Length: 80

  Competency, license or certification, or language used to define the Other Qualification value for workload.
• PositionCode: string
  Title: Position Code

  Maximum Length: 80

  Code that uniquely identifies the HCM position used to identify the workload import record.
• PositionId: integer
  Unique identifier for the position.
• SaturdayIncludedFlag: boolean
  Title: Saturday

  Maximum Length: 1

  Indicates whether Saturday is selected for the workload plan.
• SchedulingGroupCode: string
  Maximum Length: 80

  Code that uniquely identifies the HCM scheduling group used to identify the workload import record.
• ShiftId: integer (int64)
  Unique identifier for the shift.
• ShiftName: string
  Title: Shift Name

  Maximum Length: 80

  Name of the workforce scheduling shift.
• ShiftTypeCode: string
  Code for the shift type, such as Regular or On-Call.
• ShiftTypeExtendedCode: string
  Maximum Length: 80

  Code used to describe the shift type.
• ShiftTypeExtendedCodeName: string
  Title: Shift Type

  Maximum Length: 80

  Name of the shift type.
• ShiftTypeId: integer (int64)
  Unique identifier for the shift type.
• StartDate: string (date)
  Title: Start Date

  Start Date
• StartTime: string
  Title: Start Time

  Maximum Length: 80

  Start Time
• SundayIncludedFlag: boolean
  Title: Sunday

  Maximum Length: 1

  Indicates whether Sunday is selected for the workload plan.
• ThursdayIncludedFlag: boolean
  Title: Thursday

  Maximum Length: 1

  Indicates whether Thursday is selected for the workload plan.
• TuesdayIncludedFlag: boolean
  Title: Tuesday

  Maximum Length: 1

  Indicates whether Tuesday is selected for the workload plan.
• WednesdayIncludedFlag: boolean
  Title: Wednesday

  Maximum Length: 1

  Indicates whether Wednesday is selected for the workload plan.
• WorkloadImportTag: string
  Title: Import Tag

  Maximum Length: 30

  Tag used to uniquely identify the workload import.
• WorkloadMode: string
  Maximum Length: 1

  Type of workload import, such as Shift or Time.
• WorkloadPlanCode: string
  Title: Workload Plan Code

  Maximum Length: 30

  Workload Plan Code
• WorkloadPlanId: integer (int64)
  Title: Workload Plan Identifier

  Workload Plan ID
• WorkloadType: string
  Title: Workload Type

  Maximum Length: 30

  Workload Type
• WorkloadUOM: string
  Title: Workload UOM Code

  Maximum Length: 30

  UOM Code
• WorkloadValue: number
  Title: Workload Value

  Workload Value

{
    "type":"object",
    "properties":{
        "EndTime":{
            "title":"End Time",
            "maxLength":80,
            "type":"string",
            "description":"End Time",
            "nullable":true,
            "x-queryable":false
        },
        "WorkloadUOM":{
            "title":"Workload UOM Code",
            "maxLength":30,
            "type":"string",
            "description":"UOM Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShiftTypeExtendedCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code used to describe the shift type.",
            "nullable":true,
            "x-queryable":false
        },
        "TuesdayIncludedFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Tuesday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ShiftTypeExtendedCodeName":{
            "title":"Shift Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the shift type.",
            "nullable":true,
            "x-queryable":false
        },
        "JobProfileType":{
            "title":"Job Profile Type",
            "maxLength":80,
            "type":"string",
            "description":"Job Profile Code",
            "nullable":true,
            "x-queryable":false
        },
        "SundayIncludedFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Sunday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "JobSetCode":{
            "title":"Job Set Code",
            "maxLength":80,
            "type":"string",
            "description":"Job Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftId":{
            "type":"integer",
            "description":"Unique identifier for the shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkloadMode":{
            "maxLength":1,
            "type":"string",
            "description":"Type of workload import, such as Shift or Time.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherQualification":{
            "maxLength":250,
            "type":"string",
            "description":"Competency, license or certification, or language value for the selected qualification type for the workload.",
            "nullable":true,
            "x-queryable":false
        },
        "WednesdayIncludedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Wednesday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "JobFamilyName":{
            "maxLength":80,
            "type":"string",
            "description":"Code that uniquely identifies the HCM job family used to identify the workload import record.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkloadImportTag":{
            "title":"Import Tag",
            "maxLength":30,
            "type":"string",
            "description":"Tag used to uniquely identify the workload import.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code that uniquely identifies the HCM job used to identify the workload import record.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":80,
            "type":"string",
            "description":"Business Unit Name",
            "nullable":true,
            "x-queryable":false
        },
        "PositionCode":{
            "title":"Position Code",
            "maxLength":80,
            "type":"string",
            "description":"Code that uniquely identifies the HCM position used to identify the workload import record.",
            "nullable":true,
            "x-queryable":false
        },
        "JobId":{
            "type":"integer",
            "description":"Unique identifier for the job.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSetCode":{
            "title":"Location Set Code",
            "maxLength":80,
            "type":"string",
            "description":"Location Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftName":{
            "title":"Shift Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the workforce scheduling shift.",
            "nullable":true,
            "x-queryable":false
        },
        "CompetencyId":{
            "type":"integer",
            "description":"Unique identifier for the competency.",
            "nullable":true,
            "x-queryable":false
        },
        "PositionId":{
            "type":"integer",
            "description":"Unique identifier for the position.",
            "nullable":true,
            "x-queryable":false
        },
        "OtherQualificationType":{
            "maxLength":80,
            "type":"string",
            "description":"Competency, license or certification, or language used to define the Other Qualification value for workload.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":80,
            "type":"string",
            "description":"Location Code",
            "nullable":true,
            "x-queryable":false
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":80,
            "type":"string",
            "description":"Start Time",
            "nullable":true,
            "x-queryable":false
        },
        "WorkloadType":{
            "title":"Workload Type",
            "maxLength":30,
            "type":"string",
            "description":"Workload Type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationId":{
            "title":"Workload Location Identifier",
            "type":"integer",
            "description":"Unique identifier for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "SaturdayIncludedFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Saturday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "IsConsolidatedFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicator for the workload requirement describing when the record was consolidated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MondayIncludedFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Mondays is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ShiftTypeCode":{
            "type":"string",
            "description":"Code for the shift type, such as Regular or On-Call.",
            "nullable":true,
            "x-queryable":false
        },
        "JobFamilyId":{
            "type":"integer",
            "description":"Unique identifier for the job family.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkloadPlanId":{
            "title":"Workload Plan Identifier",
            "type":"integer",
            "description":"Workload Plan ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkloadPlanCode":{
            "title":"Workload Plan Code",
            "maxLength":30,
            "type":"string",
            "description":"Workload Plan Code",
            "nullable":false,
            "x-queryable":true
        },
        "FridayIncludedFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Friday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkloadValue":{
            "title":"Workload Value",
            "type":"number",
            "description":"Workload Value",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "scale":6
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the schedule department.",
            "nullable":true,
            "x-queryable":false
        },
        "DepartmentId":{
            "title":"Department Identifier",
            "type":"integer",
            "description":"Unique identifier for the department.",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftTypeId":{
            "type":"integer",
            "description":"Unique identifier for the shift type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SchedulingGroupCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code that uniquely identifies the HCM scheduling group used to identify the workload import record.",
            "nullable":true,
            "x-queryable":false
        },
        "ThursdayIncludedFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Thursday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "EndAfterMidnightFlag":{
            "type":"boolean",
            "description":"Indicates whether the workload plan ends after midnight.",
            "nullable":true,
            "x-queryable":false
        },
        "OtherQualificationId":{
            "type":"integer",
            "description":"Unique identifier for the other qualification.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

findByAdvancedSearchQuery

Operation: /hcmRestApi/resources/11.13.18.05/workloadPlans/action/findByAdvancedSearchQuery

Finds the workload plans matching the specified criteria such as department or location.

Back to Top