Skip to main content
Loading...

API docs by

Generate new report from schedule

Request

Use this API to generate a new report from an existing scheduled report of the authenticated user, as identified by its scheduled ID.

Path
scheduledIdstring, (uuid)required

Scheduled Id to generate a new report

Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Payload
// No request payload

Responses

Bodyapplication/json
reportIdstring, (uuid)required

A unique UUID string denoting the id of the report entry

Example:"91b68c7a-e3d4-40ed-a048-e6ecb7c0a6af"
scheduledIdstring, (uuid)required

Scheduled Id for the report entry

Example:"5c66965a-f79b-46c5-a723-e13dae91e622"
createdBystringrequired

Person/Entity who created this entry first time

Example:"minim aliquip sit"
createdDatestring, (date-time)required

Time when this entry was first created

Example:"3232-10-13T19:06:19.045Z"
lastAccessedBystring

Person/Entity who accessed this entry last time

Example:"mollit irure aliquip"
lastAccessedDatestring, (date-time)

Time when this entry was last accessed

Example:"3454-08-17T05:56:04.691Z"
startTimestring, (date-time)required

Processing start time of the report

Example:"3841-08-04T05:51:18.262Z"
endTimestring, (date-time)

Processing end time of the report

Example:"3907-11-27T08:16:24.458Z"
statusstring(ReportStatus)required

Status of the report

Enum:"IN_PROGRESS""DELAYED""SUCCESS""ERROR""INACTIVE"
Example:"ERROR"
errorMessagestring

Contains an error message if something is failed.

Example:"do Ex"
locationstring

Location of the report once it is generated

Example:"dolore et fugiat"
numberOfDownloadsinteger, >= 0

Number of times this report is downloaded by the customer

Default:0
Example:18013697
numberOfAttemptsinteger, [ 0 .. 3 ]required

Number of times attempted to generate the report

Example:0
parametersArray of objects, >= 0 items(Parameter)required

Parameters for the reports to be generated

Example:
[
  {
    "name": "ex laborum",
    "value": "irure ex Lor",
    "type": "ARRAY"
  },
  {
    "name": "magna Excepteur",
    "value": "sit",
    "type": "INT"
  },
  {
    "name": "veniam mollit ea esse",
    "value": "non esse",
    "type": "BOOLEAN"
  },
  {
    "name": "in elit veniam do",
    "value": "ipsum dolor",
    "type": "ARRAY"
  }
]
publisherInfoobject

Contains report publish data as a json

Example:
{}
Response
{
  "reportId": "eab1d606-2315-476f-848a-a622a47f24ff",
  "scheduledId": "b48696e4-6fdb-49ed-868e-040df6596245",
  "startTime": "4498-05-31T11:48:13.373Z",
  "endTime": "4472-01-16T11:56:02.238Z",
  "createdBy": "elit consequat occaecat",
  "createdDate": "2251-10-21T02:07:18.598Z",
  "lastAccessedBy": "occaecat ullamco tempor c",
  "lastAccessedDate": "2594-04-16T16:02:41.030Z",
  "status": "IN_PROGRESS",
  "location": "eu labore",
  "numberOfDownloads": 1,
  "numberOfAttempts": 1,
  "parameters": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}
Was this page helpful?