RP_APICheckFileAvailability: RP_APICheckFileAvailability

In RavenPack/r-api: RavenPack API to Self Service Platform

RP_APICheckFileAvailability

Description

Checks the availability of the datafile. After submitting a request to generate a datafile using the datafile endpoint, a token is returned which may be supplied to this endpoint in order to find the status of the datafile generation job. When the job is complete, the status will be updated to completed and the size and URL will be set.

Usage

RP_APICheckFileAvailability(APIHandler, token)

Arguments

APIHandler	An API handler, created using RP_CreateAPIHandler.
token	A string that identifies the request.

Value

Information about the status of the request.

Response parameters:

• status: One of the following: [enqueued, processing, completed, error]

• size: File size.

• url: Link to download the file.

• checksum: Checksum code.

Author(s)

Jose A. Guerrero-Colon

RavenPack/r-api documentation built on July 30, 2022, 9:56 p.m.