Admin Report APIs

Admin Reports

Below are the available APIs for working with Admin Reports in Ovation.

Using our REST API to Get Workflow QC Report

The Get all Workflows and related data request is an HTTP GET call to the following urls:

Required data from Ovation

The following data must be provided by Ovation in order to call the API.  Different values must be configured for staging and production

Example of request:

/api/v3/admin_reports?type=workflow_report&start_date=2020-01-01&end_date=2021-01-15&workflow_definition_id=1

Parameters

key

required

description

type yes Type of report data you’re requesting.
Options:
  • workflow_report
startDate yes Starting date for query.
endDate yes Ending date for query.
workflowDefinitionId yes ID of workflow definition you want data for.
(Only required with type ' workflow_report')
page optional Page of results. Defaults to 1.
perPage optional Number of results per page. Defaults to 100.

Response

{
  "workflows": [
      [
          {
              "Workflow Batch": "test-1",
              "Workflow Type": "test",
              "Workflow Status": "completed",
              "Requisition ID": "test-req-1",
              "Sample ID": "test-sample-1",
              "Collection Date": "",
              "Received Date": "",
              "Control": "No",
              "Overall Test Result": "",
              "Previous Workflow": "",
              "Activity 1": "Batch Creation",
              "Activity 1 Submitted By": "Test User",
              "Activity 1 Submitted Date": "01/01/2020 11:20 AM",
              "Activity 2": "Batch plating",
              "Activity 2 Submitted By": "Test User",
              "Activity 2 Submitted Date": "01/01/2020 11:25 AM"
          },
          {
              "Workflow Batch": "test-1",
              "Workflow Type": "test",
              "Workflow Status": "completed",
              "Requisition ID": "test-req-2",
              "Sample ID": "test-sample-2",
              "Collection Date": "",
              "Received Date": "",
              "Control": "No",
              "Overall Test Result": "",
              "Previous Workflow": "",
              "Activity 1": "Batch Creation",
              "Activity 1 Submitted By": "Test User",
              "Activity 1 Submitted Date": "01/01/2020 11:20 AM",
              "Activity 2": "Batch plating",
              "Activity 2 Submitted By": "Test User",
              "Activity 2 Submitted Date": "01/01/2020 11:25 AM"
          }
      ]
  ]
}
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.