NAV Navbar
Logo cerner
Ruby Shell

HealtheAnalytics Application API v1

HealtheAnalytics is designed to complement the problem-solving process of defining goals, measuring current performance, analyzing variables, initiating appropriate improvement strategies, and controlling and reevaluating the impact of those strategies. To assist with this problem-solving process, Cerner provides prestructured HealtheAnalytics content for specific analytic focuses. The prestructured content includes key performance indicators (KPIs), reports, and data models.

URL: https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1

Projects

Projects include the content that best represents an organization’s data and can help the organization make meaningful changes in workflows. Content can include an organization’s standard reports, custom reports, KPIs, .PDF files, and so on. Providers and health care organizations can view predefined reports and investigate specific underlying variables using analytics visualization tools such as Tableau and SAP BusinessObjects. The project endpoints can be used to create projects and to add reports, KPIs, and widgets to a project.

Create a Project

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects', headers: headers, body: {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data."}

Example response

{
  "id": "87d015cf-2ae3-48d4-822c-9fff4d5b8570",
  "name": "Cost and Utilization",
  "description": "Explore cost and utilization metrics derived from payer claims and enrollment data.",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects

Creates a project.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postProjects true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Project
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Projects

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "87d015cf-2ae3-48d4-822c-9fff4d5b8570",
      "name": "Cost and Utilization",
      "description": "Explore cost and utilization metrics derived from payer claims and enrollment data.",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z",
      "reports": {
        "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
        "name": "Pharmacy Utilization Summary",
        "description": "A utilization summary of all pharmacy drugs.",
        "externalSourceMnemonic": "tableau",
        "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
        "reportDataModels": {
          "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
          "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
          "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
          "createdAt": "2019-03-25T10:49:07.000Z",
          "updatedAt": "2019-03-25T10:49:07.000Z"
        },
        "createdAt": "2019-03-25T10:49:07.000Z",
        "updatedAt": "2019-03-25T10:49:07.000Z"
      },
      "projectKpis": {
        "id": "22c99668-95d8-4fa4-99e2-8eb9a63257ed",
        "kpiId": "02a1443d-8322-4ab6-94b9-07c1921ce40d",
        "target": 1,
        "polarity": 1,
        "primary": true,
        "createdAt": "2019-03-25T10:49:07.000Z",
        "updatedAt": "2019-03-25T10:49:07.000Z"
      },
      "widgets": {
        "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
        "sizeX": 1,
        "sizeY": 1,
        "row": 1,
        "col": 1,
        "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
        "contentUrl": "test/sheets/Sheet1",
        "createdAt": "2019-03-25T10:49:07.000Z",
        "updatedAt": "2019-03-25T10:49:07.000Z"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects?offset=0&limit=20"
}

GET /projects

Retrieves a list of projects filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the response by the name of the project. -
orderBy query string false name A comma-separated list of fields by which to sort. -name, name, -createdAt, createdAt, -updatedAt, updatedAt
associatedEntities query boolean false N/A Indicates whether the retrieved list of projects should include associated reports, widgets, and KPIs. If this is true, the associated resources are included in the response. If this is false, the associated resources are not included. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK ProjectDetails
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Project

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}

Deletes a project, including all child reports, widgets, and project KPIs.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Project

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570', headers: headers, body: {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cost and Utilization","description":"Explore cost and utilization metrics derived from payer claims and enrollment data."}

PUT /projects/{projectId}

Updates a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
body body putProjects true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Project

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "87d015cf-2ae3-48d4-822c-9fff4d5b8570",
  "name": "Cost and Utilization",
  "description": "Explore cost and utilization metrics derived from payer claims and enrollment data.",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z",
  "reports": {
    "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
    "name": "Pharmacy Utilization Summary",
    "description": "A utilization summary of all pharmacy drugs.",
    "externalSourceMnemonic": "tableau",
    "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
    "reportDataModels": {
      "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
      "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    },
    "createdAt": "2019-03-25T10:49:07.000Z",
    "updatedAt": "2019-03-25T10:49:07.000Z"
  },
  "projectKpis": {
    "id": "22c99668-95d8-4fa4-99e2-8eb9a63257ed",
    "kpiId": "02a1443d-8322-4ab6-94b9-07c1921ce40d",
    "target": 1,
    "polarity": 1,
    "primary": true,
    "createdAt": "2019-03-25T10:49:07.000Z",
    "updatedAt": "2019-03-25T10:49:07.000Z"
  },
  "widgets": {
    "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
    "sizeX": 1,
    "sizeY": 1,
    "row": 1,
    "col": 1,
    "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
    "contentUrl": "test/sheets/Sheet1",
    "createdAt": "2019-03-25T10:49:07.000Z",
    "updatedAt": "2019-03-25T10:49:07.000Z"
  }
}

GET /projects/{projectId}

Retrieves a single project by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
associatedEntities query boolean false N/A Indicates whether the retrieved project should include associated reports, widgets, and KPIs. If this is true, the associated resources are included in the response. If this is false, the associated resources are not included. -

Response Statuses

Status Meaning Description Schema
200 OK OK ProjectDetail
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Reports

A report is a document created in SAP BusinessObjects or Tableau.

Add a Report

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports', headers: headers, body: {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs.","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs.","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}

Example response

{
  "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "name": "Pharmacy Utilization Summary",
  "description": "A utilization summary of all pharmacy drugs.",
  "externalSourceMnemonic": "tableau",
  "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
  "reportDataModels": {
    "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
    "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
    "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
    "createdAt": "2019-03-25T10:49:07.000Z",
    "updatedAt": "2019-03-25T10:49:07.000Z"
  },
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects/{projectId}/reports

Adds a report to a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
body body postProjectsProjectidReports true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Report
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Reports

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "name": "Pharmacy Utilization Summary",
      "description": "A utilization summary of all pharmacy drugs.",
      "externalSourceMnemonic": "tableau",
      "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
      "reportDataModels": {
        "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
        "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
        "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
        "createdAt": "2019-03-25T10:49:07.000Z",
        "updatedAt": "2019-03-25T10:49:07.000Z"
      },
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports?offset=0&limit=20"
}

GET /projects/{projectId}/reports

Retrieves a list of reports filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
name query string false N/A Filters the response by the name of the report. -
externalSourceMnemonic query string false N/A Filters the response by the external source mnemonic. -
orderBy query string false name A comma-separated list of fields by which to sort. -name, name, -createdAt, createdAt, -updatedAt, updatedAt
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK Reports
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Report

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/reports/{reportId}

Removes a report from a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
reportId path string true N/A The ID of a report. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Report

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c', headers: headers, body: {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Pharmacy Utilization Summary","description":"A utilization summary of all pharmacy drugs","externalSourceMnemonic":"tableau","sourceApplicationId":"0a19d2c9-a37e-45a3-8cf3-4e5864512c8e","dataModelIds":["05fafbf5-69a4-42a0-9c12-4ed177372837"]}

PUT /projects/{projectId}/reports/{reportId}

Updates a report of a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
reportId path string true N/A The ID of a report. -
body body putProjectsProjectidReports true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Report

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/reports/29e4ad57-360a-4a8f-97a3-7efa756a9c3c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "name": "Pharmacy Utilization Summary",
  "description": "A utilization summary of all pharmacy drugs.",
  "externalSourceMnemonic": "tableau",
  "sourceApplicationId": "0a19d2c9-a37e-45a3-8cf3-4e5864512c8e",
  "reportDataModels": {
    "id": "1b11827d-fb3b-4fa1-8870-82923c17fd2a",
    "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
    "dataModelId": "05fafbf5-69a4-42a0-9c12-4ed177372837",
    "createdAt": "2019-03-25T10:49:07.000Z",
    "updatedAt": "2019-03-25T10:49:07.000Z"
  },
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

GET /projects/{projectId}/reports/{reportId}

Retrieves a single report by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
reportId path string true N/A The ID of a report. -

Response Statuses

Status Meaning Description Schema
200 OK OK Report
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Widgets

Widgets are report views that can be embedded in an application to display a quick view of the reports.

Add a Widget

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
  "sizeX": 1,
  "sizeY": 1,
  "row": 1,
  "col": 1,
  "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "contentUrl": "test/sheets/Sheet1",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects/{projectId}/widgets

Adds a widget to a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
body body postProjectsProjectidWidgets true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Widget
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Widgets

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
      "sizeX": 1,
      "sizeY": 1,
      "row": 1,
      "col": 1,
      "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "contentUrl": "test/sheets/Sheet1",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets?offset=0&limit=20"
}

GET /projects/{projectId}/widgets

Retrieves a list of widgets filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
reportId query string false N/A The ID of a report. -
contentUrl query string false N/A The URL of the report’s source application. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK Widgets
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Widget

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/widgets/{widgetId}

Deletes a widget from the project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
widgetId path string true N/A The ID of a widget. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Widget

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /projects/{projectId}/widgets/{widgetId}

Updates a widget by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
widgetId path string true N/A The ID of a widget. -
body body putProjectsProjectidWidgets true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Widget

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/widgets/38a03244-cc06-4acd-a16b-a07a351bcbe1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "38a03244-cc06-4acd-a16b-a07a351bcbe1",
  "sizeX": 1,
  "sizeY": 1,
  "row": 1,
  "col": 1,
  "reportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "contentUrl": "test/sheets/Sheet1",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

GET /projects/{projectId}/widgets/{widgetId}

Retrieves a single widget by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
widgetId path string true N/A The ID of a widget. -

Response Statuses

Status Meaning Description Schema
200 OK OK Widget
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

KPIs

KPIs are business metrics that are used to evaluate factors that are crucial to the success of an organization.

Add a KPI

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "22c99668-95d8-4fa4-99e2-8eb9a63257ed",
  "kpiId": "02a1443d-8322-4ab6-94b9-07c1921ce40d",
  "target": 1,
  "polarity": 1,
  "primary": true,
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

POST /projects/{projectId}/kpis

Adds a KPI to a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
body body postProjectsProjectidKpis true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created ProjectKpi
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Project KPIs

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "22c99668-95d8-4fa4-99e2-8eb9a63257ed",
      "kpiId": "02a1443d-8322-4ab6-94b9-07c1921ce40d",
      "target": 1,
      "polarity": 1,
      "primary": true,
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis?offset=0&limit=20"
}

GET /projects/{projectId}/kpis

Retrieves a list of project KPIs filtered by the specified parameters.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
orderBy query string false createdAt A comma-separated list of fields by which to sort. -createdAt, createdAt, -updatedAt, updatedAt
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK ProjectKpis
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Project KPI

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /projects/{projectId}/kpis/{projectKpiId}

Removes a KPI from the project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
projectKpiId path string true N/A The ID of a project KPI. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Project KPI

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /projects/{projectId}/kpis/{projectKpiId}

Updates a KPI of a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
projectKpiId path string true N/A The ID of a project KPI. -
body body putProjectsProjectidKpis true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Project KPI

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/projects/87d015cf-2ae3-48d4-822c-9fff4d5b8570/kpis/22c99668-95d8-4fa4-99e2-8eb9a63257ed \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "22c99668-95d8-4fa4-99e2-8eb9a63257ed",
  "kpiId": "02a1443d-8322-4ab6-94b9-07c1921ce40d",
  "target": 1,
  "polarity": 1,
  "primary": true,
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

GET /projects/{projectId}/kpis/{projectKpiId}

Retrieves a single KPI that is associated with a project.

Parameters

Parameter In Type Required Default Description Accepted Values
projectId path string true N/A The ID of a project. -
projectKpiId path string true N/A The ID of a project KPI. -

Response Statuses

Status Meaning Description Schema
200 OK OK ProjectKpi
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Standard KPIs

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/kpis', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/kpis \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "02a1443e-8312-4ab6-94b7-07c1921ce40e",
      "name": "Visits",
      "description": "The Visits KPI displays the number of encounters based on the arrival date.",
      "title": "Visits",
      "reportId": "8abb592a-55c4-4868-8653-854604e10502",
      "organization": "Revenue Cycle",
      "dashboardReportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
      "createdAt": "2019-03-25T10:49:07.000Z",
      "updatedAt": "2019-03-25T10:49:07.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/kpis?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/kpis?offset=0&limit=20"
}

GET /kpis

Retrieves a list of standard KPIs.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the response by the name of the KPI. -
title query string false N/A Filters the response by the title of the KPI. -
organization query string false N/A Filters the response by the name of organization to which the KPI belongs. -
reportId query string false N/A Filters the response by the ID of the report. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK Kpis
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single KPI

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/kpis/02a1443e-8312-4ab6-94b7-07c1921ce40e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/healtheanalytics-application/v1/kpis/02a1443e-8312-4ab6-94b7-07c1921ce40e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "02a1443e-8312-4ab6-94b7-07c1921ce40e",
  "name": "Visits",
  "description": "The Visits KPI displays the number of encounters based on the arrival date.",
  "title": "Visits",
  "reportId": "8abb592a-55c4-4868-8653-854604e10502",
  "organization": "Revenue Cycle",
  "dashboardReportId": "29e4ad57-360a-4a8f-97a3-7efa756a9c3c",
  "createdAt": "2019-03-25T10:49:07.000Z",
  "updatedAt": "2019-03-25T10:49:07.000Z"
}

GET /kpis/{kpiId}

Retrieves a single KPI by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
kpiId path string true N/A The ID of a KPI. -

Response Statuses

Status Meaning Description Schema
200 OK OK Kpi
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

postProjects

Name Type Required Description Accepted Values
name string true The display name of the project. -
description string false The description of the project. -

Project

Name Type Required Description Accepted Values
id string false The unique ID of the project. -
name string false The display name of the project. -
description string false The description of the project. -
createdAt string false The date and time when the project was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the project was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

ProjectDetails

Name Type Required Description Accepted Values
items [ProjectDetail] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

ProjectDetail

Name Type Required Description Accepted Values
id string false The unique ID of the project. -
name string false The display name of the project. -
description string false The description of the project. -
createdAt string false The date and time when the project was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the project was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
reports [Report] false [Retrieves a single report by ID.] -
projectKpis [ProjectKpi] false [Retrieves a single KPI that is associated with a project.] -
widgets [Widget] false [Retrieves a single widget by ID.] -

Report

Name Type Required Description Accepted Values
id string false The unique ID of the report. -
name string false The display name of the report. -
description string false The description of the report. -
externalSourceMnemonic string false The type of external source. -
sourceApplicationId string false The ID of the report in the source application. -
reportDataModels ReportDataModel false The data models from which the report is created. -
createdAt string false The date and time when the report was added to a project, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the report was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

ReportDataModel

Name Type Required Description Accepted Values
id string false The unique ID of the report data model. -
reportId string false The ID of the report. -
dataModelId string false The ID of the data model. -
createdAt string false The date and time when the report data model was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the report data model was last updated in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

ProjectKpi

Name Type Required Description Accepted Values
id string false The unique ID of a project KPI. -
kpiId string false The ID of the standard KPI. -
target integer(int32) false The data threshold that corresponds to a set of data points. -
polarity integer(int32) false Indicates whether a higher or lower current value is desirable with respect to the user-defined target. -
primary boolean false Indicates whether the standard KPI is the primary KPI for the project. -
createdAt string false The date and time when the KPI was added to a project, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the project KPI was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

Widget

Name Type Required Description Accepted Values
id string false The unique ID of the widget. -
sizeX integer(int32) false The width of the widget. -
sizeY integer(int32) false The height of the widget. -
row integer(int32) false The x-axis coordinate of the widget. -
col integer(int32) false The y-axis coordinate of the widget. -
reportId string false The ID of the report. -
contentUrl string false The URL of the report’s source application. -
createdAt string false The date and time when the widget was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the widget was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -

putProjects

Name Type Required Description Accepted Values
name string false The display name of the project. -
description string false The description of the project. -

postProjectsProjectidReports

Name Type Required Description Accepted Values
name string true The display name of the report. -
description string false The description of the report. -
externalSourceMnemonic string true The type of external source. -
sourceApplicationId string true The ID of the report in the source application. -
dataModelIds [string] false A comma-separated list of data model IDs. -

Reports

Name Type Required Description Accepted Values
items [Report] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putProjectsProjectidReports

Name Type Required Description Accepted Values
name string false The display name of the report. -
description string false The description of the report. -
externalSourceMnemonic string false The type of external source. -
sourceApplicationId string false The ID of the report in the source application. -
dataModelIds [string] false A comma-separated list of data model IDs. -

postProjectsProjectidWidgets

Name Type Required Description Accepted Values
row integer(int32) true The x-axis coordinate of the widget. -
col integer(int32) true The y-axis coordinate of the widget. -
reportId string true The ID of the report. -
sizeX integer(int32) false The width of the widget. -
sizeY integer(int32) false The height of the widget. -
contentUrl string false The URL of the report’s source application. -

Widgets

Name Type Required Description Accepted Values
items [Widget] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putProjectsProjectidWidgets

Name Type Required Description Accepted Values
sizeX integer(int32) false The width of the widget. -
sizeY integer(int32) false The height of the widget. -
row integer(int32) false The x-axis coordinate of the widget. -
col integer(int32) false The y-axis coordinate of the widget. -
reportId string false The ID of the report. -
contentUrl string false The URL of the report’s source application. -

postProjectsProjectidKpis

Name Type Required Description Accepted Values
kpiId string true The ID of the standard KPI. -
target integer(int32) false The data threshold that corresponds to a set of data points. -
polarity integer(int32) false Indicates whether a higher or lower current value is desirable with respect to the user-defined target. -
primary boolean false Indicates whether the standard KPI is the primary KPI for the project. -

ProjectKpis

Name Type Required Description Accepted Values
items [ProjectKpi] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putProjectsProjectidKpis

Name Type Required Description Accepted Values
kpiId string false The ID of the standard KPI. -
target integer(int32) false The data threshold that corresponds to a set of data points. -
polarity integer(int32) false Indicates whether a higher or lower current value is desirable with respect to the user-defined target. -
primary boolean false Indicates whether the standard KPI is the primary KPI for the project. -

Kpis

Name Type Required Description Accepted Values
items [Kpi] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

Kpi

Name Type Required Description Accepted Values
id string false The unique ID of the KPI. -
name string false The name of the standard KPI. -
description string false The detailed description of the standard KPI. -
title string false The display title of the standard KPI. -
reportId string false The ID of the report. -
organization string false The name of the organization to which the KPI belongs. -
dashboardReportId string false The ID of the dashboard report. -
createdAt string false The date and time when the KPI was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string false The date and time when the KPI was last updated, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -