How do I use the CRD API?

The CRD API is used for collaboration and other system functions. CRD API allows you to run schedules as well as control the scheduling services. Here is how to install and configure it if needed.

Options - CRD API

The CRD API enables you to manage and execute schedules effectively, along with offering control over scheduling services. It is versatile, allowing you to interact with the API using any programming language you prefer.

The CRD API is a RESTful API that utilizes HTTP requests and JSON responses. To quickly get started with the CRD API, we recommend using Postman—a user-friendly, free tool that aids developers in executing and troubleshooting API requests. Postman serves as the definitive reference for this documentation.

How to Install the CRD API?

Step 1 - Navigate to Options.

• The API Settings section is used for collaboration and other system functions.

Step 3 - Click Install API.

Step 4 - Enter your windows credentials to install the API.

Step 5 - Click OK.

Step 6 - Click Yes.

Step 7 - Click OK.  The CRD API has been successfully installed.

Step 8 -  Click Start to start the CRD API Service.

API Clients

This section is used to give another application access to the CRD API.

• You only need to provide the Client name as the Client ID and Secret are automatically generated by CRD.

How do I use the CRD API?

Getting Started

CRD's API allows you to run schedules as well as control the scheduling services. You can use any programming language of your choice to query the API.

The CRD API is a RESTful API based on HTTP requests and JSON responses. The easiest way to start using the CRD API is by using Postman, a free tool which helps developers run and debug API requests, and is the source of truth for this documentation. 

Authentication and Authorization

The CRD API can use OAuth2 Client Credentials or Username and Password authentication and authorization flow. All API endpoints except the /api/service/ping require a valid access token for authorization.

Get Token

Username and Password Flow

To request an access token using the credentials of a CRD user, make a POST request as follows:

http://[crdserver]:9000/login/token

POST http://[crdserver]:9000/login/token

POST Body

string username
string password

Example Result

{
    "UserId": "jd",
    "FirstName": "John",
    "LastName": "Doe",
    "role": "Administrator",
    "ExpiryDateEpoch": 1617803400,
    "token": "VEw+8f/9N1D8ZiJOmOses38Wad0RD/NU9jUDIVVK8CeUcmIjErSZDn965NVmSlEZJd3gfRbkUajd5dCNm87c295S1TO4RKbeJUho6t6XEJUdiJSs1T4WY2xEaR75RqufM3Xi3u55Pp3AsQX0jmN0wcOe/26k1y3feM8hZmnjffbDYZT7azIpiebLBPaXhY6dAA==",
    "token_type": "custom"
}

Client Credentials Flow

In order to obtain an access token, you must first add the Client application to CRD. This is done under the Configuration/CRD API screen.

To request an access token, make a POST request as follows:

http://[crdserver]:9000/oauth2/token

POST http://[crdserver]:9000/oauth2/token

POST Body

string grant_type: client_credentials
string client_id
string client_secret

Result

{
string access_token
string token_type: bearer
int expires_in
}

Below is an example of what a successful authentication result looks like:

{
    
  "access_token": "AQAAANCMnd8BFdERjHoAwE_...",
    
  "token_type": "bearer",
    
  "expires_in": 86399
}

For the username and password flow, the request header must include:

Authorization: token {access_token}

For client credentials flow include:

Authorization: bearer {access_token}

EndPoints

The API is accessed by making HTTP requests to a specific URL endpoint, in which GET or POST variables contain information about what you wish to access. Every endpoint is accessed via the port and protocol configured in CRD.  The CRD API Service must also be running on the CRD server.

The default starting endpoint for the API is:

http://[crdserver]:9000/api

Service EndPoint

The Service Endpoint allows you to query and control the CRD services.

Ping

To check if the API is up and running, you can use Ping. The call will return 1 when the API is running.

GET /api/service/ping

Result:

The call will return 1 when the API is running or a 0 if it is not.

int 1

IsSchedulerRunning

To check if the CRD scheduler is running:

GET /api/service/isschedulerrunning

Result:

True if the CRD Scheduler is running

False if the CRD Scheduler is not running.

{
true
}

StartScheduler 

GET /api/service/startscheduler

Ok 200

StopScheduler

GET /api/service/stopscheduler

Ok 200

GetConfigPath

To get the path to the CRD config file:

GET /api/service/getconfigpath

Result:

{
string Result
}

Schedule Endpoint

The Schedule endpoint allows you to control CRD schedules. Where a schedule type must be specified, the following are valid:

•  "report" or “single”: all Single and Data-Driven Schedules               

• "automation": all Automation schedules

• "package": all Single and Data-Driven Package schedules

• "event": all Event-Based schedules

• “event-package" or “eventpackage”: all Event-Based Package schedules

The schedule’s unique Id can be obtained from the schedule’s properties screen in the application GUI.

ExecuteSchedule

Synchronously kicks off a schedule and waits for its completion.

POST api/schedule/executeschedule

POST Body

string ScheduleType
int UniqueId
string RunBy

Result

The result will be true or false.  If the Schedule failed to execute there should be an error message and error number displayed.

{
bool Result
string ErrorMessage
int ErrorNumber
}

ExecuteScheduleOnTimeAsync

Asynchronously kicks off the schedule as if it is being run by the scheduler. At completion, the schedule’s NextRun date will be incremented.

POST api/schedule/executescheduleontimeasync

POST Body

string ScheduleType
int UniqueId
string RunBy

Result

{
string ExecutionId
}

ExecuteScheduleAsync

Asynchronously kicks off a schedule and does not wait for its completion. The resulting ExecutionId can be used to query the execution status

POST api/schedule/executescheduleasync

POST Body

string ScheduleType
int UniqueId
string RunBy

Result

{
string ExecutionId

SingleSchedule Endpoint

The SingleSchedule endpoint provides the functionality to perform Create, Read, Update, and Delete (CRUD) operations for managing CRD single schedules efficiently.

Create

Creating Single Schedules

* denotes a required field.

POST api/schedule/CreateSingleReport

Dependent Models

RenderingSettingsModel

BasicFilterModel

This model inherits from the FilterBaseModel.

AdvancedFilterModel

This model inherits from the FilterBaseModel.

TimeScheduleBaseModel

DataDriverModel