Actions with training

After creating the project, you must teach it how to use your documentation. You can do this by uploading multiple documents.

See how to do this here.

Thanks to the queries below, you can get the current training status, or cancel the project training.

Parameters


id You need only the project ID from the parameters and nothing else

trainingId

Returns


If the request to cancel training is successfully completed, the update_chains_by_pk object will be returned to you.

If the request to obtain the current training status is successfully completed, you will receive a progress object with information about the start time and date, the completed part and any errors that occurred.

/rest/v1/projects/{id}/training/{trainingId}
Example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cancelled_at": "string",
  "progress": {
    "start": 0,
    "done": 0,
    "error": 0
  }
}
Schema
{
  id:	string,
  cancelled_at:	string,
  progress:	Progress{
              start:	number,
              done:	number,
              error:	number
                    }
}
/rest/v1/projects/{id}/training/{trainingId}/cancel
Example
{
  "update_chains_by_pk": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cancelled_at": "string"
  }
}
Schema
{
  update_chains_by_pk:	UpdateChainsByPk{
                            id:	string($uuid),
                            cancelled_at:	string
                                        }
}

Was this article helpful to you? Yes No

How can we help?