copyright | link | is |
---|---|---|
Copyright IBM Corp. 2017 |
access-configuration-data |
beta |
The configuration data is generated via Watson Work Services by Watson Workspace clients when a user triggers the configuration of your app. It contains the needed data for the configuration of the app. It can be accessed with a configuration token which had been generated before and is exposed via an url parameter for the App Configuration Callback. Only when the app is authorized as an App it can access the configuration data. The configuration data is not directly sent to the App Configuration Callback in order to allow the direct verification of the call to the App Configuration Callback.
The configuration data is deleted and can not be accessed again after a successful call.
The configuration data will expire after 5 minutes. Afterwards it can be no longer accessed via the configuration token - i.e. the response will be 404 - Not Found.
- Version: 1.0.0
Host : api.watsonwork.ibm.com Scheme: HTTPS
GET v1/apps/<appId>/configurationData/<configurationToken>
HTTP Code | Description | Schema |
---|---|---|
200 | The configuration data is returned and deleted successfully. | ConfigurationData(see below) |
401 | Unauthorized. | |
403 | Forbidden. | |
404 | Not Found. The app with the given appId or the configuration data for the given configurationToken could not be found. |
|
500 | Internal server error. |
application/json
Entity that represents the configuration data for the configuration of an app for a specific space and by a specific user
Name | Description | Schema |
---|---|---|
appId required |
Id of the app for which the configuration data has been generated. | string |
spaceId required |
Id of the space for which the configuration data has been generated. | string |
userId required |
Id of the user by which the configuration data has been generated. | string |