Jump to

• Request
• Response

Create a staffing volume

post

/hcmRestApi/resources/11.13.18.05/staffingVolumes

Request

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.
• Upsert-Mode: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DepartmentId: integer
  Unique identifier for the department.
• DepartmentName: string
  Maximum Length: 80

  Name of the department.
• EndAfterMidnightFlag: boolean
  Maximum Length: 80

  Indicates whether the end time is after midnight.
• EndDate: string (date)
  End date for the staffing volume.
• EndTime: string
  Maximum Length: 80

  End time for the staffing volume.
• ImportTag: string
  Maximum Length: 30

  Tag used to identify the volume file import.
• LocationCode: string
  Maximum Length: 80

  Code for the location.
• LocationId: integer
  Unique identifier for the location.
• LocationSetCode: string
  Maximum Length: 80

  Code for the location set.
• StaffingVolumeCode: string
  Maximum Length: 30

  Code for the staffing volume.
• StaffingVolumeId: integer (int64)
  Unique identifier for the staffing volume.
• StartDate: string (date)
  Start date for the staffing volume range.
• StartTime: string
  Maximum Length: 80

  Start time for the staffing volume.
• VolumeType: string
  Maximum Length: 30

  Type for the staffing volume.
• VolumeValue: number
  Value for the staffing volume.

{
    "type":"object",
    "properties":{
        "DepartmentId":{
            "type":"integer",
            "description":"Unique identifier for the department.",
            "nullable":true,
            "x-queryable":false
        },
        "DepartmentName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the department.",
            "nullable":true,
            "x-queryable":false
        },
        "EndAfterMidnightFlag":{
            "maxLength":80,
            "type":"boolean",
            "description":"Indicates whether the end time is after midnight.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the staffing volume.",
            "format":"date",
            "nullable":false
        },
        "EndTime":{
            "maxLength":80,
            "type":"string",
            "description":"End time for the staffing volume.",
            "nullable":true,
            "x-queryable":false
        },
        "ImportTag":{
            "maxLength":30,
            "type":"string",
            "description":"Tag used to identify the volume file import.",
            "nullable":true
        },
        "LocationCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSetCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code for the location set.",
            "nullable":true,
            "x-queryable":false
        },
        "StaffingVolumeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the staffing volume.",
            "nullable":false
        },
        "StaffingVolumeId":{
            "type":"integer",
            "description":"Unique identifier for the staffing volume.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the staffing volume range.",
            "format":"date",
            "nullable":false
        },
        "StartTime":{
            "maxLength":80,
            "type":"string",
            "description":"Start time for the staffing volume.",
            "nullable":true,
            "x-queryable":false
        },
        "VolumeType":{
            "maxLength":30,
            "type":"string",
            "description":"Type for the staffing volume.",
            "nullable":false
        },
        "VolumeValue":{
            "type":"number",
            "description":"Value for the staffing volume.",
            "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 : staffingVolumes-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who created the staffing volume.
• CreationDate: string (date-time)
  Read Only: true

  Date the staffing volume was created.
• DepartmentId: integer
  Unique identifier for the department.
• DepartmentName: string
  Maximum Length: 80

  Name of the department.
• EndAfterMidnightFlag: boolean
  Maximum Length: 80

  Indicates whether the end time is after midnight.
• EndDate: string (date)
  End date for the staffing volume.
• EndTime: string
  Maximum Length: 80

  End time for the staffing volume.
• ImportTag: string
  Maximum Length: 30

  Tag used to identify the volume file import.
• IsConsolidatedFlag: boolean
  Read Only: true

  Maximum Length: 80

  Indicates whether the staffing volume is consolidated.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the staffing volume was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who most recently updated the staffing volume.
• links: array Links
  Title: Links

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

  Code for the location.
• LocationId: integer
  Unique identifier for the location.
• LocationSetCode: string
  Maximum Length: 80

  Code for the location set.
• StaffingVolumeCode: string
  Maximum Length: 30

  Code for the staffing volume.
• StaffingVolumeId: integer (int64)
  Unique identifier for the staffing volume.
• StartDate: string (date)
  Start date for the staffing volume range.
• StartTime: string
  Maximum Length: 80

  Start time for the staffing volume.
• VolumeType: string
  Maximum Length: 30

  Type for the staffing volume.
• VolumeValue: number
  Value for the staffing volume.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who created the staffing volume.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the staffing volume was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "type":"integer",
            "description":"Unique identifier for the department.",
            "nullable":true,
            "x-queryable":false
        },
        "DepartmentName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the department.",
            "nullable":true,
            "x-queryable":false
        },
        "EndAfterMidnightFlag":{
            "maxLength":80,
            "type":"boolean",
            "description":"Indicates whether the end time is after midnight.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the staffing volume.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EndTime":{
            "maxLength":80,
            "type":"string",
            "description":"End time for the staffing volume.",
            "nullable":true,
            "x-queryable":false
        },
        "ImportTag":{
            "maxLength":30,
            "type":"string",
            "description":"Tag used to identify the volume file import.",
            "nullable":true,
            "x-queryable":true
        },
        "IsConsolidatedFlag":{
            "maxLength":80,
            "type":"boolean",
            "description":"Indicates whether the staffing volume is consolidated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the staffing volume was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who most recently updated the staffing volume.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LocationCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationSetCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code for the location set.",
            "nullable":true,
            "x-queryable":false
        },
        "StaffingVolumeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the staffing volume.",
            "nullable":false,
            "x-queryable":true
        },
        "StaffingVolumeId":{
            "type":"integer",
            "description":"Unique identifier for the staffing volume.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the staffing volume range.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StartTime":{
            "maxLength":80,
            "type":"string",
            "description":"Start time for the staffing volume.",
            "nullable":true,
            "x-queryable":false
        },
        "VolumeType":{
            "maxLength":30,
            "type":"string",
            "description":"Type for the staffing volume.",
            "nullable":false,
            "x-queryable":true
        },
        "VolumeValue":{
            "type":"number",
            "description":"Value for the staffing volume.",
            "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