Experience View Actions

https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID

Below are the various requests that can be performed against the Experience View resource, as well as the expected parameters and the potential responses.

Delete

Deletes an experience view

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_VIEW_ID	ID associated with the experience view	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID

Successful Responses

Code	Type	Description
200	Success	If experience view was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience view was not found

Get

Retrieves information on an experience view

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_VIEW_ID	ID associated with the experience view	575ed78e7ae143cd83dc4aab

Request Query Parameters

Name	Required	Description	Default	Example
version	N	Version of this experience view to return	develop	version=develop

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID

Successful Responses

Code	Type	Description
200	Experience View	Experience view information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience view was not found

Linked Resources

Retrieves information on resources linked to an experience view

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID/linkedResources

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, experienceView.*, or experienceView.linkedResources.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_VIEW_ID	ID associated with the experience view	575ed78e7ae143cd83dc4aab

Request Query Parameters

Name	Required	Description	Default	Example
version	N	Version of this experience view to query	develop	version=develop
includeCustomNodes	N	If the result of the request should also include the details of any custom nodes referenced by returned workflows	false	includeCustomNodes=true

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID/linkedResources

Successful Responses

Code	Type	Description
200	Experience Linked Resources	Linked resource information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience view was not found

Patch

Updates information about an experience view

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceView.*, or experienceView.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
EXPERIENCE_VIEW_ID	ID associated with the experience view	575ed78e7ae143cd83dc4aab

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Experience View Patch schema. For example, the following would be a valid body for this request:

{
  "body": "New Content! <p>{{newData}}</p>",
  "viewTags": {
    "customKey": "newCustomValue"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"body":"New Content! <p>{{newData}}</p>","viewTags":{"customKey":"newCustomValue"}}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/views/EXPERIENCE_VIEW_ID

Successful Responses

Code	Type	Description
200	Experience View	Updated experience view information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if experience view was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"

Experience Linked Resources

The body of an experience linked resources response

Experience Linked Resources Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys
▶
experienceViews:{} 4 keys
▶
experienceEndpoints:{} 4 keys
▶
flows:{} 4 keys
▶
flowVersions:{} 4 keys
additionalProperties:false

Experience Linked Resources Example

▶
root:{} 4 keys
▶
experienceViews:{} 8 keys
▶
experienceEndpoints:{} 8 keys
▶
flows:{} 8 keys
▶
flowVersions:{} 9 keys

Experience View

Schema for a single Experience View

Experience View Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 17 keys
▶
id:{} 2 keys
▶
experienceViewId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
viewType:{} 2 keys
▶
layoutId:{} 2 keys
▶
layoutName:{} 3 keys
▶
body:{} 2 keys
▶
viewTags:{} 3 keys
▶
headers:{} 3 keys

Experience View Example

▶
root:{} 10 keys
id:"59cc5c628246c6caed4b16c1"
experienceViewId:"59cc5c628246c6caed4b16c1"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Page View"
viewType:"page"
body:"<p>{{data}}</p>"
layoutId:"59cc5cad8246c6caed4b16c2"
▶
viewTags:{} 1 key

Experience View Patch

Schema for the body of an Experience View modification request

Experience View Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 6 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
layoutId:{} 2 keys
▶
body:{} 2 keys
▶
viewTags:{} 3 keys
▶
headers:{} 3 keys
additionalProperties:false

Experience View Patch Example

▶
root:{} 2 keys
body:"New Content! <p>{{newData}}</p>"
▶
viewTags:{} 1 key

Success

Schema for reporting a successful operation

Success Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
root:{} 1 key
success:true