Skip to content

appViews.read

POST
/v1/app-views/{viewId}/read
curl --request POST \
--url https://example.com/v1/app-views/example/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "method": "tools/list", "params": {} }'
viewId
required
string
Media typeapplication/json
object
method
required
string
Allowed values: tools/list resources/list resources/templates/list
params
required
object

Success

Media typeapplication/json
object

Example generated

{}

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExperienceInputInvalid
message
required
string

Example

{
"_tag": "ExperienceInputInvalid"
}

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example

{
"_tag": "AuthenticationRequired"
}

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppRestricted
restriction
required
object
cardUrl
required
string
reason
required
string
>= 1 characters
appealUrl
required
string

Example

{
"_tag": "AppRestricted"
}

ExperienceNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: ExperienceNotFound
id
required
string

Example

{
"_tag": "ExperienceNotFound"
}

AppViewUnavailable | SessionConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppViewUnavailable
reason
required
string
Allowed values: Declaration Resource ConnectionChanged Closed Unsupported Protocol
message
required
string

Example

{
"_tag": "AppViewUnavailable",
"reason": "Declaration"
}

ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExperienceStorageUnavailable

Example

{
"_tag": "ExperienceStorageUnavailable"
}