boostrs api
Search
K

Update Document

patch
https://apigateway.boost.rs
/matchbox/documents/:id
Update existing documents and their skills if required.

Sample requests

Sample with content parameter

{
"content": "People in this job find and interpret rich data sources, manage large amounts of data, merge data sources, ensure consistency of data-sets, and create visualisations to aid in understanding data. They build mathematical models using data, present and communicate data insights and findings to specialists and scientists in their team and if required, to a non-expert audience, and recommend ways to apply the data. They utilise recommendation engines, spam classifiers, sentiment analysers and classifiers for unstructured and semi-structured data.",
"title": "My Document Title",
"provider": "Local inspiration"
}

Sample with jobtitle_id parameter

{
"jobtitle_id": 3413,
"external_id": "BOOST-RS-3413"
}

Sample with jobtitle parameter

{
"jobtitle": "application developer",
"external_id": "RSU-456543"
}

Sample with document fields only

{
"provider": "ExquisiteLearning"
"external_id": "BOOST-RS-3413"
}

Using the parameters

jobtitle_id

  1. 1.
    If sent in the request, the document skills will be reprocessed based on the job skills.
  2. 2.
    the parameter must be a valid Boostrs platform job title ID.

jobtitle

  1. 1.
    If jobtitle is sent in the request, the document skills will be reprocessed and updated.
  2. 2.
    jobtitle must be a string containing the job title name.

title

The string is used as document title.

content

  1. 1.
    If content is sent in the request the document skills will be reprocessed.
    1. 1.
      The field max length is 7500 characters.
jobtitle_id and content cannot be requested at the same time

language_code

  1. 1.
    Can be provided together with content and is meant to specify the content language.
  2. 2.
    Must be a valid Boostrs language code. Check out the Getting started page for the list of available languages.