| copyright | link | is |
|---|---|---|
Copyright IBM Corp. 2017 |
get-action-context |
experimental |
If you have registered a Client action handler callback for your App, then when your App is called through this callback, it will receive an action handler context token. Your App needs to use this token with this API to extract the proper action context.
GET /v1/apps/{appId}/getActionContext/{actionHandlerContextToken}
actionHandlerContextToken has only 5 minutes lifetime, and can only be used once. It will be deleted once it is used.
| Type | Name | Description | Schema |
|---|---|---|---|
| Header | Authorization required |
Authorization header, in form of Bearer {access_token}. The access_token is issued as result of an oauth flow by Watson Work Services | String |
| Path | appId required |
Unique id of an app | String |
| Path | actionHandlerContextToken required |
token generated by caller before | String |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The action context data is returned and deleted successfully. | Action Output Entity |
| 401 | Unauthorized. | |
| 403 | Forbidden. | |
| 404 | Not Found. The app with the given appId or the action context data for the given actionToken could not be found. |
|
| 500 | Internal server error. |
application/json
The result from this call provides the following payload.
| Name | Description | Schema |
|---|---|---|
| type required |
The action type for the provided context. | string |
| appId optional |
Id of the app for this actionContext. | string |
| userId required |
Id of the user who triggered this action. | string |
| actioncontext required |
Note that this is not a name of an actual object, it is a placeholder. The actual action context structure will vary according to the action type, see below. | ActionContext |
Here are the set of currently supported actions. There will be more supported action types in future.
The space-app-config-requested action type occurs when users invoke the action to configure an app for a space.
The actionContext format for space-app-config-requested action type
| Name | Description | Schema |
|---|---|---|
| spaceId required |
Id of the space where the user invoked the app configuration | string |
| teamId required |
Id of team where the space belongs | string |
The team-app-config-requested action type occurs when users invoke the action to configure an app for a team.
The actionContext format for team-app-config-requested action type
| Name | Description | Schema |
|---|---|---|
| teamId required |
Id of the team where the user invoked the app configuration | string |