Job Repository Details

get
Job Repository details

https://apigateway.boost.rs/job-repositories/:id
This endpoint retrieves job repository details.
Request
Response
Request
Path Parameters
id
required
integer
The ID of the job repository to get details for.
Headers
Authorization
required
integer
Authorisation token received from oAuth API Bearer :token
Response
200: OK
Job Repository details successfully retrieved.
{
"success": true,
"message": "",
"result": {
"id": 1,
"name": "Main Repository",
"description": null,
"external_id": null,
"status": "active",
"categories_count": 21,
"has_categories": true,
"translations": {
"en": {
"name": "Main Repository",
"description": null
},
"fr": {
"name": "Referentiel principal",
"description": null
}
}
}
}
404: Not Found
The provided job repository was not found in the database.
{
"message": "Resource not found",
"success": false,
"result": null
}

Response fields

Field name

Description

id

Repository ID

name

Repository title

description

Repository description

external_id

Alphanumeric value (optional) which can be set by the client for external cross-referencing purposes.

status

Job status. Available values:

active - the repository is ready for use (completed)

draft - the repository content might not be the final (it might not be ready for use)

categories_count

The number of child categories that exist in the current repository

has_categories

Boolean value.

true - the repository contains child categories

false - the repository is empty

translations

Group of fields containing the available translations (per language) for the repository title and description, if available.

Translation fields: en, fr - language codes name - repository title description - repository description