How to Process Uploaded Data

You can proceed with the data uploaded to a repository and apply some pre-configured processing to it.
For example, you want your data manager to upload to a repository first, and then load the resulting tables to a project without interacting with Timeline interface or from a 3rd-party system. It is possible to do it by sending API requests to certain endpoints of a needed repository. There is no separate endpoint to transfer data from a repository to a project, however, this action is possible with the help of to-do lists. These lists offer a wide range of possible operations with uploaded tables, and one of them is Load into project. The data manager will need to execute a pre-configured to-do list with this operation to load data from a repository to a project.

For details on actions that can be added to a to-do list, see Operations.

Note. For information on where to find path parameter values for the endpoints, see Repository path parameters.

Before you begin

At the moment, some repository actions are not implemented in Timeline API. To perform them, you will need to interact with Timeline interface. Below are listed such actions, that are mandatory for loading data from a repository to a project:

  • You need an already created and configured to-do list in the repository you want to load data from.
  • In order to upload data to a project, the to-do list has to contain the Load into project operation.
  • You need to ask someone who works with Timeline interface to provide you with at least a name of the to-do list that suits your needs.
    Important. The target project for data upload is also configured in the to-do list.

Loading data

  1. Obtain to-do lists available to you, then find the ID of the needed one. To do it, send a GET request to the endpoint:
    {your.timeline.instance}.com/api/ext/1.0/repository/{repositoryId}/todo-list

    Required parameters: repositoryId
    In response, you will receive:
    1. id - the identifier of the repository.
    2. name -  the name of the repository.
  2. Send a POST request to execute the needed to-do list. Provide the names of the to-do lists you want to execute in the request body.
    Endpoint:
    {your.timeline.instance}.com/api/ext/1.0/repository/{repositoryId}/execute-todo-list

    Required parameters: repositoryId
    Request body example: 
{
  "tableName": "My Table",
  "todoListNames": [
    "Todo List 1",
    "Todo List 3"
  ]
}

You will receive a processingId in response.

  1. Send a GET request with the processingId returned by the previous request. Endpoint:
    {your.timeline.instance}.com/api/ext/1.0/processing/{processingId}

    Poll the processing endpoint until the status becomes FINISHED.
    In response, you will receive a URL.
    As a result, all actions included in the to-do list will be executed, and the resulting table will be loaded to the specified project which is specified in the Load into project operation configuration.

Examples

For Windows

For Linux

05.09.2024 16:23:54

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.