Create a new business-structure-path
Creates one or more business structure paths and returns the new ID and details.
Helpful resources
Required Scopes
- business-structure-paths.read-write
Request
- application/json
Body
The Job Code to place at this Business Structure path.
Id of the parent BusinessStructurePath. None for root path.
Responses​
- 200
- application/json
- Schema
- Example (from schema)
Schema
Identifier field
Record creation date
Record update date
Name of the path (e.g. 'SF Office > Coffee > Barista').
Id of the parent BusinessStructurePath. None for root path.
parent object
Ordered list of Job code IDs from top to bottom.
job_codes object[]
Identifier field
Record creation date
Record update date
The name of the job dimension.
The ID of the job dimension this job code belongs to.
job_dimension object
Identifier field
Record creation date
Record update date
The name of the job dimension
The unique identifier of the job dimension in a third party system
Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.
The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.
The ID of the dimension roster group.
Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.
The unique identifier of the job code in an outside system.
The ID of the job roster group.
custom_location object
address objectrequired
The classification of the address.
The formatted mailing address.
The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..
The city or locality component.
The state or region component, pursuant to SCIM RFC 7643 4.1.2.
The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
The country component, pursuant to SCIM RFC 7643 4.1.2.
The work location associated with the job code.
work_location object
Identifier field
Record creation date
Record update date
The name of the work location.
address objectrequired
The classification of the address.
The formatted mailing address.
The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..
The city or locality component.
The state or region component, pursuant to SCIM RFC 7643 4.1.2.
The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
The country component, pursuant to SCIM RFC 7643 4.1.2.
The department associated with the job code.
department object
Identifier field
Record creation date
Record update date
The name of the department.
The parent department.
parent object
Reference code of the department.
The identifier of departments in the department hierarchy ordered from parent department to child department.
List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.
Expandable field
The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
Pay rate overrides id for the job based on exception dimension values.
pay_rate_exceptions object[]
Identifier field
Record creation date
Record update date
Identifier of Job for which exception is configured.
job_code object
Type of dimension on which exception is configured
Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource
The pay rate for exception on job_code_id and exception_dimension_id combination
Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
{
"id": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"parent_id": "string",
"parent": {},
"job_codes_id": [
"string"
],
"job_codes": [
{
"id": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"job_dimension_id": "string",
"job_dimension": {
"id": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"external_id": "string",
"includes_custom_location": false,
"roster_type": "PER_DIMENSION",
"group_id": "string",
"org_attribute_associations": [
"DEPARTMENT"
]
},
"external_id": "string",
"group_id": "string",
"custom_location": {
"address": {
"type": "HOME",
"formatted": "string",
"street_address": "string",
"locality": "string",
"region": "string",
"postal_code": "string",
"country": "AF"
}
},
"work_location_id": "string",
"work_location": {
"id": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"address": {
"type": "HOME",
"formatted": "string",
"street_address": "string",
"locality": "string",
"region": "string",
"postal_code": "string",
"country": "AF"
}
},
"department_id": "string",
"department": {
"id": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"parent_id": "string",
"parent": {},
"reference_code": "string",
"department_hierarchy_id": [
"string"
],
"department_hierarchy": [
"string"
]
},
"pay_rate": 0,
"pay_rate_exceptions_id": [
"string"
],
"pay_rate_exceptions": [
{
"id": "string",
"created_at": "string",
"updated_at": "string",
"job_code_id": "string",
"job_code": {},
"exception_dimension_type": "JOB_CODE",
"exception_dimension_id": "string",
"pay_rate": 0
}
],
"is_archived": false
}
]
}