Skip to main content

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 ComponentDescriptionExample
APPLICATION_IDID associated with the application575ec8687ae143cd83dc4a97

Request Query Parameters

NameRequiredDescriptionDefaultExample
sortFieldNField to sort the results by. Accepted values are: version, id, creationDate, lastUpdatedversionsortField=version
sortDirectionNDirection to sort the results by. Accepted values are: asc, descascsortDirection=asc
pageNWhich page of results to return0page=0
perPageNHow many items to return per page100perPage=10
filterFieldNField to filter the results by. Blank or not provided means no filtering. Accepted values are: versionfilterField=email
filterNFilter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.filter=my*version

Request Headers

NameRequiredDescriptionDefault
AuthorizationYThe 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

CodeTypeDescription
200Experience VersionsCollection of experience versions

Error Responses

CodeTypeDescription
400ErrorError if malformed request
404ErrorError 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 ComponentDescriptionExample
APPLICATION_IDID associated with the application575ec8687ae143cd83dc4a97

Request Headers

NameRequiredDescriptionDefault
AuthorizationYThe 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

CodeTypeDescription
201Experience VersionSuccessfully created experience version

Error Responses

CodeTypeDescription
400ErrorError if malformed request
404ErrorError if application was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

  • {} 3 keys
    • "http://json-schema.org/draft-07/schema#"
    • "object"
    • {} 2 keys
      • {} 1 key
        • {} 1 key

      Error Example

      • {} 2 keys
        • "NotFound"
        • "Application was not found"

      Experience Version

      Schema for a single Experience Version

      Experience Version Schema

      • {} 3 keys
        • "http://json-schema.org/draft-07/schema#"
        • "object"
        • {} 18 keys
          • {} 2 keys
            • {} 2 keys
              • {} 2 keys
                • {} 2 keys
                  • {} 2 keys
                    • {} 2 keys
                      • {} 2 keys
                        • {} 2 keys
                          • {} 2 keys
                            • {} 1 key
                              • {} 3 keys
                                • {} 3 keys
                                  • {} 2 keys
                                    • {} 3 keys
                                      • {} 1 key
                                        • {} 1 key
                                          • {} 2 keys
                                            • {} 2 keys

                                          Experience Version Example

                                          • {} 9 keys
                                            • "5b995ec6ea9994b50d745285"
                                            • "5b995ec6ea9994b50d745285"
                                            • "575ec8687ae143cd83dc4a97"
                                            • "2016-06-13T04:00:00.000Z"
                                            • "2016-06-13T04:00:00.000Z"
                                            • "myVersionName"
                                            • true
                                            • [] 1 item
                                              • [] 1 item

                                              Experience Version Post

                                              Schema for the body of an Experience Version creation request

                                              Experience Version Post Schema

                                              • {} 5 keys
                                                • "http://json-schema.org/draft-07/schema#"
                                                • "object"
                                                • {} 9 keys
                                                  • {} 3 keys
                                                    • {} 2 keys
                                                      • {} 3 keys
                                                        • {} 3 keys
                                                          • {} 1 key
                                                            • {} 3 keys
                                                              • {} 1 key
                                                                • {} 1 key
                                                                  • {} 3 keys
                                                                  • false
                                                                  • [] 1 item

                                                                  Experience Version Post Example

                                                                  • {} 4 keys
                                                                    • "myNewVersion"
                                                                    • "my version description"
                                                                    • [] 1 item
                                                                      • [] 1 item

                                                                      Experience Versions

                                                                      Schema for a collection of Experience Versions

                                                                      Experience Versions Schema

                                                                      • {} 3 keys
                                                                        • "http://json-schema.org/draft-07/schema#"
                                                                        • "object"
                                                                        • {} 4 keys
                                                                          • {} 2 keys
                                                                            • {} 1 key
                                                                              • {} 1 key
                                                                                • {} 2 keys

                                                                              Experience Versions Example

                                                                              • {} 4 keys
                                                                                • [] 1 item
                                                                                  • 1
                                                                                  • 1
                                                                                  • "575ec8687ae143cd83dc4a97"

                                                                                Was this page helpful?


                                                                                Still looking for help? You can also search the Losant Forums or submit your question there.