Jump to

• Request
• Response

Update workload plan

patch

/hcmRestApi/resources/11.13.18.05/workloadPlans/{WorkloadPlanId}

Request

Path Parameters

• WorkloadPlanId(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=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 80

  Business Unit Name
• 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
  Maximum Length: 80

  End Time
• JobCode: string
  Maximum Length: 80

  Code that uniquely identifies the HCM job used to identify the workload import record.
• JobFamilyName: string
  Maximum Length: 80

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

  Maximum Length: 80

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

  Maximum Length: 80

  Job Set Code
• LocationCode: string
  Title: Location Code

  Maximum Length: 80

  Location Code
• LocationSetCode: string
  Title: Location Set Code

  Maximum Length: 80

  Location Set Code
• OtherQualification: string
  Maximum Length: 80

  Competency, license or certification, or language value for the selected qualification type for the workload.
• 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.
• SchedulingGroupCode: string
  Maximum Length: 80

  Code that uniquely identifies the HCM scheduling group used to identify the workload import record.
• 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.
• StartDate: string (date)
  Title: Start Date

  Start Date
• StartTime: string
  Maximum Length: 80

  Start Time
• 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":{
        "LocationSetCode":{
            "title":"Location Set Code",
            "maxLength":"80",
            "type":"string",
            "description":"Location Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "EndTime":{
            "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"
            }
        },
        "ShiftTypeExtendedCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Code used to describe the shift type.",
            "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
        },
        "JobProfileType":{
            "title":"Job Profile Type",
            "maxLength":"80",
            "type":"string",
            "description":"Job Profile Code",
            "nullable":true,
            "x-queryable":false
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":"80",
            "type":"string",
            "description":"Location Code",
            "nullable":true,
            "x-queryable":false
        },
        "StartTime":{
            "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"
            }
        },
        "JobSetCode":{
            "title":"Job Set Code",
            "maxLength":"80",
            "type":"string",
            "description":"Job Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":false
        },
        "OtherQualification":{
            "maxLength":"80",
            "type":"string",
            "description":"Competency, license or certification, or language value for the selected qualification type for the workload.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":false
        },
        "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
        },
        "ShiftTypeCode":{
            "type":"string",
            "description":"Code for the shift type, such as Regular or On-Call.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "WorkloadValue":{
            "title":"Workload Value",
            "type":"number",
            "description":"Workload Value",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "scale":"6"
            }
        },
        "DepartmentName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the schedule department.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"80",
            "type":"string",
            "description":"Business Unit Name",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "EndAfterMidnightFlag":{
            "type":"boolean",
            "description":"Indicates whether the workload plan ends after midnight.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : workloadPlans-item-response

Type: object

Show Source

• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 80

  Business Unit Name
• 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
  Maximum Length: 80

  End Time
• JobCode: string
  Maximum Length: 80

  Code that uniquely identifies the HCM job used to identify the workload import record.
• JobFamilyName: string
  Maximum Length: 80

  Code that uniquely identifies the HCM job family used to identify the workload import record.
• 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
• LocationSetCode: string
  Title: Location Set Code

  Maximum Length: 80

  Location Set Code
• OtherQualification: string
  Maximum Length: 80

  Competency, license or certification, or language value for the selected qualification type for the workload.
• 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.
• SchedulingGroupCode: string
  Maximum Length: 80

  Code that uniquely identifies the HCM scheduling group used to identify the workload import record.
• 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.
• StartDate: string (date)
  Title: Start Date

  Start Date
• StartTime: string
  Maximum Length: 80

  Start 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":{
            "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
        },
        "JobProfileType":{
            "title":"Job Profile Type",
            "maxLength":"80",
            "type":"string",
            "description":"Job Profile Code",
            "nullable":true,
            "x-queryable":false
        },
        "JobSetCode":{
            "title":"Job Set Code",
            "maxLength":"80",
            "type":"string",
            "description":"Job Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "OtherQualification":{
            "maxLength":"80",
            "type":"string",
            "description":"Competency, license or certification, or language value for the selected qualification type for the workload.",
            "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
        },
        "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
        },
        "LocationSetCode":{
            "title":"Location Set Code",
            "maxLength":"80",
            "type":"string",
            "description":"Location Set Code",
            "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":{
            "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
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ShiftTypeCode":{
            "type":"string",
            "description":"Code for the shift type, such as Regular or On-Call.",
            "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
        },
        "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
        },
        "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
        },
        "EndAfterMidnightFlag":{
            "type":"boolean",
            "description":"Indicates whether the workload plan ends after midnight.",
            "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."
        }
    }
}

Back to Top