Update Application to Application Linking Information

PUT /app/:appID/links/apps



Enables the update of application to application linking information. This will set which links are available. Specifically, the valid and known applications specified in the payload will be the current links and returned in the response payload.

Resource URL

https://api.ideasystem.org/v1/app/appID/links/apps

Data Parameters (JSON Body)

The JSON body will hold a list of application IDs. It is suggested that they be valid and known applications. All others will be ignored.

Response

The response will be an HTTP 200 with a JSON body. The body will be the list of linked applications after this update takes effect.

If the given application ID cannot be found, an HTTP 404 (Not Found) will be returned. If there is an issue with the backend, a HTTP 500 (Internal Server Error) is returned. If the application name/key you are using doesn't have access to this REST end-point, you will get a 403 (Forbidden) error.

Response Parameters (JSON Body)

The response body will hold the list of linked applications (IDs of the applications).

Example

This request will update the list of linked applications to be 1235 and 1236 for the application with ID 1234.

Request

PUT /v1/app/1234/links/apps

PUT Data (as JSON)

[
    1235, 1236
]

Response (as JSON)

HTTP 200
[
    1235, 1236
]