NAV
Ruby Shell

Analytics Content Management Public API v1

Note: The data retrieved by this API is not filtered based on sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.

The Analytics Content Management (ACM) product is the delivery mechanism for content in HealtheAnalytics. Content is comprised of Data Sets, Data Models, Workflows, Projects, and Reports (Tableau and SAP BusinessObjects). The content imported to ACM is stored as templates, with all tenant-specific values substituted with tokens called content parameters. Content parameters enable content to be shared with various tenants.

Content is grouped together in a package, which can be deployed to tenants. When a package is deployed to a tenant its contents are updated to substitute tokens with tenant-specific content parameter values. After a package is successfully deployed to a tenant, the content is available in HealtheAnalytics.

URL: https://cernerdemo.api.us-1.healtheintent.com/analytics-content-management/v1

Packages

Packages are a grouping of related content. A package’s contents may be comprised of of data models, data sets, workflows, projects, and reports (Tableau and BusinessObjects). Packages enable grouping of related content to be deployed to a tenant at the same time. Packages have a lineage. The first package in the lineage is considered the base package (version 1) and all other versions in the lineage derive their package ID from the base package. Packages are considered complete and no longer can be modified. If changes are required, a new draft package must be created.

List of published packages

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-1.healtheintent.com/analytics-content-management/v1/packages', headers: headers)

print JSON.pretty_generate(result)


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

GET /packages

Retrieves a list of Published packages.

Parameters

Parameter In Type Required Default Description Accepted Values
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 List of published packages Packages
400 Bad Request Bad Request BadRequest
401 Unauthorized Unauthorized Unauthorized
403 Forbidden Forbidden Forbidden

Draft Packages

A draft package is a package that has not been published and is not available for deployment. The name, description, and contents of a package may be modified. Once a draft package is approved it may be published.

List draft packages.

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-1.healtheintent.com/analytics-content-management/v1/draft-packages', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/analytics-content-management/v1/draft-packages \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

GET /draft-packages

Retrieves a list of draft packages.

Parameters

Parameter In Type Required Default Description Accepted Values
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 List draft packages. DraftPackages
400 Bad Request Bad Request BadRequest
401 Unauthorized Unauthorized Unauthorized
403 Forbidden Forbidden Forbidden

Publish a draft package

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-1.healtheintent.com/analytics-content-management/v1/draft-packages/{packageId}/publish', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/analytics-content-management/v1/draft-packages/{packageId}/publish \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

POST /draft-packages/{packageId}/publish

Sets a package status to Published and makes it available to authorized tenants.

Parameters

Parameter In Type Required Default Description Accepted Values
packageId path string true N/A The ID of the draft package. -
body body array[string] false N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Ok None
400 Bad Request Bad Request BadRequest
401 Unauthorized Unauthorized Unauthorized
403 Forbidden Forbidden Forbidden
404 Not Found Not Found NotFound

Schema Definitions

Package

Name Type Required Description Accepted Values
id string true The unique ID of a package. -
name string true The human-friendly name of the Package. This value cannot exceed 255 characters. -
tenant TenantIdReference true The tenant that created the package. -
version integer(int32) true The current version of the package. -
basePackage BasePackageIdReference true The base package. -
contentParameters [string] true An array of the content parameters present in the contents of the package. -

TenantIdReference

Name Type Required Description Accepted Values
id string true The ID of the tenant. -

BasePackageIdReference

Name Type Required Description Accepted Values
id string true The ID of the base package. -

DraftPackage

Name Type Required Description Accepted Values
id string true The unique ID of the package. -
name string true The human-friendly name of the package. This value cannot exceed 255 characters. -
description string true The user defined description of the package. This value cannot exceed 2000 characters. -
version integer(int32) true The current version of the package. -
basePackage BasePackageIdReference true The base package. -

Packages

Name Type Required Description Accepted Values
items [Package] 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. -

BadRequest

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 [string] false A list of additional error details. -

Unauthorized

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 [string] false A list of additional error details. -

Forbidden

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 [string] false A list of additional error details. -

DraftPackages

Name Type Required Description Accepted Values
items [DraftPackage] 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. -

NotFound

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 [string] false A list of additional error details. -