Positions

Get a Position

Securityauth

Request

path Parameters

required

string

header Parameters

X-Enterprise-Id

required

string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/positions/{id}

Request samples

curl
JavaScript
Python
Java

Update a Position

Securityauth

Request

path Parameters

required

string

header Parameters

X-Enterprise-Id

required

string

Request Body schema: application/json
required

id	string
enterpriseId required	string
title required	string
description	string
	object (SkillWithRequirement-2)
	object
lastUpdatedDate	string
status	string
originalId	string
country required	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/positions/{id}

Request samples

Payload
curl
JavaScript
Python
Java

application/json

{"id": "string",
"enterpriseId": "string",
"title": "string",
"description": "string",
"skills": {"id": "5ab87a70c905f00a7145c59e",
"title": "Software Development",
"requirement": "required",
"level": "experienced",
"weight": 1
},
"entity": {"id": "string",
"title": "string"
},
"lastUpdatedDate": "string",
"status": "string",
"originalId": "string",
"country": "string"
}

Patch a Position

Securityauth

Request

path Parameters

required

string

header Parameters

X-Enterprise-Id

required

string

Request Body schema: application/json
required

Array

op	string Use enum values to specify patch operation Enum: "add" "remove" "replace"
path	string
value	string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/positions/{id}

Request samples

Payload
curl
JavaScript
Python
Java

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Delete a Position

Securityauth

Request

path Parameters

required

string

header Parameters

X-Enterprise-Id

required

string

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/positions/{id}

Request samples

curl
JavaScript
Python
Java

Create a New Position

Securityauth

Request

header Parameters

X-Enterprise-Id

required

string

Request Body schema: application/json
required

id	string
enterpriseId required	string
title required	string
description	string
	object (SkillWithRequirement-2)
	object
lastUpdatedDate	string
status	string
originalId	string
country required	string

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/positions/create

Request samples

Payload
curl
JavaScript
Python
Java

application/json

{"id": "string",
"enterpriseId": "string",
"title": "string",
"description": "string",
"skills": {"id": "5ab87a70c905f00a7145c59e",
"title": "Software Development",
"requirement": "required",
"level": "experienced",
"weight": 1
},
"entity": {"id": "string",
"title": "string"
},
"lastUpdatedDate": "string",
"status": "string",
"originalId": "string",
"country": "string"
}

Retrieve All Positions For Enterprise

Securityauth

Request

query Parameters

page	integer <int32> Default: 0
resultsPerPage	integer <int32> Default: 20

header Parameters

X-Enterprise-Id

required

string

Retrieve All Positions For Enterprise

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/positions

Request samples

curl
JavaScript
Python
Java

Search Positions

Securityauth

Request

header Parameters

X-Enterprise-Id

required

string

Request Body schema: application/json
required

resultsPerPage	integer <int32> Default: 10 Specifies the number of results to be returned
page	integer <int32> Default: 0 Specifies the page number
minMatchPercentage	number Default: 20 Minimum match percentage
includeExternal	boolean Default: false Include external positions as well in search
	Array of objects (SkillWithRequirement-2) Skills that are needed to be searched for
title	string Exact clustered Position Titles to search for the Positions
country	string Exact clustered Position Country to search for the Positions
status	string Default: "active" Status values to search for in Positions Enum: "active" "archived"
lastUpdatedDate	string <date-time> Position that are posted/update
	object (SearchConfig-4) Configurations to tune search parameters

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/positions/search

Request samples

Payload
curl
JavaScript
Python
Java

application/json

{"resultsPerPage": 10,
"page": 0,
"minMatchPercentage": 20,
"includeExternal": false,
"skills": [{"id": "5ab87a70c905f00a7145c59e",
"title": "Software Development",
"requirement": "required",
"level": "experienced",
"weight": 1
}
],
"title": "string",
"country": "string",
"status": "active",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"config": {"title": true,
"location": true,
"skills": true,
"tags": true,
"visibility": true,
"nullOrEmptySkills": true,
"algorithm": "default",
"expiryDate": true,
"excludeSponsorship": false,
"qualityParams": {"location": false
}
}
}

Search Position By Employee ID

Securityauth

Request

path Parameters

required

string

header Parameters

X-Enterprise-Id

required

string

Request Body schema: application/json
required

resultsPerPage	integer <int32> Default: 10 Specifies the number of results to be returned
page	integer <int32> Default: 0 Specifies the page number
minMatchPercentage	number Default: 20 Minimum match percentage
includeExternal	boolean Default: false Include external positions as well in search
	Array of objects (SkillWithRequirement-2) Skills that are needed to be searched for
title	string Exact clustered Position Titles to search for the Positions
country	string Exact clustered Position Country to search for the Positions
status	string Default: "active" Status values to search for in Positions Enum: "active" "archived"
lastUpdatedDate	string <date-time> Position that are posted/update
	object (SearchConfig-4) Configurations to tune search parameters

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/positions/search/{id}

Request samples

Payload
curl
JavaScript
Python
Java

application/json

{"resultsPerPage": 10,
"page": 0,
"minMatchPercentage": 20,
"includeExternal": false,
"skills": [{"id": "5ab87a70c905f00a7145c59e",
"title": "Software Development",
"requirement": "required",
"level": "experienced",
"weight": 1
}
],
"title": "string",
"country": "string",
"status": "active",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"config": {"title": true,
"location": true,
"skills": true,
"tags": true,
"visibility": true,
"nullOrEmptySkills": true,
"algorithm": "default",
"expiryDate": true,
"excludeSponsorship": false,
"qualityParams": {"location": false
}
}
}

Match Position To Job Title

Securityauth

Request

path Parameters

posId required	string
jobTitleId required	string

query Parameters

algorithm	string Default: "default" Enum: "default" "basic" "weighted"
verbose	boolean <int32> Default: false

header Parameters

X-Enterprise-Id

required

string

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/positions/{posId}/jobTitle/{jobTitleId}

Request samples

curl
JavaScript
Python
Java

➔ Next to Trainings

Positions

Get a Position

path Parameters

header Parameters

Update a Position

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Patch a Position

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Delete a Position

path Parameters

header Parameters

Create a New Position

header Parameters

Request Body schema: application/jsonrequired

Retrieve All Positions For Enterprise

query Parameters

header Parameters

Search Positions

header Parameters

Request Body schema: application/jsonrequired

Search Position By Employee ID

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Match Position To Job Title

path Parameters

query Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required