Skip to content
OpenBot

appViews.operation

GET
/v1/app-views/{viewId}/actions/{requestId}
curl --request GET \
  --url https://example.com/v1/app-views/example/actions/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
viewId
required
string
requestId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
ticket
required
object
session
required
string
turn
required
string
item
required
string
callId
required
string
revision
required
integer
<= 9007199254740991
version
required
string
status
required
string
Allowed values: Queued PendingApproval Approved Rejected Sending InputRequired Completed Failed OutcomeUnknown
operation
required
Any of:
object
id
required
string
session
required
string
turn
required
string
callId
required
string
toolName
required
string
source
required
object
connectionId
required
string
connectionName
required
string
cardUrl
required
string
appName
required
string
remoteIndex
required
integer
<= 9007199254740991
revision
required
integer
<= 9007199254740991
kind
required
string
Allowed values: tool resource template prompt
name
required
string
definition
arguments
required
object
readOnly
required
boolean
round
required
integer
<= 9007199254740991
status
required
string
Allowed values: PendingApproval Approved Rejected Sending InputRequired Completed Failed OutcomeUnknown
result
required
Any of:
Any of:
object
_tag
required
string
Allowed values: Completed
source
required
object
connectionId
required
string
connectionName
required
string
cardUrl
required
string
appName
required
string
remoteIndex
required
integer
<= 9007199254740991
revision
required
integer
<= 9007199254740991
kind
required
string
Allowed values: tool resource template prompt
name
required
string
definition
result
required
operationId
string

Example 

{
  "status": "Queued",
  "operation": {
    "source": {
      "kind": "tool"
    },
    "status": "PendingApproval",
    "result": {
      "_tag": "Completed",
      "source": {
        "kind": "tool"
      }
    }
  }
}

400

Section titled “400”

ExperienceInputInvalid | OrganizationRequired

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

Example 

{
  "_tag": "ExperienceInputInvalid"
}

401

Section titled “401”

AuthenticationRequired

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

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

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"
}

404

Section titled “404”

ExperienceNotFound

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

Example 

{
  "_tag": "ExperienceNotFound"
}

409

Section titled “409”

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"
}

503

Section titled “503”

ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

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

Example 

{
  "_tag": "ExperienceStorageUnavailable"
}