Jump to

• Request
• Response

Get a single staffing grid

get

/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : staffingGrids-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the staffing grid.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the staffing grid was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Staffing grid creator.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffingContextCode":{
            "title":"Staffing Context Code",
            "maxLength":"80",
            "type":"string",
            "description":"Context code that identifies the dimensions of the staffing plan grid.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VolumeCapacityMaximum":{
            "title":"Maximum Volume Capacity",
            "type":"integer",
            "description":"Maximum capacity in volume for the department and location.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "StaffGridStatusCode":{
            "title":"Deployment Status",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the processing status of the staffing plan grid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalSegments":{
            "title":"Total Segments",
            "type":"integer",
            "description":"Total number of segments in the staffing grid.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "JobProfileType":{
            "title":"Job Profile Type",
            "maxLength":"80",
            "type":"string",
            "description":"Code for the job profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RangeIncrements":{
            "title":"Range Increments",
            "type":"integer",
            "description":"Increment value used to decide staffing grid ranges.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "StaffingGridId":{
            "title":"Staffing Grid ID",
            "type":"integer",
            "description":"Unique identifier for the staffing grid.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StaffGridValuesRestMaster":{
            "title":"Staffing Grid Values",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/staffingGrids-StaffGridValuesRestMaster-item-response"
            }
        },
        "DescriptiveFlexfieldCode":{
            "title":"Descriptive Flexfield Code",
            "maxLength":"40",
            "type":"string",
            "description":"Code identifying the descriptive flexfield used in the staffing grids.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ShiftTypeId":{
            "title":"Shift Type ID",
            "type":"integer",
            "description":"Unique identifier for the shift type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StaffingGridCode":{
            "maxLength":"280",
            "type":"string",
            "description":"Code identifying the staffing grid.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the staffing grid was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : 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

• Array of: object staffingGrids-StaffGridValuesRestMaster-item-response

{
    "title":"Staffing Grid Values",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/staffingGrids-StaffGridValuesRestMaster-item-response"
    }
}

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."
        }
    }
}

Nested Schema : staffingGrids-StaffGridValuesRestMaster-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who last updated the staffing grid values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the staffing grid value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Qualification",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the content item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContentTypeId",
                    "ContentTypeName"
                ]
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Staffing grid value creator.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTimeOffset":{
            "title":"Start Time Offset",
            "type":"integer",
            "description":"Start time for the grid staffing requirement with time zone offset, for example, -360.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "JobProfileType":{
            "title":"Job Profile Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type for the job profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContentTypeId":{
            "title":"Competency Type ID",
            "type":"integer",
            "description":"Unique identifier for the content type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartTime":{
            "title":"Start Time",
            "maxLength":"10",
            "type":"string",
            "description":"Start time for the grid staffing requirement.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentTypeName":{
            "title":"Competency Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the content type.",
            "nullable":true,
            "x-queryable":false
        },
        "GridValueId":{
            "title":"Grid Value ID",
            "type":"integer",
            "description":"Unique identifier for the grid value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StaffingGridId":{
            "title":"Staffing Grid ID",
            "type":"integer",
            "description":"Unique identifier for the staffing grid.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the staffing plan grid is deleted.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "title":"Content Item ID",
            "type":"integer",
            "description":"Unique identifier for the content item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "ContentTypeId"
                ]
            },
            "x-queryable":true
        },
        "StaffingPlanSkillId":{
            "title":"Staff Plan Skill ID",
            "type":"integer",
            "description":"Unique identifier for the staffing plan skill.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "StaffingGridId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SkillId":{
            "title":"Schedule Skill Identifier",
            "type":"integer",
            "description":"Unique identifier for the skill.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StopTimeOffset":{
            "title":"End Time Offset",
            "type":"integer",
            "description":"End time for the grid staffing requirement with time zone offset, for example, -360.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ShiftTypeId":{
            "title":"Shift Type ID",
            "type":"integer",
            "description":"Unique identifier for the shift type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobProfileName":{
            "title":"Job Profile Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the job profile.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the staffing grid value was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StopTime":{
            "title":"End Time",
            "maxLength":"10",
            "type":"string",
            "description":"End time for the grid staffing requirement.",
            "nullable":true,
            "x-queryable":false
        },
        "StaffGridValuesRestDFFVL":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/staffingGrids-StaffGridValuesRestMaster-StaffGridValuesRestDFFVL-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

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 : StaffGridValuesRestDFFVL

Type: array

Show Source

• Array of: object staffingGrids-StaffGridValuesRestMaster-StaffGridValuesRestDFFVL-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/staffingGrids-StaffGridValuesRestMaster-StaffGridValuesRestDFFVL-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : staffingGrids-StaffGridValuesRestMaster-StaffGridValuesRestDFFVL-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "GridValueId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

StaffGridValuesRestMaster

Operation: /hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster

Parameters:

• 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.

Back to Top