RP_APICancelRequest: RP_APICancelRequest

View source: R/RP_SelfServiceAPI_EndPoints.R

RP_APICancelRequestR Documentation

RP_APICancelRequest

Description

Cancels a Request. Only "Enqueued" queries can be cancelled. Please note that if the job has finished, a 404 response will be returned as the job token is no longer valid.

Usage

RP_APICancelRequest(APIHandler, token)

Arguments

APIHandler

An API handler, created using RP_CreateAPIHandler.

token

A string that identifies the request to be cancelled.

Value

An informative message.

Author(s)

Jose A. Guerrero-Colon


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