scope

Get Many Scopes

Get Many Scopes

Securitybearer
Request
query Parameters
select
Array of strings

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

Items Enum: "parentId" "parentType" "excludeEmployeeScope" "employeeScope" "officeScope" "groupScope" "employmentTypeScope" "entireCompany" "teamScope" "organizationScope" "employeeIds" "companyId" "id"
object

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

limit
integer

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

offset
integer

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

object

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

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/scope
Request samples 
curl --request GET \
  --url 'https://api.alexishr.com/v1/scope?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 Scope

Create One Scope

Securitybearer
Request
Request Body schema: application/json
required
companyId
required
string

CompanyId

parentId
required
string

Id of the entity to which the scope refers

parentType
required
string

Model name of the entity to which the scope refers

namespace
required
object

Scope Namespace

excludeEmployeeScope
required
Array of strings

Excluded employee

employeeScope
required
Array of strings

Employee scope

officeScope
required
Array of strings

Office scope

groupScope
required
Array of strings

Group scope

organizationScope
required
Array of strings

Organization scope

employmentTypeScope
required
Array of strings

Employment type scope

entireCompany
required
boolean

Entire company

teamScope
required
Array of strings

Team Scope

filters
Array of strings
static
object
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/scope
Request samples
application/json
{
  • "companyId": "5beadbdb01da0a0028a66e99",
  • "parentId": "507f1f77bcf86cd799439011",
  • "parentType": "DocumentFOlder",
  • "namespace": {
    },
  • "excludeEmployeeScope": "[]",
  • "employeeScope": "[]",
  • "officeScope": "[]",
  • "groupScope": "[]",
  • "organizationScope": "[]",
  • "employmentTypeScope": "[]",
  • "entireCompany": true,
  • "teamScope": "[]",
  • "filters": "[]",
  • "static": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Scope

Get One Scope

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

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

Items Enum: "parentId" "parentType" "excludeEmployeeScope" "employeeScope" "officeScope" "groupScope" "employmentTypeScope" "entireCompany" "teamScope" "organizationScope" "employeeIds" "companyId" "id"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/scope/{id}
Request samples 
curl --request GET \
  --url 'https://api.alexishr.com/v1/scope/507f1f77bcf86cd799439011?select=SOME_ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}

Update One Scope

Update One Scope

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
excludeEmployeeScope
required
Array of strings

Excluded employee

employeeScope
required
Array of strings

Employee scope

officeScope
required
Array of strings

Office scope

groupScope
required
Array of strings

Group scope

organizationScope
required
Array of strings

Organization scope

employmentTypeScope
required
Array of strings

Employment type scope

entireCompany
required
boolean

Entire company

teamScope
required
Array of strings

Team Scope

filters
Array of strings
static
object
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/scope/{id}
Request samples
application/json
{
  • "excludeEmployeeScope": "[]",
  • "employeeScope": "[]",
  • "officeScope": "[]",
  • "groupScope": "[]",
  • "organizationScope": "[]",
  • "employmentTypeScope": "[]",
  • "entireCompany": true,
  • "teamScope": "[]",
  • "filters": "[]",
  • "static": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Scope

Replace One Scope

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
excludeEmployeeScope
required
Array of strings

Excluded employee

employeeScope
required
Array of strings

Employee scope

officeScope
required
Array of strings

Office scope

groupScope
required
Array of strings

Group scope

organizationScope
required
Array of strings

Organization scope

employmentTypeScope
required
Array of strings

Employment type scope

entireCompany
required
boolean

Entire company

teamScope
required
Array of strings

Team Scope

filters
Array of strings
static
object
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/scope/{id}
Request samples
application/json
{
  • "excludeEmployeeScope": "[]",
  • "employeeScope": "[]",
  • "officeScope": "[]",
  • "groupScope": "[]",
  • "organizationScope": "[]",
  • "employmentTypeScope": "[]",
  • "entireCompany": true,
  • "teamScope": "[]",
  • "filters": "[]",
  • "static": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Scope

Delete One Scope

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/scope/{id}
Request samples 
curl --request DELETE \
  --url https://api.alexishr.com/v1/scope/507f1f77bcf86cd799439011 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to competence