Position skills

A position-skill object contains the name and description of a position and skill level that can be assigned to employees for project planning.

List position skills

get/objects/projects/position-skill

Returns a collection with a key, ID, and link for each position skill.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
null
Create a position skill
post/objects/projects/position-skill
Creates a new position skill.


SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string
Name of the position skill.


 
 Example:  null
description
string
Description.


 
 Example:  null
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
null
Get a position skill
get/objects/projects/position-skill/{key}
Returns detailed information for a particular position skill.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the position skill.


 
 Example:  44
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
null
Update a position skill
patch/objects/projects/position-skill/{key}
Updates an existing position skill by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the position skill.


 
 Example:  44
Request Body schema: application/json
description
string
Description.


 
 Example:  null
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
null
Delete a position skill
delete/objects/projects/position-skill/{key}
Deletes a position skill.


SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the position skill.


 
 Example:  44
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query position skills
post/services/core/query
Use the query service to find position skills that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}