API docs by Redocly

Runsheet Generation Service API (1.0.0)

Perform CRUD actions for runsheet generation jobs.

Runsheet Generation Service Wiki

Return the list of runsheet generation jobs

Return the list of runsheet generation jobs

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string <date-time>

Range start (inclusive) of Created At

range_end_created_at
string <date-time>

Range end (inclusive) of Created At

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "runsheet_generation_jobs": [
    ]
}

Create a Runsheet Generation

Create a Runsheet Generation

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string
strategy
required
string (runsheet-strategy)
Enum: "random" "exact-address-match"
strategy_config
object (runsheet-strategy-config)

Responses

Request samples

Content type
application/json
{
  • "name": "My Runsheet Generation",
  • "strategy": "random",
  • "strategy_config": { }
}

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "My Runsheet Generation",
  • "strategy": "random",
  • "strategy_config": { },
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "current_status": "new",
  • "current_status_updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ],
  • "error": "",
  • "version_seq": 0,
  • "version_rev": "0-OqQ6QSWl"
}

Read an existing Runsheet Generation

Read an existing Runsheet Generation

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

Responses

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "My Runsheet Generation",
  • "tasks": [
    ],
  • "strategy": "random",
  • "strategy_config": { },
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "current_status": "new",
  • "current_status_updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ],
  • "error": "",
  • "version_seq": 0,
  • "version_rev": "0-OqQ6QSWl"
}

Update the Runsheet Generation

Update the Runsheet Generation

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be update

Request Body schema: application/json
name
required
string
strategy
required
string (runsheet-strategy)
Enum: "random" "exact-address-match"
strategy_config
object (runsheet-strategy-config)

Responses

Request samples

Content type
application/json
{
  • "name": "My Runsheet Generation",
  • "strategy": "random",
  • "strategy_config": { }
}

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "My Runsheet Generation",
  • "tasks": [
    ],
  • "strategy": "random",
  • "strategy_config": { },
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "current_status": "new",
  • "current_status_updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ],
  • "error": "",
  • "version_seq": 0,
  • "version_rev": "0-OqQ6QSWl"
}

Add Tasks to an existing Runsheet Generation

Add Tasks to an existing Runsheet Generation

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

Request Body schema: application/json
Array of objects (task)

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "My Runsheet Generation",
  • "tasks": [
    ],
  • "strategy": "random",
  • "strategy_config": { },
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "current_status": "new",
  • "current_status_updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ],
  • "error": "",
  • "version_seq": 0,
  • "version_rev": "0-OqQ6QSWl"
}

Delete Task from Runsheet Generation

Delete Task from Runsheet Generation

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

taskID
required
string

ID of the Task to be delete

Responses

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "My Runsheet Generation",
  • "tasks": [
    ],
  • "strategy": "random",
  • "strategy_config": { },
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "current_status": "new",
  • "current_status_updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ],
  • "error": "",
  • "version_seq": 0,
  • "version_rev": "0-OqQ6QSWl"
}

Start Runsheet Generation Job, only can run the jo

Start Runsheet Generation Job, only can run the job once.

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be start

Request Body schema: application/json
version_rev
required
string

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-OqQ6QSWl"
}

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "My Runsheet Generation",
  • "tasks": [
    ],
  • "strategy": "random",
  • "strategy_config": { },
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "current_status": "new",
  • "current_status_updated_at": "2019-08-24T14:15:22Z",
  • "statuses": [
    ],
  • "error": "",
  • "version_seq": 0,
  • "version_rev": "0-OqQ6QSWl"
}

Check Runsheet Generation Result

Check Runsheet Generation Result

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

Responses

Response samples

Content type
application/json
{
  • "total_runsheets_counted": 0,
  • "total_runsheets_created": 0,
  • "total_runsheets_failed": 0,
  • "total_tasks_counted": 0,
  • "total_tasks_added": 0,
  • "total_tasks_failed": 0,
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "runsheet_generation_id": "016a0e2c-7b9a-4c32-bb0f-e0c714f59ec7",
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z"
}

Create Runsheet Generation Result

Create Runsheet Generation Result

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

Request Body schema: application/json
total_runsheets_counted
required
number
total_runsheets_created
required
number
total_runsheets_failed
required
number
total_tasks_counted
required
number
total_tasks_added
required
number
total_tasks_failed
required
number
id
string <uuid>
runsheet_generation_id
required
string <uuid>
start_time
required
string <date-time>
end_time
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "total_runsheets_counted": 0,
  • "total_runsheets_created": 0,
  • "total_runsheets_failed": 0,
  • "total_tasks_counted": 0,
  • "total_tasks_added": 0,
  • "total_tasks_failed": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "runsheet_generation_id": "016a0e2c-7b9a-4c32-bb0f-e0c714f59ec7",
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "total_runsheets_counted": 0,
  • "total_runsheets_created": 0,
  • "total_runsheets_failed": 0,
  • "total_tasks_counted": 0,
  • "total_tasks_added": 0,
  • "total_tasks_failed": 0,
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "runsheet_generation_id": "016a0e2c-7b9a-4c32-bb0f-e0c714f59ec7",
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z"
}

Update Runsheet Generation Job status to IN PROGRE

Update Runsheet Generation Job status to IN PROGRESS. Current job status must be queued

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully update status to in progress"
}

Update Runsheet Generation Job status to DONE. Cur

Update Runsheet Generation Job status to DONE. Current job status must be in progress

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully update status to done"
}

Update Runsheet Generation Job status to FAILED. C

Update Runsheet Generation Job status to FAILED. Current job status must be in progress

Authorizations:
bearerAuth
path Parameters
generationID
required
string

ID of the Runsheet Generation to be read

Request Body schema: application/json
error
required
string

Responses

Request samples

Content type
application/json
{
  • "error": "Error creating runsheet"
}

Response samples

Content type
application/json
{
  • "message": "Successfully update status to failed"
}