require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\-H'Accept: application/json'
Example response
{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","name":"Example Name Inc.","siteExperienceDomain":"portaleng.patientportal.us.staginghealtheintent.com","enabled":"false","iosAppConfig":{"bundleId":"com.cerner.iris","distributionCert":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"provisioningProfile":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"apnsCert":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"icons":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","url":"https://s3.aws.com/file_path","type":"APP_SECURITY_SCREEN"}],"buildVariables":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","key":"IDP_CLIENT_ID","value":"JKF3kjafsle463LAKJF44lkadfmxivo","platform":"iOS"}]},"androidAppConfig":{"packageName":"com.cerner.iris.play","googleServicesJson":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"playServiceAccountJson":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"keystore":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"icons":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","url":"https://s3.aws.com/file_path","type":"APP_SECURITY_SCREEN"}],"buildVariables":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","key":"IDP_CLIENT_ID","value":"JKF3kjafsle463LAKJF44lkadfmxivo","platform":"iOS"}]},"assets":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","url":"https://s3.aws.com/file-path","name":"Dashboard background"}]}
The location of the newly created mobile configuration.
Retrieve an Index of All Mobile Configurations
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","name":"Example Name Inc.","siteExperienceDomain":"portaleng.patientportal.us.staginghealtheintent.com","enabled":"false","iosAppConfig":{"bundleId":"com.cerner.iris","distributionCert":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"provisioningProfile":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"apnsCert":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"icons":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","url":"https://s3.aws.com/file_path","type":"APP_SECURITY_SCREEN"}],"buildVariables":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","key":"IDP_CLIENT_ID","value":"JKF3kjafsle463LAKJF44lkadfmxivo","platform":"iOS"}]},"androidAppConfig":{"packageName":"com.cerner.iris.play","googleServicesJson":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"playServiceAccountJson":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"keystore":{"id":"1234","type":"IosDistribution","url":"https://s3.aws.com/file_path","password":"Jljf3243$#%","keyAlias":"HealtheLifeKeystore","auxiliaryPassword":"aklsdjf;klasjd#$R#%"},"icons":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","url":"https://s3.aws.com/file_path","type":"APP_SECURITY_SCREEN"}],"buildVariables":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","key":"IDP_CLIENT_ID","value":"JKF3kjafsle463LAKJF44lkadfmxivo","platform":"iOS"}]},"assets":[{"id":"262038ed-c304-4737-93d9-55615b6a1cd5","url":"https://s3.aws.com/file-path","name":"Dashboard background"}]}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"}
GET /mobile-configs
Retrieves configurations for all applications under the client.
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}\-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/ios-config',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/ios-config \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\-H'Accept: application/json'
PUT /mobile-configs/{mobileConfigId}/ios-config
Updates the Apple iOS configuration items for a mobile application.
Retrieve the Mobile Application’s Apple iOS Configuration by ID
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/ios-config',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/ios-config \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Retrieve an Index of All Icons on the Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons \-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /mobile-configs/{mobileConfigId}/android-config/icons
Retrieves all icons configured for a mobile application’s configuration.
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/x-www-form-urlencoded','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons \-H'Authorization: {auth_header}'\-H'Content-Type: application/x-www-form-urlencoded'\-H'Accept: application/json'
POST /mobile-configs/{mobileConfigId}/android-config/icons
The location of the newly created icon configuration.
Delete an Icon
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons/{iconId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons/{iconId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/x-www-form-urlencoded','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons/{iconId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons/{iconId}\-H'Authorization: {auth_header}'\-H'Content-Type: application/x-www-form-urlencoded'\-H'Accept: application/json'
PUT /mobile-configs/{mobileConfigId}/android-config/icons/{iconId}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons/{iconId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/icons/{iconId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /mobile-configs/{mobileConfigId}/android-config/icons/{iconId}
Retrieves a single icon by ID from a mobile application’s configuration.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/x-www-form-urlencoded','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates \-H'Authorization: {auth_header}'\-H'Content-Type: application/x-www-form-urlencoded'\-H'Accept: application/json'
POST /mobile-configs/{mobileConfigId}/android-config/certificates
The location of the newly created certificate configuration.
Delete a Certificate
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}
Retrieves a single certificate for a configuration.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/x-www-form-urlencoded','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}\-H'Authorization: {auth_header}'\-H'Content-Type: application/x-www-form-urlencoded'\-H'Accept: application/json'
PUT /mobile-configs/{mobileConfigId}/android-config/certificates/{certificateId}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\-H'Accept: application/json'
PUT /mobile-configs/{mobileConfigId}/android-config
Updates the Google Android configuration items for a mobile application.
Retrieve the Mobile Application’s Google Android Configuration by ID
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/android-config \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Retrieve an Index of Variables for a Mobile Configuration
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables \-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /mobile-configs/{mobileConfigId}/build-variables
Retrieves all build variables for a mobile configuration.
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\-H'Accept: application/json'
POST /mobile-configs/{mobileConfigId}/build-variables
Creates a new build variable for a given platform.
The location of the newly created build variable configuration.
Delete a Single Build Variable by ID
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables/{variableID}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables/{variableID}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables/{variableID}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables/{variableID}\-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\-H'Accept: application/json'
PUT /mobile-configs/{mobileConfigId}/build-variables/{variableID}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables/{variableID}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/build-variables/{variableID}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /mobile-configs/{mobileConfigId}/build-variables/{variableID}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets \-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /mobile-configs/{mobileConfigId}/assets
Retrieves all assets for a mobile configuration.
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/x-www-form-urlencoded','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets \-H'Authorization: {auth_header}'\-H'Content-Type: application/x-www-form-urlencoded'\-H'Accept: application/json'
The location of the newly created asset configuration.
Delete an Asset
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets/{assetID}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets/{assetID}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/x-www-form-urlencoded','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets/{assetID}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets/{assetID}\-H'Authorization: {auth_header}'\-H'Content-Type: application/x-www-form-urlencoded'\-H'Accept: application/json'
PUT /mobile-configs/{mobileConfigId}/assets/{assetID}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets/{assetID}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/mobile-configs/{mobileConfigId}/assets/{assetID}\-H'Authorization: {auth_header}'\-H'Accept: application/json'
GET /mobile-configs/{mobileConfigId}/assets/{assetID}
Retrieves a single asset for a mobile configuration.
The Terms and Conditions endpoints enable customizing and capturing the acceptance of terms and conditions. The endpoints allow interaction with the following resources:
Terms of Use: A terms of use agreement outlines the rules and regulations that HealtheIntent consumers agree to follow to use the application. HealtheIntent tenants can customize the terms of use that are presented to the HealtheIntent consumer.
Privacy Policy: A privacy policy helps users understand what information Cerner has access to and how Cerner may use and share that information with others. HealtheIntent tenants can customize the privacy policies that are presented to the HealtheIntent consumer.
Terms of Use Acceptance: A terms of use acceptance allows HealtheIntent consumers to access the application. HealtheIntent consumers cannot access the digital experience until they accept the terms of use.
Remove a Terms Of Use
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
DELETE /terms-of-use/{instanceId}
Remove a single terms of use for a given HealtheIntent tenant.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"instanceId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","createdAt":"2019-04-16T19:33:29.000Z","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}
GET /terms-of-use/{instanceId}
Retrieves a single terms of use for a given HealtheIntent tenant.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use',headers: headers,body: {"touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}
Example response
{"instanceId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","createdAt":"2019-04-16T19:33:29.000Z","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}
POST /terms-of-use
Creates a terms of use for a given HealtheIntent tenant.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"instanceId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","createdAt":"2019-04-16T19:33:29.000Z","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use?offset=0&limit=20"}
GET /terms-of-use
Retrieves all the available terms of use agreements for a given HealtheIntent tenant.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
touId
query
string
false
N/A
Filters by the ID of the terms of use.
-
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c \-H'Authorization: {auth_header}'\-H'Accept: application/json'
DELETE /privacy-policies/{instanceId}
Remove a single privacy policy for a given HealtheIntent tenant.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"instanceId":"adea0443-60a9-4086-8383-071d1d62210c","privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","createdAt":"2019-04-16T16:33:29.000Z","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]}
GET /privacy-policies/{instanceId}
Retrieves a single privacy policy for a given HealtheIntent tenant.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"instanceId":"adea0443-60a9-4086-8383-071d1d62210c","privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","createdAt":"2019-04-16T16:33:29.000Z","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies?offset=0&limit=20"}
GET /privacy-policies
Retrieves all the available privacy policies for a given HealtheIntent tenant.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
privacyPolicyId
query
string
false
N/A
Filters by the ID of the privacy policy.
-
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies',headers: headers,body: {"privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]}
Example response
{"instanceId":"adea0443-60a9-4086-8383-071d1d62210c","privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","createdAt":"2019-04-16T16:33:29.000Z","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]}
POST /privacy-policies
Creates a privacy policy for a given HealtheIntent tenant.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Retrieves all the available terms of use acceptances for a given HealtheIntent tenant.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
consumerId
query
string
false
N/A
Filters by the ID of the HealtheIntent consumer.
-
touId
query
string
false
N/A
Filters by the ID of the terms of use.
-
domainName
query
string
false
N/A
Filters by the domain name of the terms of use.
-
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances',headers: headers,body: {"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"consumer":{"id":"32b567c3-5989-4ca0-96f3-aa63442d2ce1"},"domainName":"demo.cernerdemo.us.healtheintent.com"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"consumer":{"id":"32b567c3-5989-4ca0-96f3-aa63442d2ce1"},"domainName":"demo.cernerdemo.us.healtheintent.com"}
The location of the newly created terms of use acceptance.
Retrieve a Single Terms Of Use Acceptance
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances/699f703a-8095-4c77-90f2-d1385f92c1a7',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances/699f703a-8095-4c77-90f2-d1385f92c1a7 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
A role is a label that is applied to a HealtheIntent consumer in the Application Experience service and can be used to provide a contextualized experience based on the role. A HealtheIntent consumer’s roles can change on each site.
Create a Role
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles',headers: headers,body: {"name":"MEMBER"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"MEMBER"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Retrieves all of the available roles for a HealtheIntent tenant.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
name
query
string
false
N/A
Filters by the name of the role.
-
roleId
query
array[string]
false
N/A
Filters by the ID of the role.
-
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476',headers: headers,body: {"name":"MEMBER"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"MEMBER"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
A page can be created from many different application manifest views and can be combined in a layout to create a unique page. A common use case for a page is to create a dashboard composed of many different views from different applications specific to a certain set of roles.
Create a Page
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages',headers: headers,body: {"path":"/pages/home","alias":"home","roles":[{"name":"CONSUMER"}],"layout":{"key":"onecolumn"},"views":[{"kind":"applicationExperience#appManifest","appId":"dd9-b62b-4f6b-98b0-10b9ef10","viewName":"list","regionId":"single","order":"8"}],"name":"My home page"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"path":"/pages/home","alias":"home","roles":[{"name":"CONSUMER"}],"layout":{"key":"onecolumn"},"views":[{"kind":"applicationExperience#appManifest","appId":"dd9-b62b-4f6b-98b0-10b9ef10","viewName":"list","regionId":"single","order":"8"}],"name":"My home page"}
Example response
{"id":"d611c71d-0d62-42c5-88b4-1e34b4beb142","path":"/pages/home","alias":"home","name":"My home page","roles":[{"name":"CONSUMER"}],"layout":{"key":"onecolumn"},"views":[{"kind":"applicationExperience#appManifest","appId":"dd9-b62b-4f6b-98b0-10b9ef10","viewName":"list","regionId":"single","order":"8"}]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"d611c71d-0d62-42c5-88b4-1e34b4beb142","path":"/pages/home","alias":"home","name":"My home page","roles":[{"name":"CONSUMER"}],"layout":{"key":"onecolumn"},"views":[{"kind":"applicationExperience#appManifest","appId":"dd9-b62b-4f6b-98b0-10b9ef10","viewName":"list","regionId":"single","order":"8"}]}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages?offset=0&limit=20"}
GET /pages
Retrieves a list of pages.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
id
query
array[string]
false
N/A
Filters by the ID of the page.
-
order
query
array[string]
false
N/A
Sorting parameters for a list of pages.
-
name
query
string
false
N/A
Search parameter for a list of pages.
-
site_id
query
array[string]
false
N/A
The unique ID of the site.
-
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142',headers: headers,body: {"path":"/pages/home","alias":"home","roles":[{"name":"CONSUMER"}],"layout":{"key":"onecolumn"},"views":[{"kind":"applicationExperience#appManifest","appId":"dd9-b62b-4f6b-98b0-10b9ef10","viewName":"list","regionId":"single","order":"8"}],"name":"My home page"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"path":"/pages/home","alias":"home","roles":[{"name":"CONSUMER"}],"layout":{"key":"onecolumn"},"views":[{"kind":"applicationExperience#appManifest","appId":"dd9-b62b-4f6b-98b0-10b9ef10","viewName":"list","regionId":"single","order":"8"}],"name":"My home page"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"id":"d611c71d-0d62-42c5-88b4-1e34b4beb142","path":"/pages/home","alias":"home","name":"My home page","roles":[{"name":"CONSUMER"}],"layout":{"key":"onecolumn"},"views":[{"kind":"applicationExperience#appManifest","appId":"dd9-b62b-4f6b-98b0-10b9ef10","viewName":"list","regionId":"single","order":"8"}]}
A layout is a grid with regions that control where a view is placed on a page. Cerner provides Cerner-generated content and allows clients to create their own.
Delete a Layout
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448',headers: headers,body: {"key":"onecolumn","defaultConfig":{"rows":[{"height":"auto"}]},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rows":[{"height":"auto"}]}}],"regions":[{"defaultConfig":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1"},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1","styles":{"marginLeft":"1","marginRight":"1","marginTop":"1","marginBottom":"1","paddingLeft":"1","paddingRight":"1","paddingTop":"1","paddingBottom":"1"}}}],"pageletGap":"auto"}],"name":"My perfect layout"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"key":"onecolumn","defaultConfig":{"rows":[{"height":"auto"}]},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rows":[{"height":"auto"}]}}],"regions":[{"defaultConfig":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1"},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1","styles":{"marginLeft":"1","marginRight":"1","marginTop":"1","marginBottom":"1","paddingLeft":"1","paddingRight":"1","paddingTop":"1","paddingBottom":"1"}}}],"pageletGap":"auto"}],"name":"My perfect layout"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts',headers: headers,body: {"key":"onecolumn","defaultConfig":{"rows":[{"height":"auto"}]},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rows":[{"height":"auto"}]}}],"regions":[{"defaultConfig":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1"},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1","styles":{"marginLeft":"1","marginRight":"1","marginTop":"1","marginBottom":"1","paddingLeft":"1","paddingRight":"1","paddingTop":"1","paddingBottom":"1"}}}],"pageletGap":"auto"}],"name":"My perfect layout"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"key":"onecolumn","defaultConfig":{"rows":[{"height":"auto"}]},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rows":[{"height":"auto"}]}}],"regions":[{"defaultConfig":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1"},"responsiveConfigs":[{"breakpoint":"LARGE","config":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1","styles":{"marginLeft":"1","marginRight":"1","marginTop":"1","marginBottom":"1","paddingLeft":"1","paddingRight":"1","paddingTop":"1","paddingBottom":"1"}}}],"pageletGap":"auto"}],"name":"My perfect layout"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
A role criteria is a rule that maps external labels and IDs such as consumer groups to a specific role. Role criteria can be used to build the rules that determine a role for a HealtheIntent consumer.
Create a Role Criteria
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria',headers: headers,body: {"roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","consumerGroupIds":["591f9612-deef-4e0a-96c9-8e9b749c2eea","f5380953-564b-4037-80c8-10395f1c9384"]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","consumerGroupIds":["591f9612-deef-4e0a-96c9-8e9b749c2eea","f5380953-564b-4037-80c8-10395f1c9384"]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Retrieves all of the available role criteria for a role.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
roleId
query
string
false
N/A
Filters by the role resource.
-
criteriaId
query
array[string]
false
N/A
Filters by the criteria ID.
-
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569',headers: headers,body: {"roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","consumerGroupIds":["591f9612-deef-4e0a-96c9-8e9b749c2eea","f5380953-564b-4037-80c8-10395f1c9384"]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","consumerGroupIds":["591f9612-deef-4e0a-96c9-8e9b749c2eea","f5380953-564b-4037-80c8-10395f1c9384"]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
A consumer role is the translation from HealtheIntent consumer groups to roles in the Application Experience service. A consumer role resolves a HealtheIntent consumer’s available groups and maps the groups to roles using role criteria.
Remove a Consumer From a Consumer Role
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/consumer-roles',query: {'consumerId'=>'string','domainName'=>'string','roleId'=>'string'},headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/consumer-roles?consumerId=772adbb6-d0c9-46e1-acd5-a5c07c325f88&domainName=cernerdemo.wellness.us.healtheintent.com&roleId=772adbb6-d0c9-46e1-acd5-a5c07c325f89 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
DELETE /consumer-roles
Removes a consumer from a consumer role for the given domain.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
consumerId
query
string
true
N/A
The ID of the consumer to remove from the role.
-
domainName
query
string
true
N/A
The domain name of the site for which to remove the consumer from the role.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/consumer-roles',headers: headers,body: {"consumerId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","domainName":"cernerdemo.wellness.us.healtheintent.com","roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f89"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/consumer-roles \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"consumerId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","domainName":"cernerdemo.wellness.us.healtheintent.com","roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f89"}
POST /consumer-roles
Adds a consumer to a consumer role for the given domain.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/consumer-roles',query: {'consumerId'=>'string'},headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/consumer-roles?consumerId=772adbb6-d0c9-46e1-acd5-a5c07c325f88 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Retrieves the list of consumer roles IDs for the given consumer.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
consumerId
query
string
true
N/A
The ID of the consumer for whom to look up roles.
-
domainName
query
array[string]
false
N/A
The domain name or names of the site or sites from which to look up roles. Include multiple domainName query parameters to find roles from a list of sites.
A site contains the metadata required to configure a consumer portal, is feature-agnostic, and can be configured to embed HealtheIntent, Cerner, client, and even third-party applications and features. A single tenant can be configured to have many sites. For example, a tenant might choose to have a site for production and another site to stage configuration changes. Another use case is that a tenant could have various sites configured for a wellness offering, each of which is for a different employer in a single HealtheIntent population.
Delete a Site
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569',headers: headers,body: {"name":"CernerInOutbox","alerts":[{"id":"96669af8-5a1d-40d5-8000-50936ee57ca6"}],"applications":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"identityRealms":[{"realmId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","isDefault":"true","keepAliveUrl":"https://cernerhealth.com/keep-alive"}],"locales":[{"locale":"en-US","isDefault":"true"}],"pages":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"support":{"email":"support@example.com","phone":"123-456-1234"},"brand":[{"id":"b3f518f8-9361-4bf2-9cc7-5e4bfea85eee"}],"navs":[{"roles":[{"name":"CONSUMER"}],"priority":"2","type":["primary_navigation","profile_navigation","quick_navigation"],"id":"4b56b495-2445-4cec-91de-9330638261ac"}],"roleCriteria":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"customScripts":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"privacyPolicy":{"id":"adea0443-60a9-4086-8383-071d1d62210c"},"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"titles":[{"text":"Dashboard","locale":"en-US"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"CernerInOutbox","alerts":[{"id":"96669af8-5a1d-40d5-8000-50936ee57ca6"}],"applications":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"identityRealms":[{"realmId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","isDefault":"true","keepAliveUrl":"https://cernerhealth.com/keep-alive"}],"locales":[{"locale":"en-US","isDefault":"true"}],"pages":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"support":{"email":"support@example.com","phone":"123-456-1234"},"brand":[{"id":"b3f518f8-9361-4bf2-9cc7-5e4bfea85eee"}],"navs":[{"roles":[{"name":"CONSUMER"}],"priority":"2","type":["primary_navigation","profile_navigation","quick_navigation"],"id":"4b56b495-2445-4cec-91de-9330638261ac"}],"roleCriteria":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"customScripts":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"privacyPolicy":{"id":"adea0443-60a9-4086-8383-071d1d62210c"},"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"titles":[{"text":"Dashboard","locale":"en-US"}]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites',headers: headers,body: {"name":"CernerInOutbox","alerts":[{"id":"96669af8-5a1d-40d5-8000-50936ee57ca6"}],"applications":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"identityRealms":[{"realmId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","isDefault":"true","keepAliveUrl":"https://cernerhealth.com/keep-alive"}],"locales":[{"locale":"en-US","isDefault":"true"}],"pages":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"support":{"email":"support@example.com","phone":"123-456-1234"},"brand":[{"id":"b3f518f8-9361-4bf2-9cc7-5e4bfea85eee"}],"navs":[{"roles":[{"name":"CONSUMER"}],"priority":"2","type":["primary_navigation","profile_navigation","quick_navigation"],"id":"4b56b495-2445-4cec-91de-9330638261ac"}],"roleCriteria":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"customScripts":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"privacyPolicy":{"id":"adea0443-60a9-4086-8383-071d1d62210c"},"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"titles":[{"text":"Dashboard","locale":"en-US"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"CernerInOutbox","alerts":[{"id":"96669af8-5a1d-40d5-8000-50936ee57ca6"}],"applications":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"identityRealms":[{"realmId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","isDefault":"true","keepAliveUrl":"https://cernerhealth.com/keep-alive"}],"locales":[{"locale":"en-US","isDefault":"true"}],"pages":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"support":{"email":"support@example.com","phone":"123-456-1234"},"brand":[{"id":"b3f518f8-9361-4bf2-9cc7-5e4bfea85eee"}],"navs":[{"roles":[{"name":"CONSUMER"}],"priority":"2","type":["primary_navigation","profile_navigation","quick_navigation"],"id":"4b56b495-2445-4cec-91de-9330638261ac"}],"roleCriteria":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"customScripts":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}],"privacyPolicy":{"id":"adea0443-60a9-4086-8383-071d1d62210c"},"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"titles":[{"text":"Dashboard","locale":"en-US"}]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
Navigations are the configurations of site links for primary and account navigation.
Create a Navigation
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations',headers: headers,body: {"type":"primary","name":"SiteNav","navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":true,"navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":false}]}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"type":"primary","name":"SiteNav","navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":true,"navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":false}]}]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569',headers: headers,body: {"type":"primary","name":"SiteNav","navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":true,"navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":false}]}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"type":"primary","name":"SiteNav","navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":true,"navItems":[{"target":"_blank","path":"_blank","kind":"appExperience#page","id":"customPage:alias","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","titles":[{"text":"Dashboard","locale":"en-US"}],"isMegaMenu":false}]}]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
A Site Definition is a snapshot of a Site and some related configuration. Site Definitions, Site Experiences, and Domains are closely related: When a user visits a Domain, they see a Site Experience that is chosen from the Site Definition that is associated to that Domain.
Site Definitions can be used to update site configuration changes: When you make a change to a Site or its related configuration (e.g. Pages, Navigation or Brand) you can create a new Site Definition and then associate that new definition with the Domain.
You can revert most configuration changes by associating a Domain to an older Site Definition.
Site Definitions cannot be modified; they are immutable so that all the visitors to a Domain see the same application experience.
Delete a Site Definition
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions/99e73e70-27fe-4b9f-93f2-0e1e0792b289',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions/99e73e70-27fe-4b9f-93f2-0e1e0792b289 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
DELETE /site-definitions/{siteDefinitionId}
Deletes a single site definition by its ID. If a domain is associated with the site definition, then first remove the association before deleting the site definition.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions',headers: headers,body: {"siteId":"eea2d24d-a978-4132-afdd-30429789b569"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"siteId":"eea2d24d-a978-4132-afdd-30429789b569"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions',query: {'domainName'=>'string'},headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions?domainName=cernerdemo.wellness.us.healtheintent.com \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"siteDefinition":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","site_id":"35c39425-e0fe-49c0-8880-1855ac1c0718","name":"WELLNESS","applications":[{"appManifest":[{"name":"CernerMessaging","vendor":"Cerner","title":"CernerMessaging","owner":"Cerner","version":"1.0.0","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}]}],"locales":[{"locale":"en-US","isDefault":"true"}],"brand":{"logo":{"src":"https://example.com/logo.png","height":"10","width":"20","altTexts":[{"text":"English Localized Text","locale":"en-US"}]},"favicons":{"iconType":"apple-touch-icon","sizes":"120x120","href":"https://example.com/favicon.png"},"themes":[{"name":"Cernerdemo Main Theme","properties":[{"name":"background-color","value":"#112233"}],"breakpoint":"HUGE"}]},"identityRealms":[{"realmId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","isDefault":"true","idpKeepAliveUrl":"https://cernerhealth.com/keep-alive"}],"customScripts":[{"src":"https://example.com/custom.js","text":"console.log()","integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC","async":"false","defer":"false"}],"siteTitles":[{"text":"English Localized Text","locale":"en-US"}],"loggingUris":[{"uri":"https://logging-location.com/log"}],"email":"support@example.com","phone":"1112223333","mobile":{"appBannerConfig":{"ios":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","name":"HealtheLife","deviceType":"Android","enabled":"false","storeId":"com.cerner.wellness.healthypath.play","icon":"http://ip-visprod.northamerica.cerner.net/adobe/SolutionBranding/HealtheLife/LaunchIcons/iOS/HealtheLifePROD/HealtheLife_76.png","bannerTranslations":[{"title":"HealtheLife App","locale":"en-US"}]},"android":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","name":"HealtheLife","deviceType":"Android","enabled":"false","storeId":"com.cerner.wellness.healthypath.play","icon":"http://ip-visprod.northamerica.cerner.net/adobe/SolutionBranding/HealtheLife/LaunchIcons/iOS/HealtheLifePROD/HealtheLife_76.png","bannerTranslations":[{"title":"HealtheLife App","locale":"en-US"}]}}},"privacyPolicy":{"instanceId":"adea0443-60a9-4086-8383-071d1d62210c","privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","createdAt":"2019-04-16T16:33:29.000Z","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]},"termsOfUse":[{"instanceId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","createdAt":"2019-04-16T19:33:29.000Z","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}],"termsOfUseId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","roleCriteria":[{"roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","roleName":"MEMBER","consumerGroupIds":["772adbb6-d0c9-46e1-acd5-a5c07c325f88"]}],"uniquePageletDomains":["https://s3-us-west-2.amazonaws.com","https://pages.github.com"],"alerts":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","messageText":[{"text":"English Localized Text","locale":"en-US"}],"expireDate":"2020-06-08"}]}]}
GET /site-definitions
Retrieves a site definition record by the domain name.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
domainName
query
string
true
N/A
The name of the domain that is associated with the site definition.
A site experience is a set of contextualized configurations used when displaying a site. The contents are specific to a HealtheIntent consumer. These configurations are generated using the consumer role mapping.
A Site Experience defines the navigation and content that a user should be served based on the user’s Consumer Roles. Site Experiences are closely related to Domains and Site Definitions: When a user visits a Domain, they see a Site Experience that is chosen from the Domain’s Site Definition.
Retrieve a Single Site Experience
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-experiences',query: {'domainName'=>'string'},headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-experiences?domainName=cernerdemo.wellness.us.healtheintent.com \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"siteExperience":[{"navigation":{"primaryNavigation":{"name":"Cernerdemo Main Navigation","type":"primary","navItems":[{"target":"_blank","uri":"https://example.com","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","title":"Home","isMegaMenu":true,"navItems":[{"target":"_blank","uri":"https://example.com","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","title":"Home","isMegaMenu":false}]}]},"profileNavigation":{"name":"Cernerdemo Main Navigation","type":"primary","navItems":[{"target":"_blank","uri":"https://example.com","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","title":"Home","isMegaMenu":false,"navItems":[{"target":"_blank","uri":"https://example.com","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","title":"Home","isMegaMenu":false}]}]},"quickNavigation":{"name":"Cernerdemo Main Navigation","type":"primary","navItems":[{"target":"_blank","uri":"https://example.com","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","title":"Home","isMegaMenu":true,"navItems":[{"target":"_blank","uri":"https://example.com","icon":"https://healtheintent.com/glyph_maps-location_32px_pin-share.svg","title":"Home","isMegaMenu":false}]}]}},"routingGroup":{"name":"Cernerdemo Routing","routes":[{"path":"/pages/home","alias":"home-page","resources":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f8","page":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","name":"Test Page","defaultConfig":{"rows":[{"height":"auto"}]},"responsiveConfigs":[{"config":[{"rows":[{"height":"auto"}]}]}],"regions":[{"pageletIds":["772adbb6-d0c9-46e1-acd5-a5c07c325f88"],"pagelets":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","type":"FRAMED","config":{"url":"https://example.com","accessibilityTitle":"Medications","manifestUrl":"https://example.com/manifest.json","entryName":"App","name":"Image Carousel","templateKey":"Image Carousel","description":"Image Carousel","properties":{"carouselItems":[{"imageUrl":"https://example.com/image.png","imageLink":"https://example-content.com"},{"imageUrl":"https://example.com/image2.png","imageLink":"https://example2-content.com"}],"title":"Image Carousel Title","titleColor":"#000000"}}}],"pageletGap":"auto","defaultConfig":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1","styles":{"marginLeft":"1","marginRight":"1","marginTop":"1","marginBottom":"1","paddingLeft":"1","paddingRight":"1","paddingTop":"1","paddingBottom":"1"}},"responsiveConfigs":[{"config":{"rowStart":"1","rowEnd":"1","columnStart":"1","columnEnd":"1","styles":{"marginLeft":"1","marginRight":"1","marginTop":"1","marginBottom":"1","paddingLeft":"1","paddingRight":"1","paddingTop":"1","paddingBottom":"1"}}}]}]},"kind":"extensible-app-framework#page"}]}]}}]}
GET /site-experiences
Retrieves a site experience for the given consumer, domain, and locale.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
domainName
query
string
true
N/A
The domain name of the site from which to look up the site experience.
-
roleIds
query
array[string]
false
N/A
Filters the retrieved site experiences by a list of role IDs.
-
roleNames
query
array[string]
false
N/A
Filters the retrieved site experience by a list of role names.
-
locale
query
string
false
N/A
Filters by the locale of the site experience. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-).
A Domain defines what the user sees when they visit a web domain (e.g. example.com). Users can either see a Site Experience (some navigation and content) or be redirected to another URL.
Domains are closely related to Site Experiences and Site Definitions: When a user visits a Domain, they see a Site Experience that is chosen from the Domain’s Site Definition.
Deletes a Domain
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com \-H'Authorization: {auth_header}'\-H'Accept: application/json'
DELETE /domains/{domainName}
Deletes a single domain for Consumer Framework.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
domainName
path
string
true
N/A
The unique domain name without the protocol or path for a domain resource.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com',headers: headers,body: {"siteDefinitionId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","authorizedPersonnel":[{"id":"973ed0ef-894d-43bc-b756-70a65712bde7"}],"redirectTo":"https://healthelife.healtheintent.com/working_on_the_site.html","ttl":"300"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"siteDefinitionId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","authorizedPersonnel":[{"id":"973ed0ef-894d-43bc-b756-70a65712bde7"}],"redirectTo":"https://healthelife.healtheintent.com/working_on_the_site.html","ttl":"300"}
PUT /domains/{domainName}
Creates or updates the attributes of a domain record for a given domain name.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Filters by the ID of the authorized personnel group.
-
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.
An affiliate domain is a domain that is connected to one or more higher level, or master, domains as a child. A domain can be affiliated with many child domains.
Retrieve a List of Affiliate Domains
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com/affiliate-domains',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com/affiliate-domains \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"domainName":"cernerdemomaster.well-being-sites.us.healtheintent.com","siteDefinition":[{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","name":"WELLNESS","locales":[{"locale":"en-US","isDefault":"true"}],"brand":{"logo":{"src":"https://example.com/logo.png","height":"10","width":"20","altTexts":[{"text":"English Localized Text","locale":"en-US"}]},"favicons":{"iconType":"apple-touch-icon","sizes":"120x120","href":"https://example.com/favicon.png"},"themes":[{"name":"Cernerdemo Main Theme","properties":[{"name":"background-color","value":"#112233"}],"breakpoint":"HUGE"}]},"identityRealms":[{"realmId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","isDefault":"true","idpKeepAliveUrl":"https://cernerhealth.com/keep-alive"}],"siteTitles":[{"text":"English Localized Text","locale":"en-US"}],"roleCriteria":[{"id":"eea2d24d-a978-4132-afdd-30429789b569","roleId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","consumerGroupIds":["591f9612-deef-4e0a-96c9-8e9b749c2eea","f5380953-564b-4037-80c8-10395f1c9384"]}]}]}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/:domainName/affiliate-domains?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/:domainName/affiliate-domains?offset=0&limit=20"}
GET /domains/{domainName}/affiliate-domains
Retrieves all the affiliated domains and the site data related to them for a given master domain.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
domainName
path
string
true
N/A
The unique URL ID for the master domain resource.
-
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.
An application is a set of configurations, properties, and values required to make an application manifest available to a tenant’s site. The system references applications when building the site and generates a route for each view in the application manifest.
Delete an Application
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476',headers: headers,body: {"name":"Cerner App","appManifest":{"id":"00322720-0mw2-0959-a24d-888la147b476"},"roles":[{"name":"CONSUMER_ACCESS_GROUP"}],"properties":[{"input":"demo.wellness.us.healtheintent.com","property":"wellness_domain_host"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"Cerner App","appManifest":{"id":"00322720-0mw2-0959-a24d-888la147b476"},"roles":[{"name":"CONSUMER_ACCESS_GROUP"}],"properties":[{"input":"demo.wellness.us.healtheintent.com","property":"wellness_domain_host"}]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications',headers: headers,body: {"name":"Cerner App","appManifest":{"id":"00322720-0mw2-0959-a24d-888la147b476"},"roles":[{"name":"CONSUMER_ACCESS_GROUP"}],"properties":[{"input":"demo.wellness.us.healtheintent.com","property":"wellness_domain_host"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"Cerner App","appManifest":{"id":"00322720-0mw2-0959-a24d-888la147b476"},"roles":[{"name":"CONSUMER_ACCESS_GROUP"}],"properties":[{"input":"demo.wellness.us.healtheintent.com","property":"wellness_domain_host"}]}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications \-H'Authorization: {auth_header}'\-H'Accept: application/json'
The ID of the application manifest to which the application is connected.
-
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.
An application manifest is a JSON representation from the developer of an application. It describes the application using views that are available to display on a site. The values of the application manifest’s properties are defined when the application is made available for a tenant. Cerner provides application manifests for the Patient Portal and Consumer Well-being applications. A third-party vendor or a client acting as a developer can add their own content.
Delete an Application Manifest
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
DELETE /app-manifests/{appManifestId}
Deletes the application manifest with the specified ID.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496',headers: headers,body: {"name":"CernerMessaging","version":"1.0.0","title":"CernerMessaging","vendor":"Cerner","owner":"Cerner","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"inputs":[{"name":"portal_domain_host","type":"String","description":"Domain of patient portal"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"CernerMessaging","version":"1.0.0","title":"CernerMessaging","vendor":"Cerner","owner":"Cerner","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"inputs":[{"name":"portal_domain_host","type":"String","description":"Domain of patient portal"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}
PUT /app-manifests/{appManifestId}
Updates the application manifest with the specified ID.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"id":"803jl720-39cc-4159-a24d-088afla5b496","name":"CernerMessaging","version":"1.0.0","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"owner":"Cerner","vendor":"Cerner","title":"CernerMessaging","inputs":[{"name":"portal_domain_host","type":"String","description":"Domain of patient portal"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}
GET /app-manifests/{appManifestId}
Retrieves a single application manifest by its ID.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests',headers: headers,body: {"name":"CernerMessaging","version":"1.0.0","title":"CernerMessaging","vendor":"Cerner","owner":"Cerner","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"inputs":[{"name":"portal_domain_host","type":"String","description":"Domain of patient portal"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"CernerMessaging","version":"1.0.0","title":"CernerMessaging","vendor":"Cerner","owner":"Cerner","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"inputs":[{"name":"portal_domain_host","type":"String","description":"Domain of patient portal"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}
Example response
{"id":"803jl720-39cc-4159-a24d-088afla5b496","name":"CernerMessaging","version":"1.0.0","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"owner":"Cerner","vendor":"Cerner","title":"CernerMessaging","inputs":[{"name":"portal_domain_host","type":"String","description":"Domain of patient portal"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}
The location of the newly created application manifest.
Retrieve a List of Application Manifests
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"803jl720-39cc-4159-a24d-088afla5b496","name":"CernerMessaging","version":"1.0.0","supportTelecoms":[{"key":"GENERAL_CONTACT","name":"John Smith","system":"PHONE","value":"000-000-0000"}],"owner":"Cerner","vendor":"Cerner","title":"CernerMessaging","inputs":[{"name":"portal_domain_host","type":"String","description":"Domain of patient portal"}],"views":[{"name":"inbox","type":"FRAMED","url":"https://{wellness_domain_host}/messaging/inbox","titles":[{"text":"Inbox","locale":"en-US"}],"entryName":"App"}]}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests?offset=0&limit=20"}
GET /app-manifests
Retrieves a list of application manifests.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
id
query
array[string]
false
N/A
Filters by the ID of the application manifest.
-
order
query
array[string]
false
N/A
Specifies fields for order and direction.
-
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.
A URL that links to files uploaded from another source. The URL enables using and managing site assets or files from an external source.
Delete a Static Asset
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID',headers: headers,body: {"name":"background.png"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"name":"background.png"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets',headers: headers,body: {"key":"logo123.png","name":"background.png"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"key":"logo123.png","name":"background.png"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
A theme describes a set of base CSS variables that are exposed as a base package for sites. These themes define certain defaults and form the basis for what can be branded on a site. The surfaced properties can be split into their own media query by the theme creator to support functionality, such as light and dark modes, different screen sizes, and so on.
Retrieve a List of Themes
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/themes',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/themes \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"d23df2d5-4ca1-43ea-a26e-342992e0a45f","key":"consumer_theme","name":"Consumer Theme","properties":[{"key":"background_overlay_color","name":"Background Overlay Color","description":"The color for the backgrounds overlay. This value masks the background image in a faded color.","type":"color","default":"transparent"}],"previews":[{"url":"https://site.com/preview.png","title":"Dashboard view"}],"details":"<html><body>This value can be used only in browsers that natively support CSS custom properties.</body></html>"}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/themes?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/themes?offset=0&limit=20"}
GET /themes
Retrieves a list of available themes.
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.
A brand adds onto the base properties of a theme and provides the logo and favicon images.
Create a Brand
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands',headers: headers,body: {"logo":{"src":"https://xyz.cloudfront.net/main-logo.png","height":"100","width":"100","altTexts":[{"text":"English Localized Text","locale":"en-US"}]},"favicons":[{"href":"https://xyz.cloudfront.net/icon.png","iconType":"apple-touch-icon","sizes":"64x64"}],"theme":{"key":"CONSUMER_THEME","name":"Consumer Theme","properties":[{"key":"sidebar-background-color","value":"#FFFFFF"}]}}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"logo":{"src":"https://xyz.cloudfront.net/main-logo.png","height":"100","width":"100","altTexts":[{"text":"English Localized Text","locale":"en-US"}]},"favicons":[{"href":"https://xyz.cloudfront.net/icon.png","iconType":"apple-touch-icon","sizes":"64x64"}],"theme":{"key":"CONSUMER_THEME","name":"Consumer Theme","properties":[{"key":"sidebar-background-color","value":"#FFFFFF"}]}}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands \-H'Authorization: {auth_header}'\-H'Accept: application/json'
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.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476',headers: headers,body: {"logo":{"src":"https://xyz.cloudfront.net/main-logo.png","height":"100","width":"100","altTexts":[{"text":"English Localized Text","locale":"en-US"}]},"favicons":[{"href":"https://xyz.cloudfront.net/icon.png","iconType":"apple-touch-icon","sizes":"64x64"}],"theme":{"key":"CONSUMER_THEME","name":"Consumer Theme","properties":[{"key":"sidebar-background-color","value":"#FFFFFF"}]}}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"logo":{"src":"https://xyz.cloudfront.net/main-logo.png","height":"100","width":"100","altTexts":[{"text":"English Localized Text","locale":"en-US"}]},"favicons":[{"href":"https://xyz.cloudfront.net/icon.png","iconType":"apple-touch-icon","sizes":"64x64"}],"theme":{"key":"CONSUMER_THEME","name":"Consumer Theme","properties":[{"key":"sidebar-background-color","value":"#FFFFFF"}]}}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
A message to be displayed on a given site for a defined amount of time.
Delete a Site Alert
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts/14b3e90d-89d2-4ed6-9937-6b8769e5e1da',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts/14b3e90d-89d2-4ed6-9937-6b8769e5e1da \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts/14b3e90d-89d2-4ed6-9937-6b8769e5e1da',headers: headers,body: {"messages":[{"locale":"en-US","message":"The application is currently unavailable due to scheduled maintenance."}],"isDismissible":true,"startTime":"2020-08-21T14:06:01.000Z","endTime":"2020-09-10T14:06:01.000Z"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts/14b3e90d-89d2-4ed6-9937-6b8769e5e1da \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"messages":[{"locale":"en-US","message":"The application is currently unavailable due to scheduled maintenance."}],"isDismissible":false,"startTime":"2020-08-21T14:06:01.000Z","endTime":"2020-09-10T14:06:01.000Z"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts/14b3e90d-89d2-4ed6-9937-6b8769e5e1da',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts/14b3e90d-89d2-4ed6-9937-6b8769e5e1da \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"id":"14b3e90d-89d2-4ed6-9937-6b8769e5e1da","messages":[{"locale":"en-US","message":"The application is currently unavailable due to scheduled maintenance."}],"isDismissible":true,"startTime":"2020-08-21T14:06:01.000Z","endTime":"2020-09-10T14:06:01.000Z"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts',headers: headers,body: {"messages":[{"locale":"en-US","message":"The application is currently unavailable due to scheduled maintenance."}],"isDismissible":true,"startTime":"2020-08-21T14:06:01.000Z","endTime":"2020-09-10T14:06:01.000Z"}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"messages":[{"locale":"en-US","message":"The application is currently unavailable due to scheduled maintenance."}],"isDismissible":true,"startTime":"2020-08-21T14:06:01.000Z","endTime":"2020-09-10T14:06:01.000Z"}
Example response
{"id":"14b3e90d-89d2-4ed6-9937-6b8769e5e1da","messages":[{"locale":"en-US","message":"The application is currently unavailable due to scheduled maintenance."}],"isDismissible":true,"startTime":"2020-08-21T14:06:01.000Z","endTime":"2020-09-10T14:06:01.000Z"}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"14b3e90d-89d2-4ed6-9937-6b8769e5e1da","messages":[{"locale":"en-US","message":"The application is currently unavailable due to scheduled maintenance."}],"isDismissible":true,"startTime":"2020-08-21T14:06:01.000Z","endTime":"2020-09-10T14:06:01.000Z"}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-alerts?offset=0&limit=20"}
GET /site-alerts
Retrieves a list of site alerts.
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.
Custom content allows you to configure the Consumer Well-being site and dashboard design.
Delete a Custom Content Item
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5',headers: headers,body: {"templateKey":"IMAGE_CAROUSEL_TEMPLATE","properties":{"carouselItems":[{"image":"https://example.com/image.png","url":"https://example-content.com"},{"image":"https://example.com/image2.png","url":"https://example2-content.com"}],"imageAltText":"Example image","title":"Example title","subTitle":"Ex. Title","titleColor":"#00ff00","newTab":"Yes"},"name":"Image Carousel","description":"The image carousel is used to transition between multiple slides of content. This is useful when the tenant wants to advertise multiple aspects of their program without cluttering the dashboard."}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5 \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"templateKey":"IMAGE_CAROUSEL_TEMPLATE","properties":{"carouselItems":[{"image":"https://example.com/image.png","url":"https://example-content.com"},{"image":"https://example.com/image2.png","url":"https://example2-content.com"}],"imageAltText":"Example image","title":"Example title","subTitle":"Ex. Title","titleColor":"#00ff00","newTab":"Yes"},"name":"Image Carousel","description":"The image carousel is used to transition between multiple slides of content. This is useful when the tenant wants to advertise multiple aspects of their program without cluttering the dashboard."}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5 \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"id":"0480717b-4aa0-43e1-a3ec-a0b81379d5f5","name":"Image Carousel","description":"The image carousel is used to transition between multiple slides of content. This is useful when the tenant wants to advertise multiple aspects of their program without cluttering the dashboard.","templateKey":"IMAGE_CAROUSEL_TEMPLATE","properties":{"carouselItems":[{"image":"https://example.com/image.png","url":"https://example-content.com"},{"image":"https://example.com/image2.png","url":"https://example2-content.com"}],"imageAltText":"Example image","title":"Example title","subTitle":"Ex. Title","titleColor":"#00ff00","newTab":"Yes"}}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content',headers: headers,body: {"templateKey":"IMAGE_CAROUSEL_TEMPLATE","properties":{"carouselItems":[{"image":"https://example.com/image.png","url":"https://example-content.com"},{"image":"https://example.com/image2.png","url":"https://example2-content.com"}],"imageAltText":"Example image","title":"Example title","subTitle":"Ex. Title","titleColor":"#00ff00","newTab":"Yes"},"name":"Image Carousel","description":"The image carousel is used to transition between multiple slides of content. This is useful when the tenant wants to advertise multiple aspects of their program without cluttering the dashboard."}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content \-H'Authorization: {auth_header}'\-H'Content-Type: application/json'\ \-H'Accept: application/json'\-d{"templateKey":"IMAGE_CAROUSEL_TEMPLATE","properties":{"carouselItems":[{"image":"https://example.com/image.png","url":"https://example-content.com"},{"image":"https://example.com/image2.png","url":"https://example2-content.com"}],"imageAltText":"Example image","title":"Example title","subTitle":"Ex. Title","titleColor":"#00ff00","newTab":"Yes"},"name":"Image Carousel","description":"The image carousel is used to transition between multiple slides of content. This is useful when the tenant wants to advertise multiple aspects of their program without cluttering the dashboard."}
Example response
{"id":"0480717b-4aa0-43e1-a3ec-a0b81379d5f5","name":"Image Carousel","description":"The image carousel is used to transition between multiple slides of content. This is useful when the tenant wants to advertise multiple aspects of their program without cluttering the dashboard.","templateKey":"IMAGE_CAROUSEL_TEMPLATE","properties":{"carouselItems":[{"image":"https://example.com/image.png","url":"https://example-content.com"},{"image":"https://example.com/image2.png","url":"https://example2-content.com"}],"imageAltText":"Example image","title":"Example title","subTitle":"Ex. Title","titleColor":"#00ff00","newTab":"Yes"}}
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"id":"0480717b-4aa0-43e1-a3ec-a0b81379d5f5","name":"Image Carousel","description":"The image carousel is used to transition between multiple slides of content. This is useful when the tenant wants to advertise multiple aspects of their program without cluttering the dashboard.","templateKey":"IMAGE_CAROUSEL_TEMPLATE","properties":{"carouselItems":[{"image":"https://example.com/image.png","url":"https://example-content.com"},{"image":"https://example.com/image2.png","url":"https://example2-content.com"}],"imageAltText":"Example image","title":"Example title","subTitle":"Ex. Title","titleColor":"#00ff00","newTab":"Yes"}}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content?offset=0&limit=20"}
GET /custom-content
Retrieves a list of custom content items.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
id
query
array[string]
false
N/A
Filters custom content by ID.
-
name
query
string
false
N/A
Filters custom content by name.
-
templateKey
query
string
false
N/A
Filters the custom content by template key.
-
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.
Custom content templates are hard-coded templates that allow you to create custom content.
Retrieve a List of Custom Content Templates
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content-templates',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content-templates \-H'Authorization: {auth_header}'\-H'Accept: application/json'
Example response
{"items":[{"name":"Content Widget","description":"A widget used to provide a list of links to reference supporting program content.","key":"CONTENT_WIDGET_TEMPLATE","inputs":[{"name":"carouselItems","type":"Array[Hash]","isRequired":true,"inputs":[{"isRequired":"true","name":"image-url","type":"String"},{"isRequired":"true","name":"image-link","type":"String"}]}]}],"totalResults":1,"firstLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content-templates?offset=0&limit=20","lastLink":"https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content-templates?offset=0&limit=20"}
GET /custom-content-templates
Retrieves a list of custom content templates.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
name
query
string
false
N/A
Filters the custom content templates by name.
-
key
query
string
false
N/A
Filters the custom content templates by key.
-
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.
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.
-
putAppManifests
Name
Type
Required
Description
Accepted Values
name
string
true
The name of the application manifest. It should contain only alphabetic (A-Za-z) and numeric (0-9) characters. The name along with the version is used to uniquely identify an application manifest.
-
version
string
true
The version of the application manifest. It should be in the format of x.y.z, where x, y, and z can be any nonnegative number. Application manifests are versioned using semantic versioning. The version along with the name is used to uniquely identify an application manifest.
-
title
string
true
A human-readable name of the application manifest.
-
vendor
string
false
The name of the vendor who is providing the manifest.
-
owner
string
false
The name of the site owner.
-
supportTelecoms
[object]
false
The list of support contacts for the site.
-
» key
string
true
The key name of the support contact.
-
» name
string
true
The name of the associated contact group or person.
-
» system
string
true
The system or type of support contact.
-
» value
string
true
The support contact value.
-
inputs
[object]
false
The list of the application manifest’s configurable fields. The values of these fields are provided when creating an application that uses this manifest.
-
» name
string
true
The name of the application manifest’s property.
-
» type
string
true
The data type of the application manifest’s property.
-
» description
string
true
The description of the application manifest’s property.
-
views
[object]
true
The list of views.
-
» name
string
true
The name of the application manifest’s view.
-
» type
string
true
The type of the application manifest’s view. Can be either FRAMED or EMBEDDED.
FRAMED, EMBEDDED
» url
string
true
The URL of the view’s source to be loaded. The URL can have any names of the configurable properties enclosed between { and }. Property names are replaced by appropriate values from the application properties when the site definition is created.
-
» titles
[object]
true
The translated names used by screen readers to describe the contents of a view.
-
»» text
string
true
The title for the contents in a particular locale.
-
»» locale
string
true
The locale.
-
» entryName
string
true
The name of the entry file to be loaded for a view with a type of EMBEDDED.
-
AppManifest
Name
Type
Required
Description
Accepted Values
id
string
true
The unique ID of the application manifest.
-
name
string
true
The name of the application manifest. It should contain only alphabetic (A-Za-z) and numeric (0-9) characters. The name along with the version is used to uniquely identify an application manifest.
-
version
string
true
The version of the application manifest. It should be in the format of x.y.z, where x, y, and z can be any nonnegative number. Application manifests are versioned using semantic versioning. The version along with the name is used to uniquely identify an application manifest.
The list of the application manifest’s configurable fields. The values of these fields are provided when creating an application that uses this manifest.
The name of the application manifest. It should contain only alphabetic (A-Za-z) and numeric (0-9) characters. The name along with the version is used to uniquely identify an application manifest.
-
version
string
true
The version of the application manifest. It should be in the format of x.y.z, where x, y, and z can be any nonnegative number. Application manifests are versioned using semantic versioning. The version along with the name is used to uniquely identify an application manifest.
-
title
string
true
A human-readable name of the application manifest.
-
vendor
string
false
The name of the vendor who is providing the manifest.
-
owner
string
false
The name of the site owner.
-
supportTelecoms
[object]
false
The list of support contacts for the site.
-
» key
string
true
The key name of the support contact.
-
» name
string
true
The name of the associated contact group or person.
-
» system
string
true
The system or type of support contact.
-
» value
string
true
The support contact value.
-
inputs
[object]
false
The list of the application manifest’s configurable fields. The values of these fields are provided when creating an application that uses this manifest.
-
» name
string
true
The name of the application manifest’s property.
-
» type
string
true
The data type of the application manifest’s property.
-
» description
string
true
The description of the application manifest’s property.
-
views
[object]
true
The list of views.
-
» name
string
true
The name of the application manifest’s view.
-
» type
string
true
The type of the application manifest’s view. Can be either FRAMED or EMBEDDED.
FRAMED, EMBEDDED
» url
string
true
The URL of the view’s source to be loaded. The URL can have any names of the configurable properties enclosed between { and }. Property names are replaced by appropriate values from the application properties when the site definition is created.
-
» titles
[object]
true
The translated names used by screen readers to describe the contents of a view.
-
»» text
string
true
The title for the contents in a particular locale.
-
»» locale
string
true
The locale.
-
» entryName
string
true
The name of the entry file to be loaded for a view with a type of EMBEDDED.
The instance ID of the site definition that is applied to this domain
-
authorizedPersonnel
[object]
false
The personnel groups that are authorized to configure a domain.
-
» id
string
true
The ID of the personnel group that is authorized to configure a domain.
-
redirectTo
string
false
The web address or domain name to redirect to.
-
ttl
integer(int32)
false
The TimeToLive for a given domain that sets a cache-control in the header (seconds).
-
Domain
Name
Type
Required
Description
Accepted Values
siteDefinitionId
string
false
The instance ID of the site definition that is applied to the domain.
-
domainName
string
true
The domain name that corresponds to the site. Unreserved characters, such as uppercase and lowercase letters, decimal digits, hyphens (-), periods (.), underscores (_), and tildes (~) are allowed. See Unreserved Characters on the Request for Comments (RFC) website for more information about unreserved characters. Reserved characters, such as slashes (/), question marks (?), number signs (#), square brackets ([]), and at signs (@) are not allowed. See Reserved Characters on the RFC website for more information about reserved characters.
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.
-
putSites
Name
Type
Required
Description
Accepted Values
name
string
true
The name of the site.
-
alerts
[object]
false
The list of alert IDs associated with the site.
-
» id
string
true
The ID of the alert.
-
applications
[object]
false
The list of application IDs associated with the site.
-
» id
string
true
The instance ID of the application.
-
identityRealms
[object]
false
The list of identity realms.
-
» realmId
string
true
The ID of the identity realm record.
-
» isDefault
boolean
true
Indicates whether the identity realm is the default.
-
» keepAliveUrl
string
true
The URL required to prevent the identity provider (IdP) session from expiring.
-
locales
[object]
false
The list of locales.
-
» locale
string
true
The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.
-
» isDefault
boolean
true
Indicates whether the locale is the default.
-
pages
[object]
false
The list of page IDs associated with the site.
-
» id
string
true
The ID of the page.
-
support
object
false
The support contact information associated with the site.
-
» phone
string
false
The support phone number associated with the site.
-
» email
string
false
The support email associated with the site.
-
brand
[object]
false
The list of brand IDs associated with the site.
-
» id
string
true
The ID of the brand.
-
navs
[object]
false
The list of navigations for the site.
-
» roles
[object]
true
The list of role names that are used to determine what content is available to users
-
»» name
string
true
The name of the role.
-
» priority
integer(int32)
true
The precedence level that the navigation has over other possible navigations when a user has contextual access to multiple navigation views. The higher the number, the more precedence over others the navigation has. The priority should not be the same as that for any other navigation.
The list of application IDs associated with the site.
-
» id
string
true
The instance ID of the application.
-
identityRealms
[object]
false
The list of identity realms.
-
» realmId
string
true
The ID of the identity realm record.
-
» isDefault
boolean
true
Indicates whether the identity realm is the default.
-
» keepAliveUrl
string
true
The URL required to prevent the identity provider (IdP) session from expiring.
-
locales
[object]
false
The list of locales.
-
» locale
string
true
The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.
-
» isDefault
boolean
true
Indicates whether the locale is the default.
-
pages
[object]
false
The list of page IDs associated with the site.
-
» id
string
true
The ID of the page.
-
support
object
false
The support contact information associated with the site.
-
» phone
string
false
The support phone number associated with the site.
-
» email
string
false
The support email associated with the site.
-
brand
[object]
false
The list of brand IDs associated with the site.
-
» id
string
true
The ID of the brand.
-
navs
[object]
false
The list of navigations for the site.
-
» roles
[object]
true
The list of role names that are used to determine what content is available to users
-
»» name
string
true
The name of the role.
-
» priority
integer(int32)
true
The precedence level that the navigation has over other possible navigations when a user has contextual access to multiple navigation views. The higher the number, the more precedence over others the navigation has. The priority should not be the same as that for any other navigation.
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.
-
postNavigations
Name
Type
Required
Description
Accepted Values
type
string
true
The purpose of the navigation instance.
-
name
string
true
The name of the navigation instance.
-
navItems
[object]
true
The list of navigation items at the top level of the navigation instance.
-
» target
string
true
Specifies where to display the linked URL. The target is a name of (or keyword for) a browsing context, such as a tab or window. In-site navigation is used if this value is not specified.
-
» kind
string
true
The kind of resource that is referenced. This value can refer to either a page or an application manifest.
A relative URL path that identifies the resource to be displayed to a user. This body parameter is required if the navigation item kind is either appExperience#page or appExperience#appManifest.
-
» id
string
true
The ID of the specific resource that is referenced. If the resource has a kind value of page, the ID is the page ID. If the resource has a kind value of app manifest, the ID is [applicationId]:[viewName]. If the resource has a kind value of external, the ID is the external url.
-
» icon
string
true
The resource URL for the icon.
-
» titles
[object]
true
The translated titles that are displayed to the user for the navigation item.
-
»» locale
string
true
The title text.
-
»» text
string
true
The locale of the title. This value must be unique.
-
» navItems
[object]
false
The list of child navigation items. This value is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. Changing the position of a navigation item on the navigation item list changes its position on the site.
-
»» target
string
true
Specifies where to display the linked URL. The target is a name of (or keyword for) a browsing context, such as a tab or window. In-site navigation is used if this value is not specified.
-
»» kind
string
true
The kind of resource that is referenced. This value can refer to either a page or an application manifest.
A relative URL path that identifies the resource to be displayed to a user. This body parameter is required if the navigation item kind is either appExperience#page or appExperience#appManifest.
-
»» id
string
true
The ID of the specific resource that is referenced. If the resource has a kind value of page, the ID is the page ID. If the resource has a kind value of app manifest, the ID is [applicationId]:[viewName]. If the resource has a kind value of external, the ID is the external url.
-
»» icon
string
true
The resource URL for the icon.
-
»» titles
[object]
true
The translated titles that are displayed to the user for the navigation item.
-
»»» locale
string
true
The title text.
-
»»» text
string
true
The locale of the title. This value must be unique.
-
»» navItems
[object]
false
The list of child navigation items. This value is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. Changing the position of a navigation item on the navigation item list changes its position on the site.
-
»»» target
string
true
Specifies where to display the linked URL. The target is a name of (or keyword for) a browsing context, such as a tab or window. In-site navigation is used if this value is not specified.
-
»»» kind
string
true
The kind of resource that is referenced. This value can refer to either a page or an application manifest.
A relative URL path that identifies the resource to be displayed to a user. This body parameter is required if the navigation item kind is either appExperience#page or appExperience#appManifest.
-
»»» id
string
true
The ID of the specific resource that is referenced. If the resource has a kind value of page, the ID is the page ID. If the resource has a kind value of app manifest, the ID is [applicationId]:[viewName]. If the resource has a kind value of external, the ID is the external url.
-
»»» icon
string
true
The resource URL for the icon.
-
»»» titles
[object]
true
The translated titles that are displayed to the user for the navigation item.
-
»»»» locale
string
true
The title text.
-
»»»» text
string
true
The locale of the title. This value must be unique.
-
»»» navItems
[string]
false
The list of child navigation items. This value is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. Changing the position of a navigation item on the navigation item list changes its position on the site.
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.
-
putNavigations
Name
Type
Required
Description
Accepted Values
type
string
true
The purpose of the navigation instance.
-
name
string
true
The name of the navigation instance.
-
navItems
[object]
true
The list of navigation items at the top level of the navigation instance.
-
» target
string
true
Specifies where to display the linked URL. The target is a name of (or keyword for) a browsing context, such as a tab or window. In-site navigation is used if this value is not specified.
-
» kind
string
true
The kind of resource that is referenced. This value can refer to either a page or an application manifest.
A relative URL path that identifies the resource to be displayed to a user. This body parameter is required if the navigation item kind is either appExperience#page or appExperience#appManifest.
-
» id
string
true
The ID of the specific resource that is referenced. If the resource has a kind value of page, the ID is the page ID. If the resource has a kind value of app manifest, the ID is [applicationId]:[viewName]. If the resource has a kind value of external, the ID is the external url.
-
» icon
string
true
The resource URL for the icon.
-
» titles
[object]
true
The translated titles that are displayed to the user for the navigation item.
-
»» locale
string
true
The title text.
-
»» text
string
true
The locale of the title. This value must be unique.
-
» navItems
[object]
false
The list of child navigation items. This value is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. Changing the position of a navigation item on the navigation item list changes its position on the site.
-
»» target
string
true
Specifies where to display the linked URL. The target is a name of (or keyword for) a browsing context, such as a tab or window. In-site navigation is used if this value is not specified.
-
»» kind
string
true
The kind of resource that is referenced. This value can refer to either a page or an application manifest.
A relative URL path that identifies the resource to be displayed to a user. This body parameter is required if the navigation item kind is either appExperience#page or appExperience#appManifest.
-
»» id
string
true
The ID of the specific resource that is referenced. If the resource has a kind value of page, the ID is the page ID. If the resource has a kind value of app manifest, the ID is [applicationId]:[viewName]. If the resource has a kind value of external, the ID is the external url.
-
»» icon
string
true
The resource URL for the icon.
-
»» titles
[object]
true
The translated titles that are displayed to the user for the navigation item.
-
»»» locale
string
true
The title text.
-
»»» text
string
true
The locale of the title. This value must be unique.
-
»» navItems
[object]
false
The list of child navigation items. This value is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. Changing the position of a navigation item on the navigation item list changes its position on the site.
-
»»» target
string
true
Specifies where to display the linked URL. The target is a name of (or keyword for) a browsing context, such as a tab or window. In-site navigation is used if this value is not specified.
-
»»» kind
string
true
The kind of resource that is referenced. This value can refer to either a page or an application manifest.
A relative URL path that identifies the resource to be displayed to a user. This body parameter is required if the navigation item kind is either appExperience#page or appExperience#appManifest.
-
»»» id
string
true
The ID of the specific resource that is referenced. If the resource has a kind value of page, the ID is the page ID. If the resource has a kind value of app manifest, the ID is [applicationId]:[viewName]. If the resource has a kind value of external, the ID is the external url.
-
»»» icon
string
true
The resource URL for the icon.
-
»»» titles
[object]
true
The translated titles that are displayed to the user for the navigation item.
-
»»»» locale
string
true
The title text.
-
»»»» text
string
true
The locale of the title. This value must be unique.
-
»»» navItems
[string]
false
The list of child navigation items. This value is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. Changing the position of a navigation item on the navigation item list changes its position on the site.
-
putLayouts
Name
Type
Required
Description
Accepted Values
key
string
true
The unique name of the layout. It should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
-
defaultConfig
object
true
The default grid configuration. The application that consumes this value assigns the meaning. This value can be used as a fallback if a particular responsive breakpoint configuration is not defined.
-
» rows
[object]
true
The list of rows defined for the layout.
-
»» height
string
true
The height of each row expressed as either auto for automatic sizing based on content height or some fixed CSS length. See the length page on the MDN website for more information.
-
responsiveConfigs
[object]
false
The optional region configurations based on responsive breakpoints. This value can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes this page assigns meaning to these breakpoint names.
-
» breakpoint
string
true
The name of a point at which a layout should switch its display to the given grid. The name should have meaning to the application that consumes this layout. The following values are possible, among others: TINY, SMALL, MEDIUM, LARGE, HUGE, and DEFAULT.
-
» config
object
true
The configuration of each row in the layout’s grid
-
»» rows
[object]
true
The list of rows defined for the layout.
-
»»» height
string
true
The height of each row expressed as either auto for automatic sizing based on content height or some fixed CSS length. See the length page on the MDN website for more information.
-
regions
[object]
false
The list of regions in the layout.
-
» defaultConfig
object
true
The default region for the configuration. This value is applied unless a configuration is defined for a responsive breakpoint.
-
»» rowStart
string
true
The starting row position for the region. The value refers to grid lines and not columns. A position of 0 is invalid. See the grid-row-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»» rowEnd
string
false
The ending row position for the region. The value refers to grid lines and not columns. If this position is omitted, the ending position is assumed to be the starting position and spans only a single row. A position of 0 is invalid. See the grid-row-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»» columnStart
string
false
The starting column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. See the grid-column-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»» columnEnd
string
false
The ending column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. A position other than the starting column position results in spanning multiple columns. See the grid-column-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
» responsiveConfigs
[object]
false
The optional region configurations based on responsive breakpoints. This value can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes the page assigns the meaning for the breakpoint names.
-
»» breakpoint
string
true
The name of a point at which a layout should switch its display to the given grid. The name should have meaning to the application that consumes this layout. The following values are possible, among others: TINY, SMALL, MEDIUM, LARGE, HUGE, and DEFAULT.
-
»» config
object
true
The configuration of each row in the layout’s grid
-
»»» rowStart
string
true
The starting row position for the region. The value refers to grid lines and not columns. A position of 0 is invalid. See the grid-row-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» rowEnd
string
false
The ending row position for the region. The value refers to grid lines and not columns. If this position is omitted, the ending position is assumed to be the starting position and spans only a single row. A position of 0 is invalid. See the grid-row-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» columnStart
string
false
The starting column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. See the grid-column-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» columnEnd
string
false
The ending column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. A position other than the starting column position results in spanning multiple columns. See the grid-column-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» styles
object
false
Associated styles found in region
-
»»»» marginLeft
string
false
The amount of margin applied from the left side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» marginRight
string
false
The amount of margin applied from the right side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» marginTop
string
false
The amount of margin applied from the top. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» marginBottom
string
false
The amount of margin applied from the bottom. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingLeft
string
false
The amount of padding applied from the left side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingRight
string
false
The amount of padding applied from the right side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingTop
string
false
The amount of padding applied from the top. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingBottom
string
false
The amount of padding applied from the bottom. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
» pageletGap
string
false
The amount of spacing applied between pagelets in the region. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
name
string
true
The user-friendly name for the layout.
-
Layout
Name
Type
Required
Description
Accepted Values
id
string
true
The ID of the layout record.
-
key
string
true
The unique name of the layout. It should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
The default grid configuration. The application that consumes this value assigns the meaning. This value can be used as a fallback if a particular responsive breakpoint configuration is not defined.
The optional region configurations based on responsive breakpoints. This value can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes this page assigns meaning to these breakpoint names.
The unique name of the layout. It should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
-
defaultConfig
object
true
The default grid configuration. The application that consumes this value assigns the meaning. This value can be used as a fallback if a particular responsive breakpoint configuration is not defined.
-
» rows
[object]
true
The list of rows defined for the layout.
-
»» height
string
true
The height of each row expressed as either auto for automatic sizing based on content height or some fixed CSS length. See the length page on the MDN website for more information.
-
responsiveConfigs
[object]
false
The optional region configurations based on responsive breakpoints. This value can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes this page assigns meaning to these breakpoint names.
-
» breakpoint
string
true
The name of a point at which a layout should switch its display to the given grid. The name should have meaning to the application that consumes this layout. The following values are possible, among others: TINY, SMALL, MEDIUM, LARGE, HUGE, and DEFAULT.
-
» config
object
true
The configuration of each row in the layout’s grid
-
»» rows
[object]
true
The list of rows defined for the layout.
-
»»» height
string
true
The height of each row expressed as either auto for automatic sizing based on content height or some fixed CSS length. See the length page on the MDN website for more information.
-
regions
[object]
false
The list of regions in the layout.
-
» defaultConfig
object
true
The default region for the configuration. This value is applied unless a configuration is defined for a responsive breakpoint.
-
»» rowStart
string
true
The starting row position for the region. The value refers to grid lines and not columns. A position of 0 is invalid. See the grid-row-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»» rowEnd
string
false
The ending row position for the region. The value refers to grid lines and not columns. If this position is omitted, the ending position is assumed to be the starting position and spans only a single row. A position of 0 is invalid. See the grid-row-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»» columnStart
string
false
The starting column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. See the grid-column-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»» columnEnd
string
false
The ending column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. A position other than the starting column position results in spanning multiple columns. See the grid-column-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
» responsiveConfigs
[object]
false
The optional region configurations based on responsive breakpoints. This value can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes the page assigns the meaning for the breakpoint names.
-
»» breakpoint
string
true
The name of a point at which a layout should switch its display to the given grid. The name should have meaning to the application that consumes this layout. The following values are possible, among others: TINY, SMALL, MEDIUM, LARGE, HUGE, and DEFAULT.
-
»» config
object
true
The configuration of each row in the layout’s grid
-
»»» rowStart
string
true
The starting row position for the region. The value refers to grid lines and not columns. A position of 0 is invalid. See the grid-row-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» rowEnd
string
false
The ending row position for the region. The value refers to grid lines and not columns. If this position is omitted, the ending position is assumed to be the starting position and spans only a single row. A position of 0 is invalid. See the grid-row-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» columnStart
string
false
The starting column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. See the grid-column-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» columnEnd
string
false
The ending column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. A position other than the starting column position results in spanning multiple columns. See the grid-column-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
»»» styles
object
false
Associated styles found in region
-
»»»» marginLeft
string
false
The amount of margin applied from the left side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» marginRight
string
false
The amount of margin applied from the right side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» marginTop
string
false
The amount of margin applied from the top. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» marginBottom
string
false
The amount of margin applied from the bottom. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingLeft
string
false
The amount of padding applied from the left side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingRight
string
false
The amount of padding applied from the right side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingTop
string
false
The amount of padding applied from the top. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
»»»» paddingBottom
string
false
The amount of padding applied from the bottom. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
» pageletGap
string
false
The amount of spacing applied between pagelets in the region. The value is defined in CSS lengths. See the length page on the MDN website for more information.
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.
-
postPages
Name
Type
Required
Description
Accepted Values
path
string
true
A relative web address path that identifies the resource to be displayed to a user.
-
alias
string
true
A named alias that is used to reference a route independent of its path. Aliases can be used to reference a specific route relationship when linking to pages instead of directly referencing the web address. This alias should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
-
roles
[object]
true
Only the role IDs defined in this group can access the page.
-
» name
string
false
The name of the role.
-
layout
object
true
The layout of the page.
-
» key
string
true
The name of the layout. This string should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
-
views
[object]
false
The views of the page.
-
» kind
string
true
The kind of view. Only application manifest views are currently available. Custom pages may be supported as future functionality is to be determined.
A relative web address path that identifies the resource to be displayed to a user.
-
alias
string
true
A named alias that is used to reference a route independent of its path. Aliases can be used to reference a specific route relationship when linking to pages instead of directly referencing the web address. This alias should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
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.
-
putPages
Name
Type
Required
Description
Accepted Values
path
string
true
A relative web address path that identifies the resource to be displayed to a user.
-
alias
string
true
A named alias that is used to reference a route independent of its path. Aliases can be used to reference a specific route relationship when linking to pages instead of directly referencing the web address. This alias should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
-
roles
[object]
true
Only the role IDs defined in this group can access the page.
-
» name
string
false
The name of the role.
-
layout
object
true
The layout of the page.
-
» key
string
true
The name of the layout. This string should contain only alphabetic characters (A-Za-z) and numeric digits (0-9).
-
views
[object]
false
The views of the page.
-
» kind
string
true
The kind of view. Only application manifest views are currently available. Custom pages may be supported as future functionality is to be determined.
The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-).
-
value
string
false
The content for the terms of use for a given locale.
-
postTermsOfUse
Name
Type
Required
Description
Accepted Values
touId
string
true
The ID of the terms of use. The ID can be shared by multiple instances of the same terms of use.
-
content
[object]
false
The translations of a terms of use.
-
» locale
string
true
The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-).
-
» value
string
true
The content for the terms of use for a given locale.
The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-).
-
value
string
false
The content of the privacy policy for a given locale.
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.
-
postPrivacyPolicies
Name
Type
Required
Description
Accepted Values
privacyPolicyId
string
true
The ID of the privacy policy. The ID can be shared by multiple instances of the same privacy policy.
-
content
[object]
false
The translations of a privacy policy.
-
» locale
string
true
The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-).
-
» value
string
true
The content of the privacy policy for a given locale.
-
postSiteDefinitions
Name
Type
Required
Description
Accepted Values
siteId
string
true
The ID of the site used to build a site definition.
-
SiteDefinitionPost
Name
Type
Required
Description
Accepted Values
siteDefinitionId
string
true
The unique ID that correlates with the site definition.
The properties of the routing for the site. The availability of a routing group is determined by finding the first routing group with access groups that are subsets of access groups in the provided roles.
A short summary for display purposes in administrator tools and to help identify the navigation item when searching for it.
-
type
string
true
The purpose of the navigation instance. The following types are possible: - primary: Indicates the instance that defines the primary navigation. - profile: Indicates profile navigation links. - quick: Indicates faster, minimized navigation.
The list of navigation items at the top level of the navigation instance.
-
NavigationItem
Name
Type
Required
Description
Accepted Values
target
string
false
Specifies where to display the linked URL. The target is a name of, or keyword for, a browsing context such as a tab or window. In-site navigation is used if this is not specified.
-
uri
string
false
The URI or path that references the resource to which the navigation item links.
-
icon
string
false
The icon resource URL.
-
title
[string]
true
The translated text displayed to the user for the navigation item.
-
isMegaMenu
boolean
false
Indicates that the navigation item is a mega menu when set to True.
The list of child navigation items. This is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items.
-
RoutingGroup
Name
Type
Required
Description
Accepted Values
name
string
true
A short summary for display purposes in administrator tools and to help identify the routing group when searching for it.
A relative URL path that identifies the resource to display to a user.
-
alias
string
false
A named alias that is used to reference a route independent of its path. Aliases can be used to reference a specific route relationship when linking to pages instead of directly referencing the URL.
The optional region configurations based on responsive breakpoints. This value can be used to establish mobile, tablet, and desktop layouts for the page. It is the responsibility of the application that consumes this page to assign meaning for these breakpoint names.
The height of each row expressed as either auto for automatic sizing based on content height or some fixed CSS lengths. See the length page on the MDN website for more information.
-
ResponsivePageGrid
Name
Type
Required
Description
Accepted Values
breakpoint
string
true
The name of a point at which a page should switch its display to the given grid. The name should have meaning to the application that consumes this page.
The list of pagelet IDs that should be displayed in this region. When multiple pagelets are included, the pagelets are stacked vertically in the region.
The amount of spacing applied between pagelets in the region. The value is defined in CSS lengths. See the length page on the MDN Web Docs website for more information.
The optional region configurations based on responsive breakpoints. This can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes the page assigns the meaning for the breakpoint names.
-
Pagelet
Name
Type
Required
Description
Accepted Values
id
string
false
The unique ID of the pagelet.
-
name
[string]
true
A short summary for display purposes in administrator tooling and to help identify the pagelet when searching for it.
-
type
[string]
true
The type of pagelet applied to this instance. framed refers to pagelets that are sandboxed from the application that consumes the Extensible Application Framework and that securely communicate with each other using cross-frame communication (XFC). They are hosted on a domain separate from the application and appear in an HTML iframe. embedded refers to pagelets that are JavaScript and CSS bundles dynamically loaded and inlined into the consuming application without any sandboxing. customcontent refers to small, self-contained JavaScript components which can be used to customize the Consumer Well-Being site and dashboard design.
Details about the pagelet that define the pagelet. Fields inside the configuration flex based on the pagelet’s type value.
-
PageletConfig
Name
Type
Required
Description
Accepted Values
url
string
false
Required when the type is EMBEDDED. The location where the pagelet is deployed and available for applications to load onto a page.
-
accessibilityTitle
string
false
The translated names used by screen readers to describe contents of a FRAMED pagelet.
-
manifestUrl
string
false
Required when type is EMBEDDED. The location of manifest that defines the assets to load for the bundle.
-
entryName
string
false
Required when type is EMBEDDED. Name of the entry file from the manifest that will be loaded for this pagelet.
-
name
string
false
Required when type is CUSTOMCONTENT. Name of the custom content instance that will be loaded for this pagelet.
-
templateKey
string
false
Required when type is CUSTOMCONTENT. Name of the template used for the referenced instance of custom content.
-
description
string
false
Required when type is CUSTOMCONTENT. A description of the function of the custom content template.
-
properties
object
false
Required when type is CUSTOMCONTENT. The properties to pass to the custom content component.
-
RegionConfig
Name
Type
Required
Description
Accepted Values
rowStart
string
true
The starting row position for the region. The value is in terms of grid lines and not columns. A position of 0 is invalid. See the grid-row-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
rowEnd
string
false
The ending row position for the region. The value is in terms of grid lines and not columns. If this position is omitted, the ending position is assumed to be the starting position and the region spans only a single row. A position of 0 is invalid. See the grid-row-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
columnStart
string
false
The starting column position for the region. The value is in terms of grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can fall between 1 and 13 inclusive along with negative values (-13 to -1 inclusive). A position of 0 is invalid. See the grid-column-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
columnEnd
string
false
The ending column position for the region. The value is in terms of grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can fall between 1 and 13 inclusive along with negative values (-13 to -1 inclusive). A position of 0 is invalid. A position other than the starting column position results in the region spanning multiple columns. See the grid-column-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
The amount of margin applied from the left side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
marginRight
string
false
The amount of margin applied from the right side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
marginTop
string
false
The amount of margin applied from the top. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
marginBottom
string
false
The amount of margin applied from the bottom. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
paddingLeft
string
false
The amount of padding applied from the left side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
paddingRight
string
false
The amount of padding applied from the right side. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
paddingTop
string
false
The amount of padding applied from the top. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
paddingBottom
string
false
The amount of padding applied from the bottom. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
ResponsiveRegionConfig
Name
Type
Required
Description
Accepted Values
breakpoint
string
true
The name of a point at which a page should switch its display to the given grid. The name should have meaning to the application that consumes this page.
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.
-
Theme
Name
Type
Required
Description
Accepted Values
id
string
true
The unique ID of the theme instance.
-
key
string
true
The unique human-knowable name of the theme instance.
-
name
string
true
The unique human-readable name of the theme instance.
-
topNavigationEnabled
boolean
true
Indicates whether the top navigation of the theme is enabled. A value of true indicates that the top navigation is enabled. A value of false indicates that it is disabled.
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.
-
Application_AppManifestReference
Name
Type
Required
Description
Accepted Values
id
string
true
The ID of the application manifest to which the application is connected.
-
Application_ApplicationRole
Name
Type
Required
Description
Accepted Values
name
string
true
The name of a role.
-
Application_Property
Name
Type
Required
Description
Accepted Values
input
string
false
The value of the application’s property.
-
property
string
false
The name of the application’s property.
-
AppManifest_SupportTelecoms
Name
Type
Required
Description
Accepted Values
key
string
true
The key name of the support contact.
GENERAL_CONTACT, EMERGENCY_CONTACT
name
string
true
The name of the associated contact group or person.
-
system
string
true
The system or type of support contact.
-
value
string
true
The support contact value.
-
AppManifest_Input
Name
Type
Required
Description
Accepted Values
name
string
true
The name of the application manifest’s property.
-
type
string
true
The data type of the application manifest’s property.
-
description
string
true
The description of the application manifest’s property.
-
AppManifest_View
Name
Type
Required
Description
Accepted Values
name
string
true
The name of the application manifest’s view.
-
type
string
true
The type of the application manifest’s view. Can be either FRAMED or EMBEDDED.
-
url
string
true
The URL of the view’s source to be loaded. The URL can have any names of the configurable properties enclosed between { and }. Property names are replaced by appropriate values from the application properties when the site definition is created.
Indicates whether the top navigation of the site is enabled. A value of true indicates that the top navigation is enabled. A value of false indicates that it is disabled.
The list of role names that are used to determine what content is available to users
-
priority
string
true
The precedence level that the navigation has over other possible navigations when a user has contextual access to multiple navigation views. The higher the number, the more precedence over others the navigation has. The priority should not be the same as that for any other navigation.
-
type
string
true
The navigation type.
-
id
string
true
The unique ID of the navigation.
-
Site_RoleReference
Name
Type
Required
Description
Accepted Values
name
string
false
The name of the role.
-
Site_PrivacyPolicyReference
Name
Type
Required
Description
Accepted Values
id
string
true
The instance ID of the privacy policy.
-
Site_TermsOfUseReference
Name
Type
Required
Description
Accepted Values
id
string
true
The instance ID of the terms of use.
-
Site_Title
Name
Type
Required
Description
Accepted Values
text
string
true
The title text.
-
locale
string
true
The locale of the title
-
Navigation_NavigationItemReference
Name
Type
Required
Description
Accepted Values
target
string
false
Specifies where to display the linked URL. The target is a name of (or keyword for) a browsing context, such as a tab or window. In-site navigation is used if this value is not specified.
-
path
string
false
A relative URL path that identifies the resource to be displayed to a user. This body parameter is required if the navigation item kind is either appExperience#page or appExperience#appManifest.
-
kind
string
true
The kind of resource that is referenced. This value can refer to either a page or an application manifest.
appExperience#page, appExperience#appManifest
id
string
true
The ID of the specific resource that is referenced. If the resource has a kind value of page, the ID is the page ID. If the resource has a kind value of app manifest, the ID is [applicationId]:[viewName]. If the resource has a kind value of external, the ID is the external url.
The list of child navigation items. This value is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. Changing the position of a navigation item on the navigation item list changes its position on the site.
-
Navigation_Title
Name
Type
Required
Description
Accepted Values
text
string
true
The title text.
-
locale
string
true
The locale of the title. This value must be unique.
The height of each row expressed as either auto for automatic sizing based on content height or some fixed CSS length. See the length page on the MDN website for more information.
-
Layout_ResponsiveLayoutGridConfig
Name
Type
Required
Description
Accepted Values
breakpoint
string
true
The name of a point at which a layout should switch its display to the given grid. The name should have meaning to the application that consumes this layout. The following values are possible, among others: TINY, SMALL, MEDIUM, LARGE, HUGE, and DEFAULT.
The optional region configurations based on responsive breakpoints. This value can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes the page assigns the meaning for the breakpoint names.
-
pageletGap
string
false
The amount of spacing applied between pagelets in the region. The value is defined in CSS lengths. See the length page on the MDN website for more information.
-
Layout_LayoutDefaultConfig
Name
Type
Required
Description
Accepted Values
rowStart
string
true
The starting row position for the region. The value refers to grid lines and not columns. A position of numeral 0 is invalid. See the grid-row-start page on the Mozilla Developer Network (MDN) website for more information about the CSS grid specification to which this value corresponds.
-
rowEnd
string
false
The ending row position for the region. The value refers to grid lines and not columns. If this position is omitted, the ending position is assumed to be the starting position and spans only a single row. A position of 0 is invalid. See the grid-row-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
columnStart
string
false
The starting column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be somewhere between 1 and 13 inclusive with negative values between -13 and -1 inclusive. A position of 0 is invalid. See the grid-column-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
columnEnd
string
false
The ending column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be somewhere between 1 and 13 inclusive with negative values between -13 and -1 inclusive. A position of 0 is invalid. A position other than the starting column position results in multiple columns being spanned. See the grid-column-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
Layout_ResponsiveLayoutRegionConfig
Name
Type
Required
Description
Accepted Values
breakpoint
string
true
The name of a point at which a page should switch its display to the given grid. The name should have meaning to the application that consumes this page.
The default region configuration. This is applied unless a configuration is defined for a responsive breakpoint.
-
Layout_LayoutRegionConfig
Name
Type
Required
Description
Accepted Values
rowStart
string
true
The starting row position for the region. The value refers to grid lines and not columns. A position of 0 is invalid. See the grid-row-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
rowEnd
string
false
The ending row position for the region. The value refers to grid lines and not columns. If this position is omitted, the ending position is assumed to be the starting position and spans only a single row. A position of 0 is invalid. See the grid-row-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
columnStart
string
false
The starting column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. See the grid-column-start page on the MDN website for more information about the CSS grid specification to which this value corresponds.
-
columnEnd
string
false
The ending column position for the region. The value refers to grid lines and not columns. As a result, the 12 equally spaced columns translate into 13 grid lines. The position can be between 1 and 13 inclusive with negative values between -13 to -1 inclusive. A position of 0 is invalid. A position other than the starting column position results in spanning multiple columns. See the grid-column-end page on the MDN website for more information about the CSS grid specification to which this value corresponds.
The name of the application manifest. This value consists of alphabetic (A-Za-z) and numeric (0-9) characters. The name with the version uniquely identifies an application manifest.
-
vendor
string
true
The name of the vendor who is providing the manifest.
-
title
string
true
A human-readable name of the application manifest.
-
owner
string
true
The name of the site owner.
-
version
string
true
The version of the application manifest. This value uses the format of x.y.z, where x, y, and z can be any nonnegative number. Application manifests are versioned using semantic versioning. The version with the name uniquely identifies an application manifest.
The type of the application manifest’s view. The value can be either FRAMED or EMBEDDED.
-
url
string
true
The URL of the view’s source to be loaded. The URL can have any names of the configurable properties enclosed between { and }. Property names are replaced by appropriate values from the application properties when the site definition is created.
The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen (-).
-
SiteDefinition_RoleCriteria
Name
Type
Required
Description
Accepted Values
roleId
string
true
The ID of the role attached to the role criteria.
-
roleName
string
true
The name of the role that is attached to this role critera.
-
consumerGroupIds
string
true
An array of the consumer group universally unique identifier (UUIDs) that are used to build a role criteria.