Skip to main content
Loading...

API docs by

Schedule New Report

Request

Use this API to schedule a report to be generated on a recurring or ad hoc basis.

Headers
Authorizationstring, >= 1required

Specify the Access token with prefix 'Bearer '.

Bodyapplication/json
namestring, non-emptyrequired

Report Name

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

List of input parameters

Example:
[
  {
    "name": "id sunt",
    "value": "tempor consequat minim",
    "type": "INT"
  },
  {
    "name": "eu consequat minim commodo",
    "value": "Duis ex laboris",
    "type": "LONG"
  },
  {
    "name": "nostrud nulla in minim",
    "value": "est laborum magna ea",
    "type": "STRING"
  },
  {
    "name": "ut ullamco pariatur ex",
    "value": "laboris Duis commodo culpa",
    "type": "LONG"
  }
]
scheduleTypestring(ScheduleType)required

Scheduling strategy for the report to be generated.

Enum:"ONE_TIME""DAILY""WEEKLY""MONTHLY""QUARTERLY""ANNUALLY"
Example:"MONTHLY"
periodstring(Period)required

Date range which the report should be generated

Enum:"1_DAY""7_DAYS""14_DAYS""30_DAYS""90_DAYS""180_DAYS""1_YEAR""CUSTOM""NONE"
Example:"30_DAYS"
controlstring

Indicates whether user is entitled to use this report type.

Enum:"ALLOW""DENY"
categoriesArray of strings, unique

The list of categories this definition belongs to

Items Enum:"SECURITY""SITE_AND_ENVIRONMENT""ASSET""POWER""FINANCE"
Payload
{
  "name": "eu exercitation",
  "parameters": [
    { … },
    { … },
    { … },
    { … }
  ],
  "scheduleType": "MONTHLY",
  "period": "30_DAYS"
}

Responses

Bodyapplication/json
scheduledIdstring, (uuid)required

A unique UUID string denoting the id of the scheduled entry

Example:"806f281c-6295-465e-bd41-04559d4d4960"
reportNamestring, non-emptyrequired

Name of the report

Example:"my_report"
scheduleTypestring(ScheduleType)required

Scheduling strategy for the report to be generated.

Enum:"ONE_TIME""DAILY""WEEKLY""MONTHLY""QUARTERLY""ANNUALLY"
Example:"WEEKLY"
periodstring(Period)

Date range which the report should be generated

Enum:"1_DAY""7_DAYS""14_DAYS""30_DAYS""90_DAYS""180_DAYS""1_YEAR""CUSTOM""NONE"
Example:"30_DAYS"
createdBystringrequired

Person/Entity who created this entry first time

Example:"john.doe"
createdDatestring, (date-time)required

Time when this entry was first created

Example:"2017-05-14T00:40:59.790Z"
lastAttemptedDatestring, (date-time)required

Last attempted date to trigger the report generation

Example:"2018-07-02T21:59:15.045Z"
customerOrganizationIdinteger, >= 0required

Customer Organization Id

Example:44010
forOrginteger, >= 1

Customer Org Id where report is generated on behalf of

Example:28120
forUserstring

User key where report is generated on behalf of

Example:12354
lastModifiedBystring

Person/Entity who modified this entry last time

Example:"john.doe"
lastModifiedDatestring, (date-time)

Last modified date of this entry

Example:"2017-07-02T21:59:15.045Z"
numberOfFailedAttemptsinteger, [ 0 .. 3 ]

Number of times the generation of report were failed

Example:0
statusstring(ScheduleStatus)required

Scheduling Status

Enum:"ACTIVE""INACTIVE""SUSPENDED"
Example:"ACTIVE"
parametersArray of objects, >= 0 items(Parameter)required

Parameters for the reports to be generated

Example:
[
  {
    "name": "adipisicing",
    "value": "Duis",
    "type": "STRING"
  },
  {
    "name": "esse anim dolor et",
    "value": "velit Excepteur voluptate",
    "type": "ARRAY"
  },
  {
    "name": "exercitation pariatur cupidatat anim in",
    "value": "labore esse",
    "type": "ARRAY"
  },
  {
    "name": "exercitation est",
    "value": "magna quis",
    "type": "DOUBLE"
  },
  {
    "name": "dolor nulla nisi ut eu",
    "value": "Duis mollit Lorem",
    "type": "DOUBLE"
  }
]
reportsArray of objects(Report)required

Array of generated reports

Example:
[
  {
    "reportId": "71df1306-94f9-4cbd-b6b0-735098bf7f87",
    "scheduledId": "772e5b73-3814-4604-8ae9-6f3eef114132",
    "createdBy": "ea sint fugi",
    "createdDate": "3738-09-09T05:31:51.735Z",
    "startTime": "3990-09-01T03:46:44.797Z",
    "status": "SUCCESS",
    "numberOfAttempts": 3,
    "parameters": [],
    "publisherInfo": {},
    "lastAccessedBy": "sunt eu aute"
  },
  {
    "reportId": "cff3620a-e3d6-4206-a504-1758bd400501",
    "scheduledId": "4ad6048f-3fc4-4fb9-8b66-22fba0bd62f1",
    "createdBy": "ullamco amet nostrud sint",
    "createdDate": "2918-11-28T03:33:08.736Z",
    "startTime": "4808-02-16T12:09:15.960Z",
    "status": "INACTIVE",
    "numberOfAttempts": 3,
    "parameters": [ … ],
    "location": "laboris nostrud",
    "errorMessage": "qui Excepteur",
    "endTime": "4909-04-15T03:51:50.570Z",
    "numberOfDownloads": 14336105,
    "publisherInfo": {}
  },
  {
    "reportId": "4dbd3bea-25f8-485c-b06e-e9c06883b0d7",
    "scheduledId": "e572e79e-0a56-4052-879f-427ecb40dc85",
    "createdBy": "cupidatat",
    "createdDate": "4434-04-25T17:09:55.402Z",
    "startTime": "4243-01-15T02:51:52.654Z",
    "status": "INACTIVE",
    "numberOfAttempts": 0,
    "parameters": [ … ],
    "lastAccessedBy": "dolore exercitat",
    "errorMessage": "co",
    "endTime": "5058-03-30T22:21:23.213Z"
  },
  {
    "reportId": "bc77cee9-0142-4954-afea-002d333b6440",
    "scheduledId": "98d33b3c-675e-4f1e-bfa7-ffdcd7b0aa18",
    "createdBy": "tempor",
    "createdDate": "2280-02-21T19:11:10.988Z",
    "startTime": "3750-11-06T20:13:33.607Z",
    "status": "ERROR",
    "numberOfAttempts": 1,
    "parameters": [ … ],
    "location": "dolor",
    "lastAccessedDate": "4752-10-18T16:02:21.842Z",
    "publisherInfo": {},
    "lastAccessedBy": "sunt ipsu",
    "numberOfDownloads": 51428315
  }
]
Response
{
  "scheduledId": "fec45434-dd6a-4fe9-8fd4-06f219e5dff6",
  "reportName": "eiusmod qui nisi",
  "scheduleType": "QUARTERLY",
  "period": "14_DAYS",
  "createdBy": "reprehenderit",
  "createdDate": "4804-01-02T06:54:41.561Z",
  "lastAttemptedDate": "4533-03-23T21:44:07.660Z",
  "customerOrganizationId": 75750444,
  "forOrg": 36659,
  "forUser": 59730,
  "lastModifiedBy": "john.doe",
  "lastModifiedDate": "2017-07-02T21:59:15.045Z",
  "numberOfFailedAttempts": 1,
  "status": "ACTIVE",
  "parameters": [
    { … },
    { … },
    { … }
  ],
  "reports": [
    { … }
  ]
}
Was this page helpful?