Experience Versions Actions

https://api.losant.com/applications/APPLICATION_ID/experience/versions

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

Get

Returns the experience versions for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/experience/versions

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, experienceVersions.*, or experienceVersions.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated	version	sortField=version
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version		filterField=email
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*version

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/versions

Successful Responses

Code	Type	Description
200	Experience Versions	Collection of experience versions

Error Responses

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

Post

Create a new experience version for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/experience/versions

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, experienceVersions.*, or experienceVersions.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97

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 Version Post schema. For example, the following would be a valid body for this request:

{
  "version": "myNewVersion",
  "description": "my version description",
  "domainIds": [
    "58c1de6c8f812590d8e82980"
  ],
  "slugIds": [
    "5b995e51ea9994b50d745284"
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"version":"myNewVersion","description":"my version description","domainIds":["58c1de6c8f812590d8e82980"],"slugIds":["5b995e51ea9994b50d745284"]}' \
    https://api.losant.com/applications/APPLICATION_ID/experience/versions

Successful Responses

Code	Type	Description
201	Experience Version	Successfully created experience version

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application 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 Version

Schema for a single Experience Version

Experience Version Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 18 keys
▶
id:{} 2 keys
▶
experienceVersionId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
endpointDefaultCors:{} 1 key
▶
allowedCorsOrigins:{} 3 keys
▶
version:{} 3 keys
▶
description:{} 2 keys
▶
globals:{} 3 keys
▶
notFoundReply:{} 1 key
▶
unauthorizedReply:{} 1 key
▶
attachedDomains:{} 2 keys
▶
attachedSlugs:{} 2 keys

Experience Version Example

▶
root:{} 9 keys
id:"5b995ec6ea9994b50d745285"
experienceVersionId:"5b995ec6ea9994b50d745285"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
version:"myVersionName"
endpointDefaultCors:true
▶
attachedDomains:[] 1 item
▶
attachedSlugs:[] 1 item

Experience Version Post

Schema for the body of an Experience Version creation request

Experience Version Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
version:{} 3 keys
▶
description:{} 2 keys
▶
domainIds:{} 3 keys
▶
slugIds:{} 3 keys
▶
endpointDefaultCors:{} 1 key
▶
globals:{} 3 keys
▶
notFoundReply:{} 1 key
▶
unauthorizedReply:{} 1 key
▶
allowedCorsOrigins:{} 3 keys
additionalProperties:false
▶
required:[] 1 item

Experience Version Post Example

▶
root:{} 4 keys
version:"myNewVersion"
description:"my version description"
▶
domainIds:[] 1 item
▶
slugIds:[] 1 item

Experience Versions

Schema for a collection of Experience Versions

Experience Versions Schema

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

Experience Versions Example

▶
root:{} 4 keys
▶
items:[] 1 item
count:1
totalCount:1
applicationId:"575ec8687ae143cd83dc4a97"