Common

Along with Timeline API resources, there are some endpoints that are involved in actions with different Timeline features. Such endpoints are regarded as a separate group and are common for all available API resources.

Processing endpoint

This endpoint is used to get the status of a certain process initiated by another request. A request to this endpoint is one of the steps in processes like loading data, collecting statistics, etc. The polled process is specified by a procesingId parameter's value. Any request that starts a prolonged action will return the procesingId.

The processing endpoint is needed in different scenarios:

  • Downloading processed data
    If your scenario requires exporting certain data from Timeline in a file, when the processing is successfully finished, this endpoint will return a downloadURL. Send a GET request to this URL to download the resulting file.
  • Making sure that a process is finished
    Not all processes result in files to export. You can also initiate data uploads to projects and repositories in Timeline without opening its interface. It is possible to monitor the progress of such actions and make sure they are completed by sending requests to the processing endpoint.

Obtaining procesingId

It is an identifier of processing initiated by another API request. The only purpose of this identifier is to be used for requesting a process status from a processing endpoint. To find the identifier for a required process, call an endpoint that returns a processingId in the response, and copy the ID value returned in the response. Expand the examples below to see what endpoints return processingId.

Show Project endpoints

Show Repository endpoints

Polling processing status

To obtain information about the status of certain processing, you need to send a GET request with the processingId returned by the previous request to the endpoint:

{your.timeline.instance}.com/api/ext/1.0/processing/{processingId}

Show CURL example

Response values

In response, you receive one of the following statuses:

  • IN_PROCESS
    This status means that the processing is not finished yet, you need to continue polling the endpoint.
  • ERROR
    This status means that some error occurred during the processing. It may indicate that some parameter values were inserted incorrectly in previous requests, the connection to Timeline was lost during the processing, etc. If you receive this status, it is recommended to review the preceding requests chain and check the authorization.
  • FINISHED
    This status means that the processing is complete.
    Note. If a large amount of data is involved, the process may take a long time. In such cases, the processing endpoint will return the IN_PROCESS status. Continue polling the endpoint until the status becomes FINISHED.

If the processing was aimed at preparing data to extract and results in a file, a URL is returned alongside the FINISHED status. The resulting file can be downloaded by sending a GET or a basic HTTP request to the returned URL.

22.02.2024 17:28:05

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.