Progressive Key API
Get Progressive Key

Get Progressive Key

OVERVIEW

Overview

Certain functions in Publisher will take a while to be processed. These functions will provide a progressive key, and the status of any of these functions can be checked with the following API. 

The Progressive key API is used to retrieve current progress/status on given key.

The API has PUBLIC access.

Since v5.0

HTTP Request

GET  /api/2/progressivekeystatus/<KEY>

URL Parameters

Parameter Description
KEY

The progressive key provided by another API.

POST /api/2/progressivekeystatus/zJ5lISYyhJ_1500443110814

 

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
Content-Type

The format of the provided content.

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the expected content by default.

 "application/json"

 

HTTP Response

Success

HTTP response 200 with progressive key object 

(Example below)

 

Example HTTP Request & Response

POST http://example.com/context/api/2/progressivekeystatus/zJ5lISYyhJ_1500443110814

 

Example 1: Search count request: In progress

JSON Response

{

    "progressivekeystatus": "INPROGRESS",

    "resultcount": 500

}

 

Example 2: Search count request: Done

JSON Response

{

    "progressivekeystatus": "DONE",

    "resultcount": 1000

}

 

Example 3: Search count request: Fail

JSON Response

{

    "progressivekeystatus": "FAIL",

    "resultcount": 0

}

 

 

Comments


0 Comments

Last Updated: Nov 08,2024