Document Update

patch
Document Update

https://apigateway.boost.rs/skillfinder/documents/:id
Request
Response
Request
Path Parameters
id
required
integer
ID of the document to edit
Headers
Authentication
required
string
Authorisation token received from oAuth API. Bearer :token
Body Parameters
title
optional
string
Sets the title of the document. Can be any text with a maximum length of 100.
external_id
optional
string
Sets the external_id field of the document. Can be any text with a maximum length of 100.
provider
optional
string
Sets the provider field of the document. Can be any text with a maximum length of 100.
Response
200: OK
Document updated successfully. The document information is returned to showcase what it looks like after the update.
{
"success": true,
"message": "",
"result": {
"id": 111,
"title": "Title1",
"status": "active",
"external_id": "12343",
"provider": "client1",
"batch_id": 1,
"skills": [
{
"id": 11111,
"name": "Supervise work on design planning",
"description": "Supervise the work in progress at the design stage and on site.",
"score": 0.93
},
{
"id": 11112,
"name": "Implement front-end website design",
"description": "Develop website layout and enhance user experience based on provided design concepts.",
"score": 0.92
},
{
"id": 11113,
"name": "Create website wireframe",
"description": "Develop an image or set of images that display the functional elements of a website or page, typically used for planning a website's functionality and structure.",
"score": 0.9
},
{
"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.9
},
{
"id": 11115,
"name": "Manage a small-to-medium business",
"description": "Manage the organisational, financial and day-to-day operation of a small-to-medium enterprise.",
"score": 0.1
},
{
"id": 11116,
"name": "Entrepreneurship",
"description": "The development, organisation and management of an own business venture",
"score": 0.08
},
{
"id": 11117,
"name": "Apply for government funding",
"description": "Gather information on and apply for subsidies, grants, and other financing programmes provided by the government to small- and large-scale projects or organisations in various fields.",
"score": 0.04
},
{
"id": 11118,
"name": "Self-promote",
"description": "Promote yourself by joining networks and circulating promotional material such as demos, media reviews, website, or a biography. Form a promotion and management team. Propose your services to future employers or producers.",
"score": 0.03
},
{
"id": 11119,
"name": "Apply customer engagement strategy",
"description": "Engage customers with a company or a brand by employing several methods such as humanisation of the brand and social media usage. The initiative for engagement can come either from the consumer or the company and the medium of engagement can be online as well as offline.",
"score": 0.03
},
{
"id": 11120,
"name": "Develop work programmes",
"description": "Develop annual work programs for resource usage which will benefit the environment and forest production.",
"score": 0.03
}
]
}
}
404: Not Found
The document provided could not be found in the database.
{
"message": "Resource not found",
"success": false,
"result": null
}

‚Äč

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.