competence

Get Many Competences

Get Many Competences

Securitybearer
Request
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
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/competence
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
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": { }
}

Create One Competence

Create One Competence

Securitybearer
Request
Request Body schema: application/json
required
companyId
required
string
type
required
string
name
required
string
description
string
object (CreateScopeRequest)
isRequired
boolean
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/competence
Request samples
application/json
{
  • "companyId": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "isRequired": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Competence

Get One Competence

Securitybearer
Request
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
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/competence/{id}
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
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}

Update One Competence

Update One Competence

Securitybearer
Request
path Parameters
id
required
string

Resource Id

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

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/competence/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "isRequired": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Competence

Replace One Competence

Securitybearer
Request
path Parameters
id
required
string

Resource Id

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

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/competence/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": {
    },
  • "isRequired": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Competence

Delete One Competence

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/competence/{id}
Request samples 
curl --request DELETE \
  --url https://api.alexishr.com/v1/competence/507f1f77bcf86cd799439011 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to competence-level