NAV Navbar
Logo cerner
Ruby Shell

Application Experience API v1

The Application Experience API enables defining and configuring application navigation, content, and branding.

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

Terms And Conditions

The Terms and Conditions endpoints enable customizing and capturing the acceptance of terms and conditions. The endpoints allow interaction with the following resources:

Retrieve a List of Privacy Policies

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies', headers: headers)

print JSON.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. -

Response Statuses

Status Meaning Description Schema
200 OK Success PrivacyPolicies
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Privacy Policy

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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 )

print JSON.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.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created PrivacyPolicy
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created privacy policy.

Remove a Privacy Policy

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c', headers: headers)

print JSON.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.

Parameters

Parameter In Type Required Default Description Accepted Values
instanceId path string true N/A The instance ID of the privacy policy. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Privacy Policy

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c', headers: headers)

print JSON.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.

Parameters

Parameter In Type Required Default Description Accepted Values
instanceId path string true N/A The instance ID of the privacy policy. -

Response Statuses

Status Meaning Description Schema
200 OK Success PrivacyPolicy
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of Terms Of Use

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use', headers: headers)

print JSON.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. -

Response Statuses

Status Meaning Description Schema
200 OK Success TermsOfUses
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Terms Of Use

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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 )

print JSON.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.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created TermsOfUse
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created terms of use.

Remove a Terms Of Use

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88', headers: headers)

print JSON.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.

Parameters

Parameter In Type Required Default Description Accepted Values
instanceId path string true N/A The instance ID of the terms of use. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Terms Of Use

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88', headers: headers)

print JSON.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.

Parameters

Parameter In Type Required Default Description Accepted Values
instanceId path string true N/A The instance ID of the terms of use. -

Response Statuses

Status Meaning Description Schema
200 OK Success TermsOfUse
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of Terms Of Use Acceptances

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances', headers: headers)

print JSON.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'

Example response

{
  "items": [
    {
      "id": "699f703a-8095-4c77-90f2-d1385f92c1a7",
      "termsOfUse": {
        "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
      },
      "consumer": {
        "id": "32b567c3-5989-4ca0-96f3-aa63442d2ce1"
      },
      "dateAccepted": "2019-03-31T15:11:53.000Z",
      "domainName": "demo.cernerdemo.us.healtheintent.com"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/terms-of-use-acceptances?offset=0&limit=20"
}

GET /terms-of-use-acceptances

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. -

Response Statuses

Status Meaning Description Schema
200 OK Success TermsOfUseAcceptances
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Terms Of Use Acceptance

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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 )

print JSON.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"}

Example response

{
  "id": "699f703a-8095-4c77-90f2-d1385f92c1a7",
  "termsOfUse": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "consumer": {
    "id": "32b567c3-5989-4ca0-96f3-aa63442d2ce1"
  },
  "dateAccepted": "2019-03-31T15:11:53.000Z",
  "domainName": "demo.cernerdemo.us.healtheintent.com"
}

POST /terms-of-use-acceptances

Creates a terms of use acceptance for a given HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created TermsOfUseAcceptance
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string 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.2
require '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)

print JSON.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'

Example response

{
  "id": "699f703a-8095-4c77-90f2-d1385f92c1a7",
  "termsOfUse": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "consumer": {
    "id": "32b567c3-5989-4ca0-96f3-aa63442d2ce1"
  },
  "dateAccepted": "2019-03-31T15:11:53.000Z",
  "domainName": "demo.cernerdemo.us.healtheintent.com"
}

GET /terms-of-use-acceptances/{id}

Retrieves a single terms of use acceptance for a given HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The instance ID of the terms of use acceptance. -

Response Statuses

Status Meaning Description Schema
200 OK Success TermsOfUseAcceptance
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Role

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.2
require '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 )

print JSON.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"}

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "name": "MEMBER",
  "domainName": "cernerdemo.wellness.us.healtheintent.com"
}

POST /site-roles

Creates a role for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Role
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created role.

Retrieve a List of Roles

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles', headers: headers)

print JSON.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'

Example response

{
  "items": [
    {
      "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
      "name": "MEMBER",
      "domainName": "cernerdemo.wellness.us.healtheintent.com"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles?offset=0&limit=20"
}

GET /site-roles

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. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Roles
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Role

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.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'

DELETE /site-roles/{roleId}

Deletes a single role for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
roleId path string true N/A The unique ID of the role. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Role

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers, body: {"name":"MEMBER"}.to_json )

print JSON.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"}

PUT /site-roles/{roleId}

Updates a single role for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
roleId path string true N/A The unique ID of the role. -
body body putSiteRoles true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Role

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-roles/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.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'

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "name": "MEMBER",
  "domainName": "cernerdemo.wellness.us.healtheintent.com"
}

GET /site-roles/{roleId}

Retrieves a single role for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
roleId path string true N/A The unique ID of the role. -

Response Statuses

Status Meaning Description Schema
200 OK Success Role
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Page

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.2
require '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"}]}.to_json )

print JSON.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"}]}

Example response

{
  "id": "d611c71d-0d62-42c5-88b4-1e34b4beb142",
  "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"
    }
  ]
}

POST /pages

Creates a page.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created CustomPage
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created page.

Retrieve a List of Pages

Example Request:


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

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

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

print JSON.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",
      "roles": [
        {
          "name": "CONSUMER"
        }
      ],
      "layout": {
        "key": "onecolumn"
      },
      "views": [
        {
          "kind": "applicationExperience#appManifest",
          "appId": "dd9-b62b-4f6b-98b0-10b9ef10",
          "viewName": "list",
          "regionId": "single"
        }
      ]
    }
  ],
  "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. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success CustomPages
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Page

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142', headers: headers)

print JSON.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'

DELETE /pages/{pageId}

Deletes a single page.

Parameters

Parameter In Type Required Default Description Accepted Values
pageId path string true N/A The ID of the page record. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Page

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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"}]}.to_json )

print JSON.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"}]}

PUT /pages/{pageId}

Updates a single page.

Parameters

Parameter In Type Required Default Description Accepted Values
pageId path string true N/A The ID of the page record. -
body body putPages true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Page

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pages/d611c71d-0d62-42c5-88b4-1e34b4beb142', headers: headers)

print JSON.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",
  "roles": [
    {
      "name": "CONSUMER"
    }
  ],
  "layout": {
    "key": "onecolumn"
  },
  "views": [
    {
      "kind": "applicationExperience#appManifest",
      "appId": "dd9-b62b-4f6b-98b0-10b9ef10",
      "viewName": "list",
      "regionId": "single"
    }
  ]
}

GET /pages/{pageId}

Retrieves a single page.

Parameters

Parameter In Type Required Default Description Accepted Values
pageId path string true N/A The ID of the page record. -

Response Statuses

Status Meaning Description Schema
200 OK Success CustomPage
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Layout

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.

Create a Layout

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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"}]}.to_json )

print JSON.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"}]}

Example response

{
  "id": "061484df-87aa-42cb-aaf8-2bed12cc0448",
  "key": "onecolumn",
  "defaultConfig": {
    "rows": [
      {
        "height": "auto"
      }
    ]
  },
  "responsiveConfigs": [
    {
      "breakpoint": "LARGE",
      "config": {
        "rows": [
          {
            "height": "auto"
          }
        ]
      }
    }
  ],
  "regions": [
    {
      "id": "de0a2924-adb1-4884-bc85-720a75128b38",
      "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"
    }
  ]
}

POST /layouts

Creates a layout.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Layout
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created layout.

Retrieve a List of Layouts

Example Request:


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

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

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

print JSON.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'

Example response

{
  "items": [
    {
      "id": "061484df-87aa-42cb-aaf8-2bed12cc0448",
      "key": "onecolumn",
      "defaultConfig": {
        "rows": [
          {
            "height": "auto"
          }
        ]
      },
      "responsiveConfigs": [
        {
          "breakpoint": "LARGE",
          "config": {
            "rows": [
              {
                "height": "auto"
              }
            ]
          }
        }
      ],
      "regions": [
        {
          "id": "de0a2924-adb1-4884-bc85-720a75128b38",
          "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"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts?offset=0&limit=20"
}

GET /layouts

Retrieves a list of layouts.

Parameters

Parameter In Type Required Default Description Accepted Values
key query array[string] false N/A Filters by the key of the layout. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Layouts
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Layout

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448', headers: headers)

print JSON.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'

DELETE /layouts/{layoutId}

Deletes a single layout.

Parameters

Parameter In Type Required Default Description Accepted Values
layoutId path string true N/A The ID of the layout record. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Layout

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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"}]}.to_json )

print JSON.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"}]}

PUT /layouts/{layoutId}

Updates a single layout.

Parameters

Parameter In Type Required Default Description Accepted Values
layoutId path string true N/A The ID of the layout record. -
body body putLayouts true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Layout

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/layouts/061484df-87aa-42cb-aaf8-2bed12cc0448', headers: headers)

print JSON.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'

Example response

{
  "id": "061484df-87aa-42cb-aaf8-2bed12cc0448",
  "key": "onecolumn",
  "defaultConfig": {
    "rows": [
      {
        "height": "auto"
      }
    ]
  },
  "responsiveConfigs": [
    {
      "breakpoint": "LARGE",
      "config": {
        "rows": [
          {
            "height": "auto"
          }
        ]
      }
    }
  ],
  "regions": [
    {
      "id": "de0a2924-adb1-4884-bc85-720a75128b38",
      "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"
    }
  ]
}

GET /layouts/{layoutId}

Retrieves a single layout.

Parameters

Parameter In Type Required Default Description Accepted Values
layoutId path string true N/A The ID of the layout record. -

Response Statuses

Status Meaning Description Schema
200 OK Success Layout
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Role Criteria

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.2
require '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 )

print JSON.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"]}

Example response

{
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "roleId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "consumerGroupIds": [
    "591f9612-deef-4e0a-96c9-8e9b749c2eea",
    "f5380953-564b-4037-80c8-10395f1c9384"
  ]
}

POST /role-criteria

Creates a role criteria for a role.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created RoleCriteria
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created role criteria.

Retrieve a List of Role Criteria

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria', headers: headers)

print JSON.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'

Example response

{
  "items": [
    {
      "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/role-criteria?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria?offset=0&limit=20"
}

GET /role-criteria

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. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success RoleCriteria
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Role Criteria

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569', headers: headers)

print JSON.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'

DELETE /role-criteria/{roleCriteriaId}

Deletes a single role criteria for a role.

Parameters

Parameter In Type Required Default Description Accepted Values
roleCriteriaId path string true N/A The unique ID of the role criteria. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Role Criteria

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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 )

print JSON.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"]}

PUT /role-criteria/{roleCriteriaId}

Updates a single role criteria for a role.

Parameters

Parameter In Type Required Default Description Accepted Values
roleCriteriaId path string true N/A The unique ID of the role criteria. -
body body putRoleCriteria true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Role Criteria

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/role-criteria/eea2d24d-a978-4132-afdd-30429789b569', headers: headers)

print JSON.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'

Example response

{
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "roleId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "consumerGroupIds": [
    "591f9612-deef-4e0a-96c9-8e9b749c2eea",
    "f5380953-564b-4037-80c8-10395f1c9384"
  ]
}

GET /role-criteria/{roleCriteriaId}

Retrieves a single role criteria for a role.

Parameters

Parameter In Type Required Default Description Accepted Values
roleCriteriaId path string true N/A The unique ID of the role criteria. -

Response Statuses

Status Meaning Description Schema
200 OK Success RoleCriteria
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Consumer Role

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.2
require '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)

print JSON.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. -
roleId query string true N/A The ID of the role to remove. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Add a Consumer to a Consumer Role

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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 )

print JSON.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.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Consumer Roles

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/consumer-roles',
  query: {
  'consumerId' => 'string'
}, headers: headers)

print JSON.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'

Example response

{
  "consumerRoles": [
    {
      "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
      "name": "MEMBER",
      "domainName": "cernerdemo.wellness.us.healtheintent.com"
    }
  ]
}

GET /consumer-roles

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. -

Response Statuses

Status Meaning Description Schema
200 OK Success ConsumerRole
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Site

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.

Create a Site

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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 )

print JSON.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"}]}

Example response

{
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "name": "CernerInOutbox",
  "alerts": [
    {
      "id": "96669af8-5a1d-40d5-8000-50936ee57ca6"
    }
  ],
  "roleCriteria": [
    {
      "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
    }
  ],
  "customScripts": [
    {
      "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
    }
  ],
  "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"
    }
  ],
  "privacyPolicy": {
    "id": "adea0443-60a9-4086-8383-071d1d62210c"
  },
  "termsOfUse": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "titles": [
    {
      "text": "Dashboard",
      "locale": "en-US"
    }
  ]
}

POST /sites

Creates a site.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Site
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created site.

Retrieve a List of Sites

Example Request:


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

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

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

print JSON.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'

Example response

{
  "items": [
    {
      "id": "eea2d24d-a978-4132-afdd-30429789b569",
      "name": "CernerInOutbox",
      "alerts": [
        {
          "id": "96669af8-5a1d-40d5-8000-50936ee57ca6"
        }
      ],
      "roleCriteria": [
        {
          "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
        }
      ],
      "customScripts": [
        {
          "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
        }
      ],
      "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"
        }
      ],
      "privacyPolicy": {
        "id": "adea0443-60a9-4086-8383-071d1d62210c"
      },
      "termsOfUse": {
        "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
      },
      "titles": [
        {
          "text": "Dashboard",
          "locale": "en-US"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites?offset=0&limit=20"
}

GET /sites

Retrieves a list of available sites.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Sites
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Site

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569', headers: headers)

print JSON.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'

DELETE /sites/{siteId}

Deletes a single site.

Parameters

Parameter In Type Required Default Description Accepted Values
siteId path string true N/A The unique ID of the site. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Site

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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 )

print JSON.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"}]}

PUT /sites/{siteId}

Updates a single site.

Parameters

Parameter In Type Required Default Description Accepted Values
siteId path string true N/A The unique ID of the site. -
body body putSites true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Site

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/sites/eea2d24d-a978-4132-afdd-30429789b569', headers: headers)

print JSON.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'

Example response

{
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "name": "CernerInOutbox",
  "alerts": [
    {
      "id": "96669af8-5a1d-40d5-8000-50936ee57ca6"
    }
  ],
  "roleCriteria": [
    {
      "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
    }
  ],
  "customScripts": [
    {
      "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
    }
  ],
  "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"
    }
  ],
  "privacyPolicy": {
    "id": "adea0443-60a9-4086-8383-071d1d62210c"
  },
  "termsOfUse": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "titles": [
    {
      "text": "Dashboard",
      "locale": "en-US"
    }
  ]
}

GET /sites/{siteId}

Retrieves a single site.

Parameters

Parameter In Type Required Default Description Accepted Values
siteId path string true N/A The unique ID of the site. -

Response Statuses

Status Meaning Description Schema
200 OK Success Site
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Navigation

Navigations are the configurations of site links for primary and account navigation.

Create a Navigation

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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"}],"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"}]}]}]}.to_json )

print JSON.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"}],"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"}]}]}]}

Example response

{
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "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"
        }
      ],
      "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"
            }
          ]
        }
      ]
    }
  ]
}

POST /navigations

Creates a navigation.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created SiteNavigation
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created navigation.

Retrieve a List of Navigations

Example Request:


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

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

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

print JSON.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'

Example response

{
  "items": [
    {
      "id": "eea2d24d-a978-4132-afdd-30429789b569",
      "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"
            }
          ],
          "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"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations?offset=0&limit=20"
}

GET /navigations

Retrieves a list of available navigations.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteNavigations
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Navigation

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569', headers: headers)

print JSON.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'

DELETE /navigations/{navigationId}

Deletes a single navigation.

Parameters

Parameter In Type Required Default Description Accepted Values
navigationId path string true N/A The unique ID of the navigation. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Navigation

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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"}],"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"}]}]}]}.to_json )

print JSON.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"}],"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"}]}]}]}

PUT /navigations/{navigationId}

Updates a single navigation.

Parameters

Parameter In Type Required Default Description Accepted Values
navigationId path string true N/A The unique ID of the navigation. -
body body putNavigations true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Navigation

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/navigations/eea2d24d-a978-4132-afdd-30429789b569', headers: headers)

print JSON.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'

Example response

{
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "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"
        }
      ],
      "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"
            }
          ]
        }
      ]
    }
  ]
}

GET /navigations/{navigationId}

Retrieves a single navigation.

Parameters

Parameter In Type Required Default Description Accepted Values
navigationId path string true N/A The unique ID of the navigation. -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteNavigation
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Site Definition

A site definition is a set of static configurations used when displaying a site. These configurations are the baseline for the site that must be available for every HealtheIntent consumer.

Create a Site Definition

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions', headers: headers, body: {"siteId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}.to_json )

print JSON.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":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}

Example response

{
  "siteDefinitionId": "99e73e70-27fe-4b9f-93f2-0e1e0792b289"
}

POST /site-definitions

Creates a new site definition from a site ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Success SiteDefinitionPost
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a Single Site Definition

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions',
  query: {
  'domainName' => 'string'
}, headers: headers)

print JSON.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 domain name of the site from which to look up the site definition. -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteDefinition
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Site Definition

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-definitions/99e73e70-27fe-4b9f-93f2-0e1e0792b289', headers: headers)

print JSON.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 for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
siteDefinitionId path string true N/A The instance ID of the site definition. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Site Experience

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.

Retrieve a Single Site Experience

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/site-experiences',
  query: {
  'domainName' => 'string'
}, headers: headers)

print JSON.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",
              "navItems": [
                {
                  "target": "_blank",
                  "uri": "https://example.com",
                  "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
                  "title": "Home"
                }
              ]
            }
          ]
        },
        "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",
              "navItems": [
                {
                  "target": "_blank",
                  "uri": "https://example.com",
                  "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
                  "title": "Home"
                }
              ]
            }
          ]
        },
        "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",
              "navItems": [
                {
                  "target": "_blank",
                  "uri": "https://example.com",
                  "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
                  "title": "Home"
                }
              ]
            }
          ]
        }
      },
      "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"
                          }
                        }
                      ],
                      "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"
                            }
                          }
                        }
                      ]
                    }
                  ]
                },
                "nativeView": {
                  "root_exposure": {
                    "attribute": null,
                    "options": {
                      "nesting": true
                    },
                    "key": null,
                    "is_safe": null,
                    "for_merge": null,
                    "attr_path_proc": null,
                    "documentation": null,
                    "override": null,
                    "conditions": [],
                    "nested_exposures": [
                      {
                        "attribute": "id",
                        "options": {
                          "expose_nil": false,
                          "documentation": {
                            "type": {},
                            "desc": "The ID of the native view record.",
                            "example": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
                            "require": true
                          }
                        },
                        "key": "id",
                        "is_safe": null,
                        "for_merge": null,
                        "attr_path_proc": null,
                        "documentation": {
                          "type": {},
                          "desc": "The ID of the native view record.",
                          "example": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
                          "require": true
                        },
                        "override": null,
                        "conditions": [
                          {
                            "inverse": true,
                            "block": {}
                          }
                        ]
                      },
                      {
                        "attribute": "alias",
                        "options": {
                          "expose_nil": false,
                          "documentation": {
                            "type": {},
                            "desc": "The native workflow key of the view record.",
                            "example": "messaging_inbox",
                            "require": true
                          }
                        },
                        "key": "alias",
                        "is_safe": null,
                        "for_merge": null,
                        "attr_path_proc": null,
                        "documentation": {
                          "type": {},
                          "desc": "The native workflow key of the view record.",
                          "example": "messaging_inbox",
                          "require": true
                        },
                        "override": null,
                        "conditions": [
                          {
                            "inverse": true,
                            "block": {}
                          }
                        ]
                      }
                    ]
                  },
                  "formatters": {},
                  "block_options": [],
                  "documentation": null,
                  "nesting_stack": []
                },
                "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 (-). -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteExperience
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Domain

A domain is a mapping between a unique domain name and a specific site definition.

Deletes a Domain

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com', headers: headers)

print JSON.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. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create or Update a Domain

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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"}]}.to_json )

print JSON.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"}]}

PUT /domains/{domainName}

Creates or updates the attributes of a domain record for a given domain name.

Parameters

Parameter In Type Required Default Description Accepted Values
domainName path string true N/A The unique URL of a domain resource. -
body body putDomains true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a Single Domain

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com', headers: headers)

print JSON.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'

Example response

{
  "siteDefinitionId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "domainName": "cernerdemo.wellness.us.healtheintent.com",
  "authorizedPersonnelGroups": [
    {
      "id": "973ed0ef-894d-43bc-b756-70a65712bde7"
    }
  ]
}

GET /domains/{domainName}

Retrieves a domain record by the domain name.

Parameters

Parameter In Type Required Default Description Accepted Values
domainName path string true N/A The unique URL ID for a domain resource. -

Response Statuses

Status Meaning Description Schema
200 OK Success Domain
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a List of Domains

Example Request:


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

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

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

print JSON.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'

Example response

{
  "items": [
    {
      "siteDefinitionId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
      "domainName": "cernerdemo.wellness.us.healtheintent.com",
      "authorizedPersonnelGroups": [
        {
          "id": "973ed0ef-894d-43bc-b756-70a65712bde7"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/domains?offset=0&limit=20"
}

GET /domains

Retrieves all the Consumer Framework domains.

Parameters

Parameter In Type Required Default Description Accepted Values
personnelGroupId query array[string] false N/A 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. -

Response Statuses

Status Meaning Description Schema
200 OK Success Domains
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Affiliate Domain

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.2
require '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)

print JSON.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. -

Response Statuses

Status Meaning Description Schema
200 OK Success AffiliateDomains
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Application

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.

Create an Application

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications', headers: headers, body: {"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 )

print JSON.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 {"appManifest":{"id":"00322720-0mw2-0959-a24d-888la147b476"},"roles":[{"name":"CONSUMER_ACCESS_GROUP"}],"properties":[{"input":"demo.wellness.us.healtheintent.com","property":"wellness_domain_host"}]}

Example response

{
  "id": "803jb720-39ec-4059-a24d-088afla5b476",
  "appManifest": {
    "id": "00322720-0mw2-0959-a24d-888la147b476"
  },
  "roles": [
    {
      "name": "CONSUMER_ACCESS_GROUP"
    }
  ],
  "properties": [
    {
      "input": "demo.wellness.us.healtheintent.com",
      "property": "wellness_domain_host"
    }
  ]
}

POST /applications

Creates an application.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Application
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created application.

Retrieve a List of Applications

Example Request:


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

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

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

print JSON.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'

Example response

{
  "items": [
    {
      "id": "803jb720-39ec-4059-a24d-088afla5b476",
      "appManifest": {
        "id": "00322720-0mw2-0959-a24d-888la147b476"
      },
      "roles": [
        {
          "name": "CONSUMER_ACCESS_GROUP"
        }
      ],
      "properties": [
        {
          "input": "demo.wellness.us.healtheintent.com",
          "property": "wellness_domain_host"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications?offset=0&limit=20"
}

GET /applications

Retrieves a list of applications.

Parameters

Parameter In Type Required Default Description Accepted Values
id query array[string] false N/A Filters by the ID of the application. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Applications
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete an Application

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476', headers: headers)

print JSON.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'

DELETE /applications/{applicationId}

Deletes the application with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
applicationId path string true N/A The unique ID of the application. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update an Application

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476', headers: headers, body: {"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 )

print JSON.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 {"appManifest":{"id":"00322720-0mw2-0959-a24d-888la147b476"},"roles":[{"name":"CONSUMER_ACCESS_GROUP"}],"properties":[{"input":"demo.wellness.us.healtheintent.com","property":"wellness_domain_host"}]}

PUT /applications/{applicationId}

Updates the application with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
applicationId path string true N/A The unique ID of the application. -
body body putApplications true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Application

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/applications/803jb720-39ec-4059-a24d-088afla5b476', headers: headers)

print JSON.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'

Example response

{
  "id": "803jb720-39ec-4059-a24d-088afla5b476",
  "appManifest": {
    "id": "00322720-0mw2-0959-a24d-888la147b476"
  },
  "roles": [
    {
      "name": "CONSUMER_ACCESS_GROUP"
    }
  ],
  "properties": [
    {
      "input": "demo.wellness.us.healtheintent.com",
      "property": "wellness_domain_host"
    }
  ]
}

GET /applications/{applicationId}

Retrieves a single application by its ID.

Parameters

Parameter In Type Required Default Description Accepted Values
applicationId path string true N/A The unique ID of the application. -

Response Statuses

Status Meaning Description Schema
200 OK Success Application
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Application Manifest

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.

Create an Application Manifest

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests', headers: headers, body: {"name":"CernerMessaging","version":"1.0.0","title":"CernerMessaging","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 )

print JSON.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","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"
    }
  ]
}

POST /app-manifests

Creates an application manifest.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created AppManifest
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created application manifest.

Retrieve a List of Application Manifests

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests', headers: headers)

print JSON.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. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success AppManifests
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete an Application Manifest

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496', headers: headers)

print JSON.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.

Parameters

Parameter In Type Required Default Description Accepted Values
appManifestId path string true N/A The unique ID of the application manifest. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update an Application Manifest

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496', headers: headers, body: {"name":"CernerMessaging","version":"1.0.0","title":"CernerMessaging","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 )

print JSON.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","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.

Parameters

Parameter In Type Required Default Description Accepted Values
appManifestId path string true N/A The unique ID of the application manifest. -
body body putAppManifests true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Application Manifest

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/app-manifests/803jl720-39cc-4159-a24d-088afla5b496', headers: headers)

print JSON.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.

Parameters

Parameter In Type Required Default Description Accepted Values
appManifestId path string true N/A The unique ID of the application manifest. -

Response Statuses

Status Meaning Description Schema
200 OK Success AppManifest
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Static Asset

A URL that links to files uploaded from another source. The URL enables using and managing site assets or files from an external source.

Create a Static Asset

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets', headers: headers, body: {"key":"logo123.png","name":"background.png"}.to_json )

print JSON.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"}

Example response

{
  "id": "123UID",
  "key": "logo123.png",
  "name": "background.png",
  "assetLocation": "https://apex-assets.us-1.healtheintent.com/mnemonic/logo123.png",
  "signedUrl": "https://aws.com/signed-url"
}

POST /static-assets

Creates a static asset.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created StaticAssetPost
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created static asset.

Retrieve a List of Static Assets

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets', headers: headers)

print JSON.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'

Example response

{
  "items": [
    {
      "id": "123UID",
      "key": "logo123.png",
      "name": "background.png",
      "assetLocation": "https://assets.healthelifeframework.us-1.healtheintent.com/mnemonic/logo123.png"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets?offset=0&limit=20"
}

GET /static-assets

Retrieves a list of available static assets.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success StaticAssets
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Static Asset

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID', headers: headers)

print JSON.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'

DELETE /static-assets/{staticAssetId}

Deletes a single static asset.

Parameters

Parameter In Type Required Default Description Accepted Values
staticAssetId path string true N/A The unique ID of the static asset instance. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Static Asset

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID', headers: headers, body: {"name":"background.png"}.to_json )

print JSON.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"}

Example response

{
  "id": "123UID",
  "key": "logo123.png",
  "name": "background.png",
  "assetLocation": "https://apex-assets.us-1.healtheintent.com/mnemonic/logo123.png",
  "signedUrl": "https://aws.com/signed-url"
}

PUT /static-assets/{staticAssetId}

Updates a single static asset.

Parameters

Parameter In Type Required Default Description Accepted Values
staticAssetId path string true N/A The unique ID of the static asset instance. -
body body putStaticAssets true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK Updated StaticAssetPost
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Static Asset

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/static-assets/123UID', headers: headers)

print JSON.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'

Example response

{
  "id": "123UID",
  "key": "logo123.png",
  "name": "background.png",
  "assetLocation": "https://assets.healthelifeframework.us-1.healtheintent.com/mnemonic/logo123.png"
}

GET /static-assets/{staticAssetId}

Retrieves a single static asset.

Parameters

Parameter In Type Required Default Description Accepted Values
staticAssetId path string true N/A The unique ID of the static asset instance. -

Response Statuses

Status Meaning Description Schema
200 OK Success StaticAsset
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Themes

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.2
require 'json'

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

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

print JSON.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. -

Response Statuses

Status Meaning Description Schema
200 OK Success Themes
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Brand

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.2
require '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 )

print JSON.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"}]}}

Example response

{
  "id": "883jb720-398c-4859-a24d-088afla5b476",
  "logo": {
    "id": "333jb720-398c-4859-a24d-088afla9b476",
    "src": "https://xyz.cloudfront.net/main-logo.png",
    "height": "100",
    "width": "100",
    "altTexts": [
      {
        "text": "English Localized Text",
        "locale": "en-US"
      }
    ]
  },
  "favicons": [
    {
      "id": "a01jb720-398c-4859-a24d-088afla9b476",
      "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"
      }
    ]
  }
}

POST /brands

Creates a brand.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created SiteBrand
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created brand.

Retrieve a List of Brands

Example Request:


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

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

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

print JSON.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'

Example response

{
  "items": [
    {
      "id": "883jb720-398c-4859-a24d-088afla5b476",
      "logo": {
        "id": "333jb720-398c-4859-a24d-088afla9b476",
        "src": "https://xyz.cloudfront.net/main-logo.png",
        "height": "100",
        "width": "100",
        "altTexts": [
          {
            "text": "English Localized Text",
            "locale": "en-US"
          }
        ]
      },
      "favicons": [
        {
          "id": "a01jb720-398c-4859-a24d-088afla9b476",
          "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"
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands?offset=0&limit=20"
}

GET /brands

Retrieves a list of brands.

Parameters

Parameter In Type Required Default Description Accepted Values
id query array[string] false N/A Filters by the ID of the brand. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteBrands
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Brand

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476', headers: headers)

print JSON.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'

DELETE /brands/{brandId}

Deletes the brand with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
brandId path string true N/A The unique ID of the brand. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Brand

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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 )

print JSON.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"}]}}

PUT /brands/{brandId}

Updates the brand with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
brandId path string true N/A The unique ID of the brand. -
body body putBrands true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Brand

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/brands/883jb720-398c-4859-a24d-088afla5b476', headers: headers)

print JSON.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'

Example response

{
  "id": "883jb720-398c-4859-a24d-088afla5b476",
  "logo": {
    "id": "333jb720-398c-4859-a24d-088afla9b476",
    "src": "https://xyz.cloudfront.net/main-logo.png",
    "height": "100",
    "width": "100",
    "altTexts": [
      {
        "text": "English Localized Text",
        "locale": "en-US"
      }
    ]
  },
  "favicons": [
    {
      "id": "a01jb720-398c-4859-a24d-088afla9b476",
      "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"
      }
    ]
  }
}

GET /brands/{brandId}

Retrieves a single brand by its ID.

Parameters

Parameter In Type Required Default Description Accepted Values
brandId path string true N/A The unique ID of the brand. -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteBrand
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Consumer Enrollment

A consumer enrollment contains the information to provide enrollment access through an application experience. Consumer enrollment includes the following resources:

Create an Enrollment Pool

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools', headers: headers, body: {"name":"MEMBER","domain":"cernerdemo.wellness.us.healtheintent.com","role":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"MEMBER","domain":"cernerdemo.wellness.us.healtheintent.com","role":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "name": "MEMBER",
  "role": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "domain": "cernerdemo.wellness.us.healtheintent.com"
}

POST /enrollment-pools

Creates an enrollment pool for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Pool
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created pool.

Retrieve a List of Enrollment Pools

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
      "name": "MEMBER",
      "role": {
        "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
      },
      "domain": "cernerdemo.wellness.us.healtheintent.com"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pools?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/pools?offset=0&limit=20"
}

GET /enrollment-pools

Retrieves all of the available enrollment pools for a HealtheIntent tenant.

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. -
name query string false N/A Filters by the name of the pool. -

Response Statuses

Status Meaning Description Schema
200 OK Success Pools
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Remove an Enrollment Pool

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /enrollment-pools/{poolId}

Deletes a single enrollment pool for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
poolId path string true N/A The ID of the pool. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update an Enrollment Pool

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers, body: {"name":"MEMBER","domain":"cernerdemo.wellness.us.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"MEMBER","domain":"cernerdemo.wellness.us.healtheintent.com"}

PUT /enrollment-pools/{poolId}

Updates a single enrollment pool for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
poolId path string true N/A The ID of the pool. -
body body putEnrollmentPools true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Enrollment Pool

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollment-pools/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "name": "MEMBER",
  "role": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "domain": "cernerdemo.wellness.us.healtheintent.com"
}

GET /enrollment-pools/{poolId}

Retrieves a single enrollment pool for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
poolId path string true N/A The ID of the pool. -

Response Statuses

Status Meaning Description Schema
200 OK Success Pool
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create a Completed Enrollment

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments', headers: headers, body: {"startDate":"1997-05-22","endDate":"1998-05-22","principalAlias":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","enrollment":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"startDate":"1997-05-22","endDate":"1998-05-22","principalAlias":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","enrollment":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "principalAlias": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "startDate": "1997-05-22",
  "endDate": "1998-05-22",
  "enrollment": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  }
}

POST /completed-enrollments

Creates a completed enrollment for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created CompletedEnrollment
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created completed enrollment.

Retrieve a List of Completed Enrollments

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
      "principalAlias": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
      "startDate": "1997-05-22",
      "endDate": "1998-05-22",
      "enrollment": {
        "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed_enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed_enrollments?offset=0&limit=20"
}

GET /completed-enrollments

Retrieves all of the available completed enrollments for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
start_date query string(date) false N/A Filters by the start date. -
enrollment_id query array[string] false N/A Filters by the enrollment ID. -
status query string false N/A Filters by the status of Enrolled or Unenrolled. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success CompletedEnrollments
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Remove a Completed Enrollment

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /completed-enrollments/{completedEnrollmentId}

Deletes a single completed enrollment for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
completedEnrollmentId path string true N/A The ID of the completed enrollment. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Completed Enrollment

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers, body: {"startDate":"1997-05-22","endDate":"1998-05-22","principalAlias":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","enrollment":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"startDate":"1997-05-22","endDate":"1998-05-22","principalAlias":"772adbb6-d0c9-46e1-acd5-a5c07c325f88","enrollment":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}

PUT /completed-enrollments/{completedEnrollmentId}

Updates a single completed enrollment for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
completedEnrollmentId path string true N/A The ID of the completed enrollment. -
consumerId query string false N/A The consumer ID to associate with the role. -
domain query string false N/A The domain name of the site where the role is present. -
body body putCompletedEnrollments true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Completed Enrollment

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/completed-enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "principalAlias": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "startDate": "1997-05-22",
  "endDate": "1998-05-22",
  "enrollment": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  }
}

GET /completed-enrollments/{completedEnrollmentId}

Retrieves a single completed enrollment for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
completedEnrollmentId path string true N/A The ID of the completed enrollment. -

Response Statuses

Status Meaning Description Schema
200 OK Success CompletedEnrollment
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Create an Enrollment

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments', headers: headers, body: {"firstName":"Jane","lastName":"Smith","dateOfBirth":"1997-05-22","enrollmentId":"30191e65-d42f-4897-945d-9a0eaa5a1536","pool":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"firstName":"Jane","lastName":"Smith","dateOfBirth":"1997-05-22","enrollmentId":"30191e65-d42f-4897-945d-9a0eaa5a1536","pool":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "firstName": "Jane",
  "lastName": "Smith",
  "dateOfBirth": "1997-05-22",
  "enrollmentId": "30191e65-d42f-4897-945d-9a0eaa5a1536",
  "pool": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  }
}

POST /enrollments

Creates an enrollment for a HealtheIntent tenant.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created Enrollment
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created enrollment.

Retrieve a List of Enrollments

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
      "firstName": "Jane",
      "lastName": "Smith",
      "dateOfBirth": "1997-05-22",
      "enrollmentId": "30191e65-d42f-4897-945d-9a0eaa5a1536",
      "pool": {
        "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments?offset=0&limit=20"
}

GET /enrollments

Retrieves all of the available enrollments for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
dateOfBirth query string false N/A Filters by the date of birth. -
enrollmentId query string false N/A Filters by the enrollment ID. -
firstName query string false N/A Filters by the first name. -
lastName query string false N/A Filters by the last name. -
poolId query string false N/A Filters by the pool 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. -

Response Statuses

Status Meaning Description Schema
200 OK Success Enrollments
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Remove an Enrollment

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /enrollments/{id}

Deletes a single enrollment for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the enrollment. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update an Enrollment

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers, body: {"firstName":"Jane","lastName":"Smith","dateOfBirth":"1997-05-22","enrollmentId":"30191e65-d42f-4897-945d-9a0eaa5a1536","pool":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"firstName":"Jane","lastName":"Smith","dateOfBirth":"1997-05-22","enrollmentId":"30191e65-d42f-4897-945d-9a0eaa5a1536","pool":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}}

PUT /enrollments/{id}

Updates a single enrollment for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the enrollment. -
body body putEnrollments true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Enrollment

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/enrollments/1d3ab7ca-30ec-4b59-a24d-506afc25b476 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "firstName": "Jane",
  "lastName": "Smith",
  "dateOfBirth": "1997-05-22",
  "enrollmentId": "30191e65-d42f-4897-945d-9a0eaa5a1536",
  "pool": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  }
}

GET /enrollments/{id}

Retrieves a single enrollment for a HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the enrollment. -

Response Statuses

Status Meaning Description Schema
200 OK Success Enrollment
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Custom Content

Custom content allows you to configure the Consumer Well-being site and dashboard design.

Create a Custom Content Item

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/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 )

print JSON.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"
  }
}

POST /custom-content

Creates a new custom content item.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created. CustomContent
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Retrieve a List of Custom Content

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content', headers: headers)

print JSON.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 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. -

Response Statuses

Status Meaning Description Schema
200 OK Success CustomContents
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Custom Content Item

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5', headers: headers)

print JSON.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'

DELETE /custom-content/{customContentId}

Deletes a specific custom content item.

Parameters

Parameter In Type Required Default Description Accepted Values
customContentId path string true N/A The ID of the custom content item. -

Response Statuses

Status Meaning Description Schema
204 No Content Deleted None
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Update a Custom Content Item

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us-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 )

print JSON.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."}

PUT /custom-content/{customContentId}

Updates a specific custom content item.

Parameters

Parameter In Type Required Default Description Accepted Values
customContentId path string true N/A The ID of the custom content item. -
body body putCustomContent true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content Updated None
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Retrieve a Single Custom Content Item

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/application-experience/v1/custom-content/0480717b-4aa0-43e1-a3ec-a0b81379d5f5', headers: headers)

print JSON.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"
  }
}

GET /custom-content/{customContentId}

Retrieves a specific custom content item.

Parameters

Parameter In Type Required Default Description Accepted Values
customContentId path string true N/A The ID of the custom content item. -

Response Statuses

Status Meaning Description Schema
200 OK Success CustomContent
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError
404 Not Found Not Found NotFoundError

Custom Content Templates

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.2
require '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)

print JSON.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. -

Response Statuses

Status Meaning Description Schema
200 OK Success CustomContentTemplates
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Schema Definitions

postApplications

Name Type Required Description Accepted Values
appManifest object true A reference to the application manifest used by the application. -
» id string true The ID of the application manifest to which the application is connected. -
roles [object] true The list of role names. -
» name string true The name of a role. -
properties [object] false The list of the application’s configured properties. -
» input string true The value of the application’s property. -
» property string true The name of the application’s property. -

Application

Name Type Required Description Accepted Values
id string true The unique ID of the application. -
appManifest Application_AppManifestReference true A reference to the application manifest used by the application. -
roles [Application_ApplicationRole] true The list of role names. -
properties [Application_Property] false The list of the application’s configured properties. -

UnauthorizedError

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

ErrorDetail

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

UnauthorizedErrorDetail

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

ForbiddenError

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

ForbiddenErrorDetail

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

BadRequestError

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

BadRequestErrorDetail

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

Applications

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

NotFoundError

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

NotFoundErrorDetail

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

putApplications

Name Type Required Description Accepted Values
appManifest object true A reference to the application manifest used by the application. -
» id string true The ID of the application manifest to which the application is connected. -
roles [object] true The list of role names. -
» name string true The name of a role. -
properties [object] false The list of the application’s configured properties. -
» input string true The value of the application’s property. -
» property string true The name of the application’s property. -

postAppManifests

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. -
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. -
supportTelecoms [AppManifest_SupportTelecoms] false The list of support contacts for the site. -
owner string true The name of the site owner. -
vendor string true The name of the vendor who is providing the manifest. -
title string true A human-readable name of the application manifest. -
inputs [AppManifest_Input] 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. -
views [AppManifest_View] true The list of views. -

AppManifests

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

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. -
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. -

postBrands

Name Type Required Description Accepted Values
logo object true The logo image for the site. -
» src string true The URL where the logo image is located. -
» height integer(int32) true The height of the logo in pixels. -
» width integer(int32) true The width of the logo in pixels. -
» altTexts [object] false A list of localized, alternative text values. -
»» text string true The translated text for the given locale. -
»» 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 (-). -
favicons [object] true The list of favicons of the brand. -
» href string true The URL where the favicon is located. -
» iconType string true The type of the favicon. -
» sizes string true The height and width of the favicon in pixels. -
theme object true The theme of the brand. -
» key string true The unique name of the theme. -
» name string true A human-readable name of the theme. -
» properties [object] false The list of CSS theme properties. -
»» key string true The name of the CSS property. -
»» value string true The value of the CSS property. -

SiteBrand

Name Type Required Description Accepted Values
id string true The unique ID of the brand. -
logo SiteBrand_Logo true The logo image for the site. -
favicons [SiteBrand_Favicon] true The list of favicons of the brand. -
theme SiteBrand_Theme true The theme of the brand. -

SiteBrands

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

putBrands

Name Type Required Description Accepted Values
logo object true The logo image for the site. -
» src string true The URL where the logo image is located. -
» height integer(int32) true The height of the logo in pixels. -
» width integer(int32) true The width of the logo in pixels. -
» altTexts [object] false A list of localized, alternative text values. -
»» text string true The translated text for the given locale. -
»» 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 (-). -
favicons [object] true The list of favicons of the brand. -
» href string true The URL where the favicon is located. -
» iconType string true The type of the favicon. -
» sizes string true The height and width of the favicon in pixels. -
theme object true The theme of the brand. -
» key string true The unique name of the theme. -
» name string true A human-readable name of the theme. -
» properties [object] false The list of CSS theme properties. -
»» key string true The name of the CSS property. -
»» value string true The value of the CSS property. -

ConsumerRole

Name Type Required Description Accepted Values
consumerRoles [Role] true A list of consumer role IDs. -

Role

Name Type Required Description Accepted Values
id string true The unique ID of the role. -
name string true A user-friendly name for the role. -
domainName string true The domain name that corresponds to the role. -

postConsumerRoles

Name Type Required Description Accepted Values
consumerId string true The ID of the consumer for whom to assign roles. -
domainName string true The domain name of the site for which to assign roles. -
roleId string true The ID of the role to assign. -

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. -
authorizedPersonnelGroups [AuthorizedPersonnelGroup] true The personnel groups that are authorized to configure a domain. -

AuthorizedPersonnelGroup

Name Type Required Description Accepted Values
id string true The ID of the authorized personnel group. -

putDomains

Name Type Required Description Accepted Values
siteDefinitionId string false The instance ID of the site definition that is applied to this domain -
authorizedPersonnel [string] false The personnel groups that are authorized to configure a domain. -

AffiliateDomains

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

AffiliateDomain

Name Type Required Description Accepted Values
domainName string true The domain name that corresponds to the master site. -
siteDefinition SiteDefinition_AffiliateSiteDefinitionConfig false The part of the site definition configuration that is applied to the affiliate domain. -

LocalizedText

Name Type Required Description Accepted Values
text string true The translated text for the given locale. -
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 (-). -

RoleCriteria

Name Type Required Description Accepted Values
id string false The unique ID of the role criteria. -
roleId string true The ID of the role attached to the role criteria. -
consumerGroupIds string false An array of consumer group UUIDs that can be used to build a role criteria. -

Domains

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

postSites

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] true 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] true 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 true The support contact information associated with the site. -
» phone string true The support phone number associated with the site. -
» email string true 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] true 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. -
» navType string true The navigation type. primary_navigation, profile_navigation, quick_navigation
» navId string true The unique ID of the navigation. -
roleCriteria [object] false The list of role criteria IDs associated with the site. -
» id string true The ID of the role criteria. -
customScripts [object] false The list of custom script IDs associated with the site. -
» id string true The ID of the custom script. -
privacyPolicy string true The privacy policy associated with the site. -
termsOfUse string true The terms of use associated with the site. -
titles [object] true The list of titles for the site. -
» locale string true The locale of the title -
» text string true The title text. -

Site

Name Type Required Description Accepted Values
id string true The unique ID of the site. -
name string true The name of the site. -
alerts [Site_AlertReference] true The list of alert IDs associated with the site. -
roleCriteria [Site_RoleCriteriaReference] false The list of role criteria IDs associated with the site. -
customScripts [Site_CustomScriptReference] false The list of custom script IDs associated with the site. -
applications [Site_ApplicationReference] false The list of application IDs associated with the site. -
identityRealms [Site_IdentityRealmReference] true The list of identity realms. -
locales [Site_Locale] true The list of locales. -
pages [Site_PageReference] true The list of page IDs associated with the site. -
support Site_Support false The support contact information associated with the site. -
brand [Site_BrandReference] false The list of brand IDs associated with the site. -
navs [Site_Nav] true The list of navigations for the site. -
privacyPolicy Site_PrivacyPolicyReference false The privacy policy associated with the site. -
termsOfUse Site_TermsOfUseReference false The terms of use associated with the site. -
titles [Site_Title] true The list of titles for the site. -

Sites

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

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] true 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] true 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 true The support contact information associated with the site. -
» phone string true The support phone number associated with the site. -
» email string true 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] true 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. -
» navType string true The navigation type. primary_navigation, profile_navigation, quick_navigation
» navId string true The unique ID of the navigation. -
roleCriteria [object] false The list of role criteria IDs associated with the site. -
» id string true The ID of the role criteria. -
customScripts [object] false The list of custom script IDs associated with the site. -
» id string true The ID of the custom script. -
privacyPolicy string true The privacy policy associated with the site. -
termsOfUse string true The terms of use associated with the site. -
titles [object] true The list of titles for the site. -
» locale string true The locale of the title -
» text string true The title text. -

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. appExperience#page, appExperience#appManifest, externalUrl
» path string true 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 specific resource that is referenced. -
» 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. appExperience#page, appExperience#appManifest, externalUrl
»» path string true 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 specific resource that is referenced. -
»» 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. appExperience#page, appExperience#appManifest, externalUrl
»»» path string true 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 specific resource that is referenced. -
»»» 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. -

Name Type Required Description Accepted Values
id string false The unique ID of the navigation. -
type string true The purpose of the navigation instance. -
name string true The name of the navigation instance. -
navItems [Navigation_NavigationItemReference] false The list of navigation items at the top level of the navigation instance. -

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

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. appExperience#page, appExperience#appManifest, externalUrl
» path string true 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 specific resource that is referenced. -
» 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. appExperience#page, appExperience#appManifest, externalUrl
»» path string true 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 specific resource that is referenced. -
»» 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. appExperience#page, appExperience#appManifest, externalUrl
»»» path string true 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 specific resource that is referenced. -
»»» 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. -

postLayouts

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] true 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. -

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). -
defaultConfig Layout_LayoutGridConfig 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. -
responsiveConfigs [Layout_ResponsiveLayoutGridConfig] 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. -
regions [Layout_LayoutRegion] true The list of regions in the layout. -

Layouts

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

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] true 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. -

postCustomContent

Name Type Required Description Accepted Values
templateKey string true The key that uniquely identifies a custom content template. -
properties object true The list of the custom content’s properties. -
name string true The name that uniquely identifies a specific custom content item. -
description string true The description of a custom content item. -

CustomContent

Name Type Required Description Accepted Values
id string true The ID of the custom content item. -
name string true The name that uniquely identifies a specific custom content item. -
description string false The description of a custom content item. -
templateKey string true The key that uniquely identifies a custom content template. -
properties object true The list of the custom content’s properties. -

CustomContents

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

putCustomContent

Name Type Required Description Accepted Values
templateKey string true The key that uniquely identifies a custom content template. -
properties object true The list of the custom content’s properties. -
name string true The name that uniquely identifies a specific custom content item. -
description string true The description of a custom content item. -

postPages

Name Type Required Description Accepted Values
path string true A relative URL 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 URL. 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] true 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 to be determined. applicationExperience#appManifest
» appId string true The installed application’s ID. -
» viewName string true The name of the view. -
» regionId string true The layout region’s ID. -

CustomPage

Name Type Required Description Accepted Values
id string true The ID of the page record. -
path string true A relative URL 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 URL. This alias should contain only alphabetic characters (A-Za-z) and numeric digits (0-9). -
roles [CustomPage_RoleReference] true Only the role IDs defined in this group can access the page. -
layout CustomPage_LayoutReference true The layout of the page. -
views [CustomPage_ViewReference] true The views of the page. -

CustomPages

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

putPages

Name Type Required Description Accepted Values
path string true A relative URL 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 URL. 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] true 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 to be determined. applicationExperience#appManifest
» appId string true The installed application’s ID. -
» viewName string true The name of the view. -
» regionId string true The layout region’s ID. -

PrivacyPolicies

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

PrivacyPolicy

Name Type Required Description Accepted Values
instanceId string true The instance ID of the privacy policy. -
privacyPolicyId string true The ID of the privacy policy. The ID can be shared by multiple instances of the same privacy policy. -
createdAt string true The date and time when the privacy policy was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
content [PrivacyPolicyTranslation] false The content of the privacy policy. -

PrivacyPolicyTranslation

Name Type Required Description Accepted Values
locale string false 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. -

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. -

SiteDefinition

Name Type Required Description Accepted Values
siteDefinition [SiteDefinition_SiteDefinitionConfig] true The properties of the site definition. An empty array is returned if properties are not found. -

LoggingUri

Name Type Required Description Accepted Values
uri string true The URI for front-end logging. Near real-time logging for front-end components, such as pagelet loading. -

TermsOfUse

Name Type Required Description Accepted Values
instanceId string true The instance ID of the terms of use. -
touId string true The ID of the terms of use. The ID can be shared by multiple instances of the same terms of use. -
createdAt string true The date and time when the terms of use was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
content [TermsOfUseTranslation] false The content of the terms of use. -

TermsOfUseTranslation

Name Type Required Description Accepted Values
locale string false 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. -

SiteExperience

Name Type Required Description Accepted Values
siteExperience [SiteExperienceConfig] true The properties of the site experience. This is an empty array if it is not found. -

SiteExperienceConfig

Name Type Required Description Accepted Values
navigation Navigations true The properties of the navigation for the site. -
routingGroup RoutingGroup true 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. -

Name Type Required Description Accepted Values
primaryNavigation Navigation true No description -
profileNavigation Navigation true No description -
quickNavigation Navigation false No description -

Name Type Required Description Accepted Values
name string true 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.
primary, profile, quick
navItems NavigationItem true The list of navigation items at the top level of the navigation instance. -

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. -
navItems NavigationItem false 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. -
routes [Route] true No description -

Route

Name Type Required Description Accepted Values
path string true 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. -
resources [RoutingResource] true The list of resources that are accessible on this route. -

RoutingResource

Name Type Required Description Accepted Values
id string true The unique ID of the resource that the route accesses. -
page Page false The page content for the associated resource -
nativeView NativeView false The view content for the associated resource. -
kind string true The kind of resource that is referenced. The kind applies to the individual navigation item and refers to an application, page, or external URL. -

Page

Name Type Required Description Accepted Values
id string false The ID of the page record. -
name string false A short summary for display purposes in administrator tooling and to help identify the page when searching for it. -
defaultConfig PageGridConfig true The default grid configuration. This value is applied unless a configuration is defined for a responsive breakpoint. -
responsiveConfigs [ResponsivePageGrid] false 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. -
regions [Region] true The list of regions in the page. -

PageGridConfig

Name Type Required Description Accepted Values
rows [PageGridRow] true The list of rows defined for the page’s grid -

PageGridRow

Name Type Required Description Accepted Values
height string false 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. TINY, SMALL, MEDIUM, LARGE, HUGE, DEFAULT
config [ResponsivePageGridConfig] true The list of rows defined for the page’s grid. -

ResponsivePageGridConfig

Name Type Required Description Accepted Values
rows [PageGridRow] true The list of rows defined for the page’s grid. -

Region

Name Type Required Description Accepted Values
pageletIds [string] true 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. -
pagelets [Pagelet] true The associated pagelets found in the region. -
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 Web Docs website for more information. -
defaultConfig RegionConfig true The default region configuration. This is applied unless a configuration is defined for a responsive breakpoint. -
responsiveConfigs [ResponsiveRegionConfig] false 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. FRAMED, EMBEDDED
config PageletConfig true 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. -

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. -
styles Styles false The associated styles found in the region. -

Styles

Name Type Required Description Accepted Values
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. -

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. TINY, SMALL, MEDIUM, LARGE, HUGE, DEFAULT
config RegionConfig true The default region configuration. This is applied unless a configuration is defined for a responsive breakpoint. -

NativeView

Name Type Required Description Accepted Values
id string false The ID of the native view record. -
alias string false The native workflow key of the view record. -

CustomContentTemplates

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

CustomContentTemplate

Name Type Required Description Accepted Values
name string true A human-readable name to uniquely identify a custom content template. -
description string true The description of the template. -
key string true The key that uniquely identifies a custom content template. -
inputs [CustomContentTemplateInput] true The React properties for the custom content template. -

CustomContentTemplateInput

Name Type Required Description Accepted Values
name string true The name of the React property. -
type string true The type of React property. -
isRequired boolean true Indicates whether the React property is required. -
inputs [CustomContentTemplateInput] false An array of React properties for the custom content template. -

TermsOfUses

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

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. -

TermsOfUseAcceptances

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

TermsOfUseAcceptance

Name Type Required Description Accepted Values
id string true The instance ID of the terms of use acceptance. -
termsOfUse TermsOfUseReference true A reference to the terms of use. -
consumer ConsumerReference true A reference to the HealtheIntent consumer who accepted the terms of use. -
dateAccepted string true The date and time when the terms of use was accepted by the consumer. -
domainName string true The domain for which the terms of use was accepted by the consumer. -

TermsOfUseReference

Name Type Required Description Accepted Values
id string true The ID of the terms of use that is accepted. -

ConsumerReference

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

postTermsOfUseAcceptances

Name Type Required Description Accepted Values
termsOfUse object true A reference to the terms of use. -
» id string true The ID of the terms of use that is accepted. -
consumer object true A reference to the HealtheIntent consumer who accepted the terms of use. -
» id string true The ID of the HealtheIntent consumer. -
domainName string true The domain for which the terms of use was accepted by the consumer. -

postSiteRoles

Name Type Required Description Accepted Values
name string false A user-friendly name for the role. -

Roles

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

putSiteRoles

Name Type Required Description Accepted Values
name string false A user-friendly name for the role. -

postRoleCriteria

Name Type Required Description Accepted Values
roleId string true The ID of the role attached to the role criteria. -
consumerGroupIds [string] true An array of consumer group UUIDs that can be used to build a role criteria. -

putRoleCriteria

Name Type Required Description Accepted Values
roleId string true The ID of the role attached to the role criteria. -
consumerGroupIds [string] true An array of consumer group UUIDs that can be used to build a role criteria. -

postEnrollmentPools

Name Type Required Description Accepted Values
name string false A user-friendly name for the pool. -
domain string false The domain that corresponds to the pool. -
role object false The role associated with the pool. -

Pool

Name Type Required Description Accepted Values
id string true The ID of the pool. -
name string true A user-friendly name for the pool. -
role RoleReference true The role associated with the pool. -
domain string true The domain that corresponds to the pool. -

RoleReference

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

Pools

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

putEnrollmentPools

Name Type Required Description Accepted Values
name string false A user-friendly name for the pool. -
domain string false The domain that corresponds to the pool. -

postCompletedEnrollments

Name Type Required Description Accepted Values
startDate string false The date the completed enrollment began. -
endDate string false The date the completed enrollment ended. -
principalAlias string false The unique principal alias identifier for a user. -
enrollment object false The enrollment associated with the completed enrollment. -

CompletedEnrollment

Name Type Required Description Accepted Values
id string true The ID of the completed enrollment. -
principalAlias string false The unique principal alias identifier for a user. -
startDate string(date) false The date the completed enrollment began. -
endDate string(date) false The date the completed enrollment ended. -
enrollment EnrollmentReference true The enrollment associated with the completed enrollment. -

EnrollmentReference

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

CompletedEnrollments

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

putCompletedEnrollments

Name Type Required Description Accepted Values
startDate string false The date the completed enrollment began. -
endDate string false The date the completed enrollment ended. -
principalAlias string false The unique principal alias identifier for a user. -
enrollment object false The enrollment associated with the completed enrollment. -

postEnrollments

Name Type Required Description Accepted Values
firstName string false The first name of the consumer. -
lastName string false The last name of the consumer. -
dateOfBirth string false The date of birth of the consumer. -
enrollmentId string false An ID that associates a user with a consumer enrollment. -
pool object false The pool associated with the enrollment. -

Enrollment

Name Type Required Description Accepted Values
id string true The ID of the enrollment. -
firstName string true The first name of the consumer. -
lastName string true The last name of the consumer. -
dateOfBirth string(date) true The date of birth of the consumer. -
enrollmentId string true An ID that associates a user with a consumer enrollment. -
pool PoolReference true The pool associated with the enrollment. -

PoolReference

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

Enrollments

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

putEnrollments

Name Type Required Description Accepted Values
firstName string false The first name of the consumer. -
lastName string false The last name of the consumer. -
dateOfBirth string false The date of birth of the consumer. -
enrollmentId string false An ID that associates a user with a consumer enrollment. -
pool object false The pool associated with the enrollment. -

postStaticAssets

Name Type Required Description Accepted Values
key string true The unique key of the static asset instance. -
name string true The human-readable name of the static asset instance. -

StaticAssetPost

Name Type Required Description Accepted Values
id string false The unique ID of the static asset instance. -
key string true The unique key of the static asset instance. -
name string true The human-readable name of the static asset instance. -
assetLocation string true The asset location of the static asset instance. -
signedUrl string true The signed URL of the static asset instance. -

StaticAssets

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

StaticAsset

Name Type Required Description Accepted Values
id string false The unique ID of the static asset instance. -
key string true The unique key of the static asset instance. -
name string true The human-readable name of the static asset instance. -
assetLocation string true The asset location of the static asset instance. -

putStaticAssets

Name Type Required Description Accepted Values
name string true The human-readable name of the static asset instance. -

Themes

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

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. -
properties [Theme_ThemeProperty] true The list of preferred properties for the theme instance. -
previews [Theme_ThemePreview] true The list of preview image URLs for the theme instance. -
details string true A description for the theme instance. -

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. -
titles [AppManifest_ViewTitle] true The translated names used by screen readers to describe the contents of a view. -
entryName string false The name of the entry file to be loaded for a view with a type of EMBEDDED. -

AppManifest_ViewTitle

Name Type Required Description Accepted Values
text string true The title for the contents in a particular locale. -
locale string true The locale. -

Name Type Required Description Accepted Values
id string true The unique ID of the logo. -
src string true The URL where the logo image is located. -
height integer(int32) true The height of the logo in pixels. -
width integer(int32) true The width of the logo in pixels. -
altTexts [SiteBrand_LogoAltText] true A list of localized, alternative text values. -

SiteBrand_LogoAltText

Name Type Required Description Accepted Values
text string true The translated text for the given locale. -
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 (-). -

SiteBrand_Favicon

Name Type Required Description Accepted Values
id string true The unique ID of the favicon. -
href string true The URL where the favicon is located. -
iconType string true The type of the favicon. -
sizes string true The height and width of the favicon in pixels. -

SiteBrand_Theme

Name Type Required Description Accepted Values
key string true The unique name of the theme. -
name string true A human-readable name of the theme. -
properties [SiteBrand_ThemeProperty] false The list of CSS theme properties. -

SiteBrand_ThemeProperty

Name Type Required Description Accepted Values
key string true The name of the CSS property. -
value string true The value of the CSS property. -

SiteDefinition_AffiliateSiteDefinitionConfig

Name Type Required Description Accepted Values
id string true The instance ID of the site definition. -
name string true The name of the site. -
locales [SiteDefinition_Locale] true The list of locales -
brand SiteDefinition_Brand true The properties of a brand. -
identityRealms [SiteDefinition_IdentityRealm] true The list of identity realms. -
siteTitles [LocalizedText] true The list of translated titles that are displayed for the site. -
roleCriteria [RoleCriteria] false The list of role criteria for the site. -

SiteDefinition_Locale

Name Type Required Description Accepted Values
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. -

SiteDefinition_Brand

Name Type Required Description Accepted Values
logo SiteDefinition_Logo true The logo image for the site. -
favicons [SiteDefinition_Favicon] true A list of favicons of a brand. -
themes [SiteDefinition_Theme] true A list of themes of a brand. -
topNavigationEnabled boolean true 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. -

Name Type Required Description Accepted Values
src string false The URL where the logo image is located. -
height integer(int32) true The height of the logo in pixels. -
width integer(int32) true The width of the logo in pixels. -
altTexts [LocalizedText] true A list of localized alternative text values. -

SiteDefinition_Favicon

Name Type Required Description Accepted Values
iconType string true The type of favicon. -
sizes string false The height and width of the favicon in pixels. -
href string false The URL where the favicon is located. -

SiteDefinition_Theme

Name Type Required Description Accepted Values
name string false The name of the theme. -
properties [SiteDefinition_ThemeProperty] true The list of CSS theme properties. -
breakpoint string false The window size breakpoint for which the theme is used. TINY, SMALL, MEDIUM, LARGE, HUGE, DEFAULT

SiteDefinition_ThemeProperty

Name Type Required Description Accepted Values
name string true The name of the CSS property. -
value string true The value of the CSS property. -

SiteDefinition_IdentityRealm

Name Type Required Description Accepted Values
realmId string true The ID of the identity realm record. -
isDefault boolean true Indicates whether the identity realm is the default. -
idpKeepAliveUrl string true The URL required to prevent the identity provider (IdP) session from expiring. -

Site_AlertReference

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

Site_RoleCriteriaReference

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

Site_CustomScriptReference

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

Site_ApplicationReference

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

Site_IdentityRealmReference

Name Type Required Description Accepted Values
realmId string true The ID of the identity realm record. -
isDefault boolean true Indicates whether the identity realm is the default. -
keepAliveUrl string false The URL required to prevent the identity provider (IdP) session from expiring. -

Site_Locale

Name Type Required Description Accepted Values
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. -

Site_PageReference

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

Site_Support

Name Type Required Description Accepted Values
email string false The support email associated with the site. -
phone string false The support phone number associated with the site. -

Site_BrandReference

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

Name Type Required Description Accepted Values
roles [Site_RoleReference] true 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 -

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 specific resource that is referenced. -
icon string false The resource URL for the icon. -
titles [Navigation_Title] true The translated titles that are displayed to the user for the navigation item. -
navItems [Navigation_NavigationItemReference] 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. -

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. -

Layout_LayoutGridConfig

Name Type Required Description Accepted Values
rows [Layout_LayoutGridRow] true The list of rows defined for the layout. -

Layout_LayoutGridRow

Name Type Required Description Accepted Values
height string false 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. -
config Layout_LayoutGridConfig true The configuration of each row in the layout’s grid -

Layout_LayoutRegion

Name Type Required Description Accepted Values
id string true The ID of the region record. -
defaultConfig Layout_LayoutDefaultConfig true The default region for the configuration. This value is applied unless a configuration is defined for a responsive breakpoint. -
responsiveConfigs [Layout_ResponsiveLayoutRegionConfig] 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. -
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. TINY, SMALL, MEDIUM, LARGE, HUGE, DEFAULT
config Layout_LayoutRegionConfig true 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. -
styles Layout_LayoutStyles false Associated styles found in region -

Layout_LayoutStyles

Name Type Required Description Accepted Values
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. -

CustomPage_RoleReference

Name Type Required Description Accepted Values
name string false The name of the role. -

CustomPage_LayoutReference

Name Type Required Description Accepted Values
key string false The name of the layout. This string should contain only alphabetic characters (A-Za-z) and numeric digits (0-9). -

CustomPage_ViewReference

Name Type Required Description Accepted Values
kind string true The kind of view. Only application manifest views are currently available. Custom pages may be supported as future functionality to be determined. applicationExperience#appManifest, applicationExperience#customContent
appId string true The installed application’s ID. -
viewName string true The name of the view. -
regionId string true The layout region’s ID. -

SiteDefinition_SiteDefinitionConfig

Name Type Required Description Accepted Values
id string true The instance ID of the site definition. -
site_id string true The instance ID of the site. -
name string true The name of the site. -
applications [SiteDefinition_Application_ApplicationReference] false The list of application manifests associated with the site. -
locales [SiteDefinition_Locale] true The list of locales -
brand SiteDefinition_Brand true The properties of a brand. -
identityRealms [SiteDefinition_IdentityRealm] true The list of identity realms. -
customScripts [SiteDefinition_CustomScript] true The list of custom scripts of a brand. -
siteTitles [LocalizedText] true The list of translated titles that are displayed for the site. -
loggingUris [LoggingUri] true The list of site-specific logging URIs. -
email string true The support email for the client. -
phone string true The support phone number for the client. -
mobile SiteDefinition_Mobile true The mobile app configurations for the site. -
privacyPolicy PrivacyPolicy false The privacy policy for the site. -
termsOfUse [TermsOfUse] false The list of terms of use agreements for the site. -
termsOfUseId string true The instance ID of the terms of use. -
roleCriteria [SiteDefinition_RoleCriteria] false The list of role criteria for the site. -
uniquePageletDomains [string] false A list of unique pagelet URLs that corresponds to the site. -
alerts [SiteDefinition_Alert] false The list of active alerts for the site. -

SiteDefinition_Application_ApplicationReference

Name Type Required Description Accepted Values
appManifest [SiteDefinition_Application_ApplicationManifestReference] true The application manifest. -

SiteDefinition_Application_ApplicationManifestReference

Name Type Required Description Accepted Values
name string true 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. -
supportTelecoms [SiteDefinition_Application_ApplicationManifest_SupportTelecomReference] false The list of support contacts for the site. -
views [SiteDefinition_Application_ApplicationManifest_ViewReference] true The application manifest views. -

SiteDefinition_Application_ApplicationManifest_SupportTelecomReference

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. -

SiteDefinition_Application_ApplicationManifest_ViewReference

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. 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. -
titles [SiteDefinition_Application_ApplicationManifest_TitleReference] true The translated names used by screen readers to describe the contents of a view. -
entryName string false The name of the entry file to be loaded for a view with a type of EMBEDDED. -

SiteDefinition_Application_ApplicationManifest_TitleReference

Name Type Required Description Accepted Values
text string true The title for the contents in a particular locale. -
locale string true The locale. -

SiteDefinition_CustomScript

Name Type Required Description Accepted Values
src string false The URL where the custom script is located. -
text string false The raw JavaScript code of the custom script. -
integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved custom script for a match. -
async boolean true Indicates whether the browser asynchronously retrieves the custom script while parsing the HTML. -
defer boolean true Indicates whether the browser defers the custom script execution until after the HTML parsing is complete. -

SiteDefinition_Mobile

Name Type Required Description Accepted Values
appBannerConfig SiteDefinition_AppBannerConfigs false The mobile app banner configurations for each type of mobile device. -

SiteDefinition_AppBannerConfigs

Name Type Required Description Accepted Values
ios SiteDefinition_AppBannerConfig false The configurations of Apple iOS apps. -
android SiteDefinition_AppBannerConfig false The configurations of Google Android apps. -

SiteDefinition_AppBannerConfig

Name Type Required Description Accepted Values
id string true The instance ID of the app banner configuration. -
name string true The name of the mobile app. -
deviceType string true The type of mobile device. iOS, Android
enabled boolean true Indicates whether the app banner is enabled. A value of true indicates that the app banner is enabled. A value of false indicates that it is disabled. -
storeId string false The ID for the corresponding mobile app. -
icon string false The URL of the mobile app’s icon. -
bannerTranslations [SiteDefinition_BannerTranslation] true The localized titles for the app banner. -

SiteDefinition_BannerTranslation

Name Type Required Description Accepted Values
title string true The localized title for a mobile app banner. -
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 (-). -

SiteDefinition_RoleCriteria

Name Type Required Description Accepted Values
roleId string true The ID of the role attached to the role criteria. -
roleName string true A user-friendly name for the role. -
consumerGroupIds string true An array of the consumer group universally unique identifier (UUIDs) that are used to build a role criteria. -

SiteDefinition_Alert

Name Type Required Description Accepted Values
id string true The instance ID of the alert. -
messageText [LocalizedText] true A list of localized message text values. -
expireDate string true The expiration date of the alert, in yyyy-mm-dd format with leading zeros. -

Theme_ThemeProperty

Name Type Required Description Accepted Values
key string true The unique key of the CSS property. -
name string true The display name of the CSS property. -
description string true The description for the CSS property. -
type string true The type of the CSS property. -
default string false The default value of the CSS property. -

Theme_ThemePreview

Name Type Required Description Accepted Values
url string true The image URLs of a preview. -
title string true The title to display for a preview image. -