Document Details

This API allows you to retrieve the skills that were associated to a document that was already processed, thus allowing you to come back at any time and check the skill list.
get
https://apigateway.boost.rs
/skillfinder/documents/:id
Get the document related skills for any given document_id
Example of API calls with parameters
Default request example
The default response will return only the skills from the hierarchy, for the purpose of maximising the speed and reducing the response size to the minimum.
Request URL
Response
Request URL without parameters
{{URL}}/skillfinder/documents/:id
{
    "success": true,
    "message": "",
    "result": {
        "id": 159678,
        "title": "API - 2021-12-15 08:29:28",
        "status": "active",
        "external_id": null,
        "provider": null,
        "batch_id": null,
        "skills": [
            {
                "id": 19795,
                "name": "Provide dog walking services",
                "description": "Provide dog-walking services, including activities such as agreement of services with the customer, selection and use of handling equipment, interaction with the dog, and safe and responsible dog walking."
            },
            {
                "id": 14593,
                "name": "Evaluate dogs",
                "description": "Assess whether certain dogs are ready to work as a guide dog or not, whether certain dogs should be withdrawn from the training programme, need extra training or a different approach, etc."
            },
            {
                "id": 24807,
                "name": "Manage dog breeding",
                "description": "Manage a suitable environment for dog breeding. Select and prepare the appropriate habitats for specific kinds of dogs. Monitor the dog's growth and health and ensure correct feeding. Identify when the dogs are ready for trade, training or other purposes."
            },
            {
                "id": 25857,
                "name": "Train dogs",
                "description": "Train dogs to behave appropriately and obey their owners' commands. Use a variety of techniques like clicker training, relationship-based training or dominance-based training to obtain favourable behaviours in the dog."
            },
            {
                "id": 14849,
                "name": "Dog behaviour",
                "description": "Natural behavioural patterns of dogs, how normal and abnormal behaviour might be expressed according to dog breeds, environment, human-animal interaction and occupation."
            },
            {
                "id": 19775,
                "name": "Plan dog grooming work",
                "description": "Assess customer wishes and plan dog grooming work;. Assess the dog's head shape and its type of coat, recognising signs of abnormalities, and select the appropriate methods and equipment."
            },
            {
                "id": 25657,
                "name": "Guide dog training methods",
                "description": "The methods that are used to train dogs to guide people who are visually impaired."
            },
            {
                "id": 15882,
                "name": "Monitor the identification of animals",
                "description": "Monitor the identification of animals that come in the slaughterhouse. Assure the correct procedures for legal, quality, and administrative procedures in order to maintain identification and traceability during the manufacturing process."
            },
            {
                "id": 22297,
                "name": "Train animals",
                "description": "Train animals to facilitate their routine husbandry, for treatment, and/or public demonstrations."
            },
            {
                "id": 17866,
                "name": "Assist in transportation of animals",
                "description": "Assist with the transportation of animals, including the loading and unloading of animals, the preparation of the transport vehicle, and maintaining the wellbeing of the animal throughout the transport process."
            }
        ]
    }
}
Requests with parameters
Single parameter (ex: only meta-skills)
Note that the response will only return the meta-skills in the response, as the request was only for those skills from the hierarchy.
Request URL
Response
Request URL with meta-skill parameter
{{URL}}/skillfinder/documents/:id?with[]=meta_skills
{
    "success": true,
    "message": "",
    "result": {
        "id": 159678,
        "title": "API - 2021-12-15 08:29:28",
        "status": "active",
        "external_id": null,
        "provider": null,
        "batch_id": null,
        "meta_skills": [
            {
                "id": 48,
                "name": "Handling animals (excluding horses and fish)"
            },
            {
                "id": 7,
                "name": "Breeding animals"
            }
        ]
    }
}
Multiple parameters
In cases in which you need more than one level, you may include any combination of the available options.
The example below is for a request using the meta-skills and skills parameters.
Request URL
Response
Request URL with meta-skill and skill parameters
{{URL}}/skillfinder/documents/:id?with[]=skills&with[]=meta_skills
{
    "success": true,
    "message": "",
    "result": {
        "id": 159678,
        "title": "API - 2021-12-15 08:29:28",
        "status": "active",
        "external_id": null,
        "provider": null,
        "batch_id": null,
        "skills": [
            {
                "id": 19795,
                "name": "Provide dog walking services",
                "description": "Provide dog-walking services, including activities such as agreement of services with the customer, selection and use of handling equipment, interaction with the dog, and safe and responsible dog walking."
            },
            {
                "id": 14593,
                "name": "Evaluate dogs",
                "description": "Assess whether certain dogs are ready to work as a guide dog or not, whether certain dogs should be withdrawn from the training programme, need extra training or a different approach, etc."
            },
            {
                "id": 24807,
                "name": "Manage dog breeding",
                "description": "Manage a suitable environment for dog breeding. Select and prepare the appropriate habitats for specific kinds of dogs. Monitor the dog's growth and health and ensure correct feeding. Identify when the dogs are ready for trade, training or other purposes."
            },
            {
                "id": 25857,
                "name": "Train dogs",
                "description": "Train dogs to behave appropriately and obey their owners' commands. Use a variety of techniques like clicker training, relationship-based training or dominance-based training to obtain favourable behaviours in the dog."
            },
            {
                "id": 14849,
                "name": "Dog behaviour",
                "description": "Natural behavioural patterns of dogs, how normal and abnormal behaviour might be expressed according to dog breeds, environment, human-animal interaction and occupation."
            },
            {
                "id": 19775,
                "name": "Plan dog grooming work",
                "description": "Assess customer wishes and plan dog grooming work;. Assess the dog's head shape and its type of coat, recognising signs of abnormalities, and select the appropriate methods and equipment."
            },
            {
                "id": 25657,
                "name": "Guide dog training methods",
                "description": "The methods that are used to train dogs to guide people who are visually impaired."
            },
            {
                "id": 15882,
                "name": "Monitor the identification of animals",
                "description": "Monitor the identification of animals that come in the slaughterhouse. Assure the correct procedures for legal, quality, and administrative procedures in order to maintain identification and traceability during the manufacturing process."
            },
            {
                "id": 22297,
                "name": "Train animals",
                "description": "Train animals to facilitate their routine husbandry, for treatment, and/or public demonstrations."
            },
            {
                "id": 17866,
                "name": "Assist in transportation of animals",
                "description": "Assist with the transportation of animals, including the loading and unloading of animals, the preparation of the transport vehicle, and maintaining the wellbeing of the animal throughout the transport process."
            }
        ],
        "meta_skills": [
            {
                "id": 48,
                "name": "Handling animals (excluding horses and fish)"
            },
            {
                "id": 7,
                "name": "Breeding animals"
            }
        ]
    }
}
Request using the hierarchy parameter
Using the hierarchy parameter
If there are no options specified via the with[] parameter, the response will only include skills (atomic skills); the hierarchy parameter will have no effect.
Request URL
Response
{{URL}}/skillfinder/documents/:id?with[]=skills&with[]=super_skills&hierarchy=1
{
    "success": true,
    "message": "",
    "result": {
        "id": 159727,
        "title": "API - 2022-01-25 09:27:15",
        "status": "active",
        "external_id": null,
        "provider": null,
        "batch_id": null,
        "super_skills": [
            {
                "id": 6,
                "name": "Computer science and mathematics: software, programming languages, security, etc.",
                "skills": [
                    {
                        "id": 15278,
                        "name": "Computer programming",
                        "description": "The techniques and principles of software development, such as analysis, algorithms, coding, testing and compiling of programming paradigms (e.g. object oriented programming, functional programming) and of programming languages."
                    },
                    {
                        "id": 24617,
                        "name": "Use functional programming",
                        "description": "Utilise specialised ICT tools to create computer code which treats computation as the evaluation of mathematical functions and seeks to avoid state and mutable data. Use programming languages which support this method such as LISP, PROLOG and Haskell."
                    },
                    {
                        "id": 15893,
                        "name": "Use logic programming",
                        "description": "Utilise specialised ICT tools to create computer code composed of series of sentences in logical form, expressing rules and facts about some problem domain. Use programming languages which support this method such as Prolog, Answer Set Programming and Datalog."
                    },
                    {
                        "id": 15844,
                        "name": "Use software design patterns",
                        "description": "Utilise reusable solutions, formalised best practices, to solve common ICT development tasks in software development and design."
                    },
                    {
                        "id": 26722,
                        "name": "Software metrics",
                        "description": "The metrics that measure a characteristic of the software system in order to determine the development of the software and evaluate it."
                    },
                    {
                        "id": 15487,
                        "name": "Use concurrent programming",
                        "description": "Utilise specialised ICT tools to create programs that can execute concurrent operations by splitting programs into parallel processes and, once computed, combining the outcomes together."
                    },
                    {
                        "id": 20514,
                        "name": "Oversee development of software",
                        "description": "Organise, plan and supervise the development of the applications and frameworks in order to create a software product, from the earliest planning stages to the final product test."
                    }
                ]
            },
            {
                "id": 16,
                "name": "Heat, fuels and industrial processes",
                "skills": [
                    {
                        "id": 20835,
                        "name": "Computer engineering",
                        "description": "Engineering discipline that combines computer science with electrical engineering to develop computer hardware and software. Computer engineering occupies itself with electronics, software design, and the integration of hardware and software."
                    }
                ]
            }
        ]
    }
}
Mapping APIs - Previous
Extract Skills
Next - Mapping APIs
Batch Skill Processing
Last modified 4mo ago
Copy link
On this page
get
Get the document related skills for any given document_id
Example of API calls with parameters
Default request example
Requests with parameters