Create staffing grids for the staffing plan
post
/hcmRestApi/resources/11.13.18.05/staffingGrids
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
StaffGridValuesRestMaster: array
Staffing Grid Values
Title:
Staffing Grid Values
The staffingGridValues resource provides information about the specified staffing grid requirement values. This resource also lets people with appropriate job roles create, update, and delete staffing grid values. -
StaffingGridCode(required): string
Maximum Length:
280
Code identifying the staffing grid. -
StaffingGridId: integer
(int64)
Title:
Staffing Grid ID
Unique identifier for the staffing grid.
Nested Schema : Staffing Grid Values
Type:
array
Title:
Staffing Grid Values
The staffingGridValues resource provides information about the specified staffing grid requirement values. This resource also lets people with appropriate job roles create, update, and delete staffing grid values.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ContentItemId: integer
(int64)
Title:
Content Item ID
Unique identifier for the content item. -
ContentItemName: string
Title:
Qualification
Maximum Length:80
Name of the content item. -
ContentTypeId: integer
Title:
Competency Type ID
Unique identifier for the content type. -
ContentTypeName: string
Title:
Competency Type Name
Maximum Length:80
Name of the content type. -
DeleteFlag: boolean
Maximum Length:
1
Indicates whether the staffing plan grid is deleted. -
GridValueId: integer
(int64)
Title:
Grid Value ID
Unique identifier for the grid value. -
JobProfileName: string
Title:
Job Profile Name
Maximum Length:80
Name of the job profile. -
StaffGridValuesRestDFFVL: array
StaffGridValuesRestDFFVL
-
StaffingPlanSkillId(required): integer
(int64)
Title:
Staff Plan Skill ID
Unique identifier for the staffing plan skill. -
StartTime: string
Title:
Start Time
Maximum Length:10
Start time for the grid staffing requirement. -
StartTimeOffset: integer
(int32)
Title:
Start Time Offset
Start time for the grid staffing requirement with time zone offset, for example, -360. -
StopTime: string
Title:
End Time
Maximum Length:10
End time for the grid staffing requirement. -
StopTimeOffset: integer
(int32)
Title:
End Time Offset
End time for the grid staffing requirement with time zone offset, for example, -360.
Nested Schema : staffingGrids-StaffGridValuesRestMaster-StaffGridValuesRestDFFVL-item-post-request
Type:
Show Source
object
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
GridValueId: integer
(int64)
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.
Root Schema : staffingGrids-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Staffing grid creator. -
CreationDate: string
(date-time)
Read Only:
true
Date when the staffing grid was created. -
DescriptiveFlexfieldCode: string
Title:
Descriptive Flexfield Code
Read Only:true
Maximum Length:40
Code identifying the descriptive flexfield used in the staffing grids. -
JobProfileType: string
Title:
Job Profile Type
Read Only:true
Maximum Length:80
Code for the job profile. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the staffing grid was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the staffing grid. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RangeIncrements: integer
(int32)
Title:
Range Increments
Read Only:true
Increment value used to decide staffing grid ranges. -
ShiftTypeId: integer
Title:
Shift Type ID
Read Only:true
Unique identifier for the shift type. -
StaffGridStatusCode: string
Title:
Deployment Status
Read Only:true
Maximum Length:30
Code for the processing status of the staffing plan grid. -
StaffGridValuesRestMaster: array
Staffing Grid Values
Title:
Staffing Grid Values
The staffingGridValues resource provides information about the specified staffing grid requirement values. This resource also lets people with appropriate job roles create, update, and delete staffing grid values. -
StaffingContextCode: string
Title:
Staffing Context Code
Read Only:true
Maximum Length:80
Context code that identifies the dimensions of the staffing plan grid. -
StaffingGridCode: string
Maximum Length:
280
Code identifying the staffing grid. -
StaffingGridId: integer
(int64)
Title:
Staffing Grid ID
Unique identifier for the staffing grid. -
TotalSegments: integer
(int32)
Title:
Total Segments
Read Only:true
Total number of segments in the staffing grid. -
VolumeCapacityMaximum: integer
(int32)
Title:
Maximum Volume Capacity
Read Only:true
Maximum capacity in volume for the department and location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Staffing Grid Values
Type:
array
Title:
Staffing Grid Values
The staffingGridValues resource provides information about the specified staffing grid requirement values. This resource also lets people with appropriate job roles create, update, and delete staffing grid values.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : staffingGrids-StaffGridValuesRestMaster-item-response
Type:
Show Source
object
-
ContentItemId: integer
(int64)
Title:
Content Item ID
Unique identifier for the content item. -
ContentItemName: string
Title:
Qualification
Maximum Length:80
Name of the content item. -
ContentTypeId: integer
Title:
Competency Type ID
Unique identifier for the content type. -
ContentTypeName: string
Title:
Competency Type Name
Maximum Length:80
Name of the content type. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Staffing grid value creator. -
CreationDate: string
(date-time)
Read Only:
true
Date when the staffing grid value was created. -
DeleteFlag: boolean
Maximum Length:
1
Indicates whether the staffing plan grid is deleted. -
GridValueId: integer
(int64)
Title:
Grid Value ID
Unique identifier for the grid value. -
JobProfileName: string
Title:
Job Profile Name
Maximum Length:80
Name of the job profile. -
JobProfileType: string
Title:
Job Profile Type
Read Only:true
Maximum Length:80
Type for the job profile. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the staffing grid value was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the staffing grid values. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ShiftTypeId: integer
(int64)
Title:
Shift Type ID
Read Only:true
Unique identifier for the shift type. -
SkillId: integer
(int64)
Title:
Schedule Skill Identifier
Read Only:true
Unique identifier for the skill. -
StaffGridValuesRestDFFVL: array
StaffGridValuesRestDFFVL
-
StaffingGridId: integer
(int64)
Title:
Staffing Grid ID
Read Only:true
Unique identifier for the staffing grid. -
StaffingPlanSkillId: integer
(int64)
Title:
Staff Plan Skill ID
Unique identifier for the staffing plan skill. -
StartTime: string
Title:
Start Time
Maximum Length:10
Start time for the grid staffing requirement. -
StartTimeOffset: integer
(int32)
Title:
Start Time Offset
Start time for the grid staffing requirement with time zone offset, for example, -360. -
StopTime: string
Title:
End Time
Maximum Length:10
End time for the grid staffing requirement. -
StopTimeOffset: integer
(int32)
Title:
End Time Offset
End time for the grid staffing requirement with time zone offset, for example, -360.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : staffingGrids-StaffGridValuesRestMaster-StaffGridValuesRestDFFVL-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Read Only:true
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
GridValueId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- StaffGridValuesRestMaster
-
Operation: /hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMasterParameters:
- StaffingGridId:
$request.path.StaffingGridId
The staffingGridValues resource provides information about the specified staffing grid requirement values. This resource also lets people with appropriate job roles create, update, and delete staffing grid values. - StaffingGridId: