competence

Get Many Competences

Get Many Competences

Authorizations:
bearer
query Parameters
select
Array of strings

Select Competence fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "type" "name" "description" "scopeId" "isRequired"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Competences. (e.g. limit=20)

offset
integer

Offset amount of received Competences. (e.g. offset=20)

object

Sort received Competences by field. (e.g. sort[id]=asc)

Responses

Request samples 

curl --request GET \
  --url 'https://api.alexishr.com/v1/competence?select=SOME_ARRAY_VALUE&filters=SOME_OBJECT_VALUE&limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&sort=SOME_OBJECT_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": { }
}

Create One Competence

Create One Competence

Authorizations:
bearer
Request Body schema: application/json
companyId
required
string
type
required
string
name
required
string
description
string
object (CreateScopeRequest)
isRequired
boolean

Responses

Request samples 

curl --request POST \
  --url https://api.alexishr.com/v1/competence \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"companyId":"string","type":"string","name":"string","description":"string","scope":{"companyId":"5beadbdb01da0a0028a66e99","parentId":"507f1f77bcf86cd799439011","parentType":"DocumentFOlder","namespace":{"entity":"DocumentFolder","key":null},"excludeEmployeeScope":"[]","employeeScope":"[]","officeScope":"[]","groupScope":"[]","organizationScope":"[]","employmentTypeScope":"[]","entireCompany":true,"teamScope":"[]","filters":"[]","static":true},"isRequired":true}'

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Competence

Get One Competence

Authorizations:
bearer
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Competence fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "type" "name" "description" "scopeId" "isRequired"

Responses

Request samples 

curl --request GET \
  --url 'https://api.alexishr.com/v1/competence/507f1f77bcf86cd799439011?select=SOME_ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}

Update One Competence

Update One Competence

Authorizations:
bearer
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
name
string
description
string
object (UpdateScopeRequest)
isRequired
boolean

Responses

Request samples 

curl --request PATCH \
  --url https://api.alexishr.com/v1/competence/507f1f77bcf86cd799439011 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","description":"string","scope":{"excludeEmployeeScope":"[]","employeeScope":"[]","officeScope":"[]","groupScope":"[]","organizationScope":"[]","employmentTypeScope":"[]","entireCompany":true,"teamScope":"[]","filters":"[]","static":true},"isRequired":true}'

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Competence

Replace One Competence

Authorizations:
bearer
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
name
string
description
string
object (UpdateScopeRequest)
isRequired
boolean

Responses

Request samples 

curl --request PUT \
  --url https://api.alexishr.com/v1/competence/507f1f77bcf86cd799439011 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","description":"string","scope":{"excludeEmployeeScope":"[]","employeeScope":"[]","officeScope":"[]","groupScope":"[]","organizationScope":"[]","employmentTypeScope":"[]","entireCompany":true,"teamScope":"[]","filters":"[]","static":true},"isRequired":true}'

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Competence

Delete One Competence

Authorizations:
bearer
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011

Responses

Request samples 

curl --request DELETE \
  --url https://api.alexishr.com/v1/competence/507f1f77bcf86cd799439011 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to competence-level