Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 3.72 KB

experienceViews.md

File metadata and controls

95 lines (68 loc) · 3.72 KB

Experience Views Actions

Details on the various actions that can be performed on the Experience Views resource, including the expected parameters and the potential responses.

Contents

Get

Returns the experience views for an application

result = client.experience_views.get(applicationId=my_application_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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, experienceViews.*, or experienceViews.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: id, creationDate, name, lastUpdated name name
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*view
viewType string N Filter views to those only of the given type. Accepted values are: page, layout, component page
version string N Return the experience views belonging to this version develop develop
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Views Collection of experience views

Error Responses

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

Post

Create a new experience view for an application

result = client.experience_views.post(
    applicationId=my_application_id,
    experienceView=my_experience_view)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, experienceViews.*, or experienceViews.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceView Experience View Post Y New experience view information Experience View Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Experience View Successfully created experience view

Error Responses

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