Document List

get
Document List

https://apigateway.boost.rs/skillfinder/documents
Request
Response
Request
Headers
Authentication
required
string
Authorisation token received from oAuth API. Bearer :token
Query Parameters
sort_by
optional
string
This parameter is used to sort the results, Default value is 'id'. Below the full list of possible values: id title status provider external_id batch_id
sort
optional
string
Sorting order, can be asc or desc.
offset
optional
integer
This parameter is used to retrieve paginated results. The default setting is 0. For a specific page, set offset to be: (#pageNumber - 1) * :limit
limit
optional
integer
Number of records to return. Default setting is 10 records. Can take values between 1 and 100.
status
optional
string
Filters the list based on the status field. Possible values: active - the processing is complete queued - the document is queued for content processing processing - the content currently is being processed
provider
optional
string
Filter documents by the provider field. The values are the ones used in the batch request for each document.
external_id
optional
string
Filter documents by the external_id field. The values are the ones used in the batch request for each document.
batch_id
optional
integer
Filter based on batch_id. The id is returned after submitting a batch for processing.
Response
200: OK
Document list successfully retrieved.
{
"success": true,
"message": "",
"result": [
{
"id": 1000,
"title": "doc 1",
"status": "active",
"external_id": "XDFT04L-74563",
"provider": "client1",
"batch_id": 111,
"skills": [
{
"id": 11111,
"name": "Incremental development",
"description": "The incremental development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11112,
"name": "Employment law",
"description": "The law which mediates the relationship between employees and employers. It concerns employees' rights at work which are binding by the work contract.",
"score": 0
},
{
"id": 11113,
"name": "Job market offers",
"description": "Job opportunities available on the labour market, depending on the economic field concerned.",
"score": 0
},
{
"id": 11114,
"name": "Web programming",
"description": "The programming paradigm that is based on combining markup (which adds context and structure to text) and other web programming code, such as AJAX, javascript and PHP, in order to carry out appropriate actions and visualise the content.",
"score": 0
},
{
"id": 11115,
"name": "Labour market",
"description": "The trends, functioning, and fluctuations of the labour market, career options, wages, unions, working population and the supply and demand of certain professions in a sector.",
"score": 0
},
{
"id": 11116,
"name": "Prototyping development",
"description": "The prototyping development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11117,
"name": "Facilitate job market access",
"description": "Improve the chances of individuals to find a job, by teaching the required qualifications and interpersonal skills, through training and development programs, workshops or employment projects.",
"score": 0
},
{
"id": 11118,
"name": "Prepare personal work environment",
"description": "Correct settings or positions for your working instruments and adjust them before starting operations.",
"score": 0
},
{
"id": 11118,
"name": "Iterative development",
"description": "The iterative development model is a methodology to design software systems and applications.",
"score": 0
}
]
},
{
"id": 1001,
"title": "doc 2",
"status": "active",
"external_id": "AVG45LIV-31067",
"provider": "client2",
"batch_id": 111,
"skills": [
{
"id": 11111,
"name": "Incremental development",
"description": "The incremental development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11112,
"name": "Employment law",
"description": "The law which mediates the relationship between employees and employers. It concerns employees' rights at work which are binding by the work contract.",
"score": 0
},
{
"id": 11113,
"name": "Job market offers",
"description": "Job opportunities available on the labour market, depending on the economic field concerned.",
"score": 0
},
{
"id": 11114,
"name": "Web programming",
"description": "The programming paradigm that is based on combining markup (which adds context and structure to text) and other web programming code, such as AJAX, javascript and PHP, in order to carry out appropriate actions and visualise the content.",
"score": 0
},
{
"id": 11115,
"name": "Labour market",
"description": "The trends, functioning, and fluctuations of the labour market, career options, wages, unions, working population and the supply and demand of certain professions in a sector.",
"score": 0
},
{
"id": 11116,
"name": "Prototyping development",
"description": "The prototyping development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11117,
"name": "Facilitate job market access",
"description": "Improve the chances of individuals to find a job, by teaching the required qualifications and interpersonal skills, through training and development programs, workshops or employment projects.",
"score": 0
},
{
"id": 11118,
"name": "Prepare personal work environment",
"description": "Correct settings or positions for your working instruments and adjust them before starting operations.",
"score": 0
},
{
"id": 11118,
"name": "Iterative development",
"description": "The iterative development model is a methodology to design software systems and applications.",
"score": 0
}
]
},
{
"id": 1002,
"title": "doc 2",
"status": "active",
"external_id": "YPP23ZQ-01944",
"provider": "client2",
"batch_id": 111,
"skills": [
{
"id": 11111,
"name": "Incremental development",
"description": "The incremental development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11112,
"name": "Employment law",
"description": "The law which mediates the relationship between employees and employers. It concerns employees' rights at work which are binding by the work contract.",
"score": 0
},
{
"id": 11113,
"name": "Job market offers",
"description": "Job opportunities available on the labour market, depending on the economic field concerned.",
"score": 0
},
{
"id": 11114,
"name": "Web programming",
"description": "The programming paradigm that is based on combining markup (which adds context and structure to text) and other web programming code, such as AJAX, javascript and PHP, in order to carry out appropriate actions and visualise the content.",
"score": 0
},
{
"id": 11115,
"name": "Labour market",
"description": "The trends, functioning, and fluctuations of the labour market, career options, wages, unions, working population and the supply and demand of certain professions in a sector.",
"score": 0
},
{
"id": 11116,
"name": "Prototyping development",
"description": "The prototyping development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11117,
"name": "Facilitate job market access",
"description": "Improve the chances of individuals to find a job, by teaching the required qualifications and interpersonal skills, through training and development programs, workshops or employment projects.",
"score": 0
},
{
"id": 11118,
"name": "Prepare personal work environment",
"description": "Correct settings or positions for your working instruments and adjust them before starting operations.",
"score": 0
},
{
"id": 11118,
"name": "Iterative development",
"description": "The iterative development model is a methodology to design software systems and applications.",
"score": 0
}
]
},
{
"id": 1003,
"title": "doc 3",
"status": "active",
"skills": [
{
"id": 11111,
"name": "Incremental development",
"description": "The incremental development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11112,
"name": "Employment law",
"description": "The law which mediates the relationship between employees and employers. It concerns employees' rights at work which are binding by the work contract.",
"score": 0
},
{
"id": 11113,
"name": "Job market offers",
"description": "Job opportunities available on the labour market, depending on the economic field concerned.",
"score": 0
},
{
"id": 11114,
"name": "Web programming",
"description": "The programming paradigm that is based on combining markup (which adds context and structure to text) and other web programming code, such as AJAX, javascript and PHP, in order to carry out appropriate actions and visualise the content.",
"score": 0
},
{
"id": 11115,
"name": "Labour market",
"description": "The trends, functioning, and fluctuations of the labour market, career options, wages, unions, working population and the supply and demand of certain professions in a sector.",
"score": 0
},
{
"id": 11116,
"name": "Prototyping development",
"description": "The prototyping development model is a methodology to design software systems and applications.",
"score": 0
},
{
"id": 11117,
"name": "Facilitate job market access",
"description": "Improve the chances of individuals to find a job, by teaching the required qualifications and interpersonal skills, through training and development programs, workshops or employment projects.",
"score": 0
},
{
"id": 11118,
"name": "Prepare personal work environment",
"description": "Correct settings or positions for your working instruments and adjust them before starting operations.",
"score": 0
},
{
"id": 11118,
"name": "Iterative development",
"description": "The iterative development model is a methodology to design software systems and applications.",
"score": 0
}
]
}
]
}

Response fields

Field name

Description

id

Document ID

title

Document title

status

Document status. Available values:

active - the document has been process and skills extracted for it.

queued - the document is pending processing.

processing - the document is being processed.

external_id

This field can be used to link documents to other data. It can be provided as part of each document in a batch request.

provider

This field can be used to group documents who belong to the same client, provider, category etc. It can be provided as part of each document in a batch request.

batch_id

The batch ID that the document is part of.

skills

The skills extracted by the algorithm based on the document content.

Each skill contains the following:

id

name

description

score

The score is given by the algorithm based on the relevance of the skill in the content provided.