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: string
  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: string
  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
• 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.
• 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
• 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.
• 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":{
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":80,
            "type":"string",
            "description":"Business Unit Name",
            "nullable":true,
            "x-queryable":false
        },
        "CompetencyId":{
            "type":"integer",
            "description":"Unique identifier for the competency.",
            "nullable":true,
            "x-queryable":false
        },
        "DepartmentId":{
            "title":"Department Identifier",
            "type":"integer",
            "description":"Unique identifier for the department.",
            "nullable":true,
            "x-queryable":false
        },
        "DepartmentName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the schedule department.",
            "nullable":true,
            "x-queryable":false
        },
        "EndAfterMidnightFlag":{
            "type":"boolean",
            "description":"Indicates whether the workload plan ends after midnight.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":false
        },
        "EndTime":{
            "title":"End Time",
            "maxLength":80,
            "type":"string",
            "description":"End Time",
            "nullable":true,
            "x-queryable":false
        },
        "FridayIncludedFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Friday is selected for the workload plan.",
            "nullable":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
        },
        "JobFamilyId":{
            "type":"integer",
            "description":"Unique identifier for the job family.",
            "nullable":true,
            "x-queryable":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
        },
        "JobId":{
            "type":"integer",
            "description":"Unique identifier for the job.",
            "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
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":80,
            "type":"string",
            "description":"Location Code",
            "nullable":true,
            "x-queryable":false
        },
        "LocationId":{
            "title":"Workload Location Identifier",
            "type":"integer",
            "description":"Unique identifier for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSetCode":{
            "title":"Location Set Code",
            "maxLength":80,
            "type":"string",
            "description":"Location Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "MondayIncludedFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Mondays is selected for the workload plan.",
            "nullable":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
        },
        "OtherQualificationId":{
            "type":"integer",
            "description":"Unique identifier for the other qualification.",
            "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
        },
        "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
        },
        "PositionId":{
            "type":"integer",
            "description":"Unique identifier for the position.",
            "nullable":true,
            "x-queryable":false
        },
        "SaturdayIncludedFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Saturday is selected for the workload plan.",
            "nullable":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
        },
        "ShiftId":{
            "type":"integer",
            "description":"Unique identifier for the shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ShiftName":{
            "title":"Shift Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the workforce scheduling shift.",
            "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
        },
        "ShiftTypeExtendedCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code used to describe the shift type.",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftTypeExtendedCodeName":{
            "title":"Shift Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the shift type.",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftTypeId":{
            "type":"integer",
            "description":"Unique identifier for the shift type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":false
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":80,
            "type":"string",
            "description":"Start Time",
            "nullable":true,
            "x-queryable":false
        },
        "SundayIncludedFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Sunday is selected for the workload plan.",
            "nullable":true
        },
        "ThursdayIncludedFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Thursday is selected for the workload plan.",
            "nullable":true
        },
        "TuesdayIncludedFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Tuesday is selected for the workload plan.",
            "nullable":true
        },
        "WednesdayIncludedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Wednesday is selected for the workload plan.",
            "nullable":true
        },
        "WorkloadImportTag":{
            "title":"Import Tag",
            "maxLength":30,
            "type":"string",
            "description":"Tag used to uniquely identify the workload import.",
            "nullable":true
        },
        "WorkloadMode":{
            "maxLength":1,
            "type":"string",
            "description":"Type of workload import, such as Shift or Time.",
            "nullable":true
        },
        "WorkloadType":{
            "title":"Workload Type",
            "maxLength":30,
            "type":"string",
            "description":"Workload Type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkloadUOM":{
            "title":"Workload UOM Code",
            "maxLength":30,
            "type":"string",
            "description":"UOM Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkloadValue":{
            "title":"Workload Value",
            "type":"number",
            "description":"Workload Value",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "scale":6
            }
        }
    }
}

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
• 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":{
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":80,
            "type":"string",
            "description":"Business Unit Name",
            "nullable":true,
            "x-queryable":false
        },
        "CompetencyId":{
            "type":"integer",
            "description":"Unique identifier for the competency.",
            "nullable":true,
            "x-queryable":false
        },
        "DepartmentId":{
            "title":"Department Identifier",
            "type":"integer",
            "description":"Unique identifier for the department.",
            "nullable":true,
            "x-queryable":false
        },
        "DepartmentName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the schedule department.",
            "nullable":true,
            "x-queryable":false
        },
        "EndAfterMidnightFlag":{
            "type":"boolean",
            "description":"Indicates whether the workload plan ends after midnight.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "maxLength":80,
            "type":"string",
            "description":"End Time",
            "nullable":true,
            "x-queryable":false
        },
        "FridayIncludedFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Friday is selected for the workload plan.",
            "nullable":true,
            "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
        },
        "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
        },
        "JobFamilyId":{
            "type":"integer",
            "description":"Unique identifier for the job family.",
            "nullable":true,
            "x-queryable":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
        },
        "JobId":{
            "type":"integer",
            "description":"Unique identifier for the job.",
            "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
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":80,
            "type":"string",
            "description":"Location Code",
            "nullable":true,
            "x-queryable":false
        },
        "LocationId":{
            "title":"Workload Location Identifier",
            "type":"integer",
            "description":"Unique identifier for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSetCode":{
            "title":"Location Set Code",
            "maxLength":80,
            "type":"string",
            "description":"Location Set Code",
            "nullable":true,
            "x-queryable":false
        },
        "MondayIncludedFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Mondays is selected for the workload plan.",
            "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
        },
        "OtherQualificationId":{
            "type":"integer",
            "description":"Unique identifier for the other qualification.",
            "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
        },
        "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
        },
        "PositionId":{
            "type":"integer",
            "description":"Unique identifier for the position.",
            "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
        },
        "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
        },
        "ShiftId":{
            "type":"integer",
            "description":"Unique identifier for the shift.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShiftName":{
            "title":"Shift Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the workforce scheduling shift.",
            "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
        },
        "ShiftTypeExtendedCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code used to describe the shift type.",
            "nullable":true,
            "x-queryable":false
        },
        "ShiftTypeExtendedCodeName":{
            "title":"Shift Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the shift type.",
            "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
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":80,
            "type":"string",
            "description":"Start Time",
            "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
        },
        "ThursdayIncludedFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Thursday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "TuesdayIncludedFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Tuesday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "WednesdayIncludedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether Wednesday is selected for the workload plan.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkloadImportTag":{
            "title":"Import Tag",
            "maxLength":30,
            "type":"string",
            "description":"Tag used to uniquely identify the workload import.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkloadMode":{
            "maxLength":1,
            "type":"string",
            "description":"Type of workload import, such as Shift or Time.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkloadPlanCode":{
            "title":"Workload Plan Code",
            "maxLength":30,
            "type":"string",
            "description":"Workload Plan Code",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "WorkloadType":{
            "title":"Workload Type",
            "maxLength":30,
            "type":"string",
            "description":"Workload Type",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkloadUOM":{
            "title":"Workload UOM Code",
            "maxLength":30,
            "type":"string",
            "description":"UOM Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkloadValue":{
            "title":"Workload Value",
            "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"
            }
        }
    }
}

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