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
  Maximum Length: 80

  Business Unit Name
• CompetencyCode: string
  Maximum Length: 80

  Competency Name
• DepartmentCode: string
  Maximum Length: 80

  Department Name
• EndAfterMidnightFlag: boolean
  End After Midnight Flag
• EndDate: string (date)
  End Date
• EndTime: string
  Maximum Length: 255

  End Time
• JobProfileCode: string
  Maximum Length: 80

  Job Profile Code
• JobProfileId: integer
  Job Profile ID
• JobProfileType: string
  Maximum Length: 80

  Job Profile Type Code
• JobSetCode: string
  Maximum Length: 80

  Job Set Code
• LocationCode: string
  Maximum Length: 80

  Location Code
• LocationSetCode: string
  Maximum Length: 80

  Location Set Code
• SchedUnitId: integer (int64)
  Schedule Unit ID
• SkillId: integer (int64)
  Skill ID
• StartAfterMidnightFlag: boolean
  Start After Midnight Flag
• StartDate: string (date)
  Start Date
• StartTime: string
  Maximum Length: 255

  Start Time
• WorkloadType: string
  Maximum Length: 30

  Workload Type Code
• WorkloadUOM: string
  Maximum Length: 30

  UOM Code
• WorkloadValue: number
  Workload Value

{
    "type":"object",
    "properties":{
        "DepartmentCode":{
            "maxLength":80,
            "type":"string",
            "description":"Department Name",
            "nullable":true,
            "x-queryable":false
        },
        "JobProfileId":{
            "type":"integer",
            "description":"Job Profile ID",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSetCode":{
            "maxLength":80,
            "type":"string",
            "description":"Location Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "EndTime":{
            "maxLength":255,
            "type":"string",
            "description":"End Time",
            "nullable":true
        },
        "WorkloadUOM":{
            "maxLength":30,
            "type":"string",
            "description":"UOM Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "JobProfileType":{
            "maxLength":80,
            "type":"string",
            "description":"Job Profile Type Code",
            "nullable":true,
            "x-queryable":false
        },
        "LocationCode":{
            "maxLength":80,
            "type":"string",
            "description":"Location Code",
            "nullable":true,
            "x-queryable":false
        },
        "WorkloadType":{
            "maxLength":30,
            "type":"string",
            "description":"Workload Type Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Start Time",
            "nullable":true
        },
        "JobSetCode":{
            "maxLength":80,
            "type":"string",
            "description":"Job Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "CompetencyCode":{
            "maxLength":80,
            "type":"string",
            "description":"Competency Name",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":false
        },
        "WorkloadValue":{
            "type":"number",
            "description":"Workload Value",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "scale":6
            }
        },
        "SkillId":{
            "type":"integer",
            "description":"Skill ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BusinessUnitName":{
            "maxLength":80,
            "type":"string",
            "description":"Business Unit Name",
            "nullable":true,
            "x-queryable":false
        },
        "SchedUnitId":{
            "type":"integer",
            "description":"Schedule Unit ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndAfterMidnightFlag":{
            "type":"boolean",
            "description":"End After Midnight Flag",
            "nullable":true
        },
        "StartAfterMidnightFlag":{
            "type":"boolean",
            "description":"Start After Midnight Flag",
            "nullable":true
        },
        "JobProfileCode":{
            "maxLength":80,
            "type":"string",
            "description":"Job Profile Code",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : workloadPlans-item-response

Type: object

Show Source

• BusinessUnitName: string
  Maximum Length: 80

  Business Unit Name
• CompetencyCode: string
  Maximum Length: 80

  Competency Name
• DepartmentCode: string
  Maximum Length: 80

  Department Name
• EndAfterMidnightFlag: boolean
  End After Midnight Flag
• EndDate: string (date)
  End Date
• EndTime: string
  Maximum Length: 255

  End Time
• JobProfileCode: string
  Maximum Length: 80

  Job Profile Code
• JobProfileId: integer
  Job Profile ID
• JobProfileType: string
  Maximum Length: 80

  Job Profile Type Code
• JobSetCode: string
  Maximum Length: 80

  Job Set Code
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Maximum Length: 80

  Location Code
• LocationSetCode: string
  Maximum Length: 80

  Location Set Code
• SchedUnitId: integer (int64)
  Schedule Unit ID
• SkillId: integer (int64)
  Skill ID
• StartAfterMidnightFlag: boolean
  Start After Midnight Flag
• StartDate: string (date)
  Start Date
• StartTime: string
  Maximum Length: 255

  Start Time
• WorkloadPlanCode: string
  Maximum Length: 30

  Workload Plan Code
• WorkloadPlanId: integer (int64)
  Workload Plan ID
• WorkloadType: string
  Maximum Length: 30

  Workload Type Code
• WorkloadUOM: string
  Maximum Length: 30

  UOM Code
• WorkloadValue: number
  Workload Value

{
    "type":"object",
    "properties":{
        "DepartmentCode":{
            "maxLength":80,
            "type":"string",
            "description":"Department Name",
            "nullable":true,
            "x-queryable":false
        },
        "JobProfileId":{
            "type":"integer",
            "description":"Job Profile ID",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSetCode":{
            "maxLength":80,
            "type":"string",
            "description":"Location Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "EndTime":{
            "maxLength":255,
            "type":"string",
            "description":"End Time",
            "nullable":true,
            "x-queryable":true
        },
        "WorkloadUOM":{
            "maxLength":30,
            "type":"string",
            "description":"UOM Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobProfileType":{
            "maxLength":80,
            "type":"string",
            "description":"Job Profile Type Code",
            "nullable":true,
            "x-queryable":false
        },
        "LocationCode":{
            "maxLength":80,
            "type":"string",
            "description":"Location Code",
            "nullable":true,
            "x-queryable":false
        },
        "WorkloadType":{
            "maxLength":30,
            "type":"string",
            "description":"Workload Type Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Start Time",
            "nullable":true,
            "x-queryable":true
        },
        "JobSetCode":{
            "maxLength":80,
            "type":"string",
            "description":"Job Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "CompetencyCode":{
            "maxLength":80,
            "type":"string",
            "description":"Competency Name",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "WorkloadPlanId":{
            "type":"integer",
            "description":"Workload Plan ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkloadPlanCode":{
            "maxLength":30,
            "type":"string",
            "description":"Workload Plan Code",
            "nullable":false,
            "x-queryable":true
        },
        "WorkloadValue":{
            "type":"number",
            "description":"Workload Value",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "scale":6
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SkillId":{
            "type":"integer",
            "description":"Skill ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "maxLength":80,
            "type":"string",
            "description":"Business Unit Name",
            "nullable":true,
            "x-queryable":false
        },
        "SchedUnitId":{
            "type":"integer",
            "description":"Schedule Unit ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndAfterMidnightFlag":{
            "type":"boolean",
            "description":"End After Midnight Flag",
            "nullable":true,
            "x-queryable":true
        },
        "StartAfterMidnightFlag":{
            "type":"boolean",
            "description":"Start After Midnight Flag",
            "nullable":true,
            "x-queryable":true
        },
        "JobProfileCode":{
            "maxLength":80,
            "type":"string",
            "description":"Job Profile Code",
            "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