Job

Manage jobs, which represent roles or positions within an office or project.
You can create, update, delete, and search for jobs with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/job/index

Returns a paginated and filterable list of jobs.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching jobs

object

filter

object

office_job_id

ID of the office job (primary key)

string format: uuid

office_id

ID of the office

string format: uuid

code

Code associated with the office job

string

nullable

name

Name of the office job

string

description

Description of the office job

string

nullable

project_id

ID of the project associated with the office job

string format: uuid

office_name

Name of the office

string

project_name

Name of the project

string

project_type

Type of the project

string

owned_active

Indicates if the job is owned and active

boolean

parent_active

Indicates if the parent job is active

boolean

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "name": "Engineer",
    "office_id": "off-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of jobs

Array<object>

object

office_job_id

ID of the office job (primary key)

string format: uuid

office_id

ID of the office

string format: uuid

code

Code associated with the office job

string

nullable

name

Name of the office job

string

description

Description of the office job

string

nullable

project_id

ID of the project associated with the office job

string format: uuid

office_name

Name of the office

string

project_name

Name of the project

string

project_type

Type of the project

string

owned_active

Indicates if the job is owned and active

boolean

parent_active

Indicates if the parent job is active

boolean

Example

{
  "office_job_id": "job-1",
  "office_id": "off-1",
  "code": "ENG-001",
  "name": "Engineer",
  "description": "Responsible for technical tasks",
  "project_id": "proj-1"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/job/view/{id}

Retrieve a job by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the job to retrieve

Responses

200

Job found

object

office_job_id

ID of the office job (primary key)

string format: uuid

office_id

ID of the office

string format: uuid

code

Code associated with the office job

string

nullable

name

Name of the office job

string

description

Description of the office job

string

nullable

project_id

ID of the project associated with the office job

string format: uuid

office_name

Name of the office

string

project_name

Name of the project

string

project_type

Type of the project

string

owned_active

Indicates if the job is owned and active

boolean

parent_active

Indicates if the parent job is active

boolean

Example

{
  "office_job_id": "job-1",
  "office_id": "off-1",
  "code": "ENG-001",
  "name": "Engineer",
  "description": "Responsible for technical tasks",
  "project_id": "proj-1"
}

404

Job not found