Skip To Content

Connection Info

  • URL:https://<services>/<mission_service_id>/connectionInfo
  • Version Introduced:11.0

Description

The connection information required to make WebSocket connections to Mission Server. Making a WebSocket connection to Mission Server allows users to send mission related data.

Request parameters

ParameterDetails
appId

Optional. The Application Identifier is an optional string parameter that allows for identification of the connecting client.This value should be the registered appId on the host portal. If a value is not supplied, the default value arcgisMissionClient is used.

Note:
The appId parameter only supports alphanumeric characters.

f

The response format. The default response format is html.

Values: html | json | pjson

Response Properties

PropertyDetails
missionId

The unique mission ID.

urls

The urls used to make WebSocket connections to Mission Server. The keys associated with these urls are messages and events.

token

The access token used to make WebSocket connections to Mission Server.

Example usage

Below is a sample request URL for the connectionInfo resource:

https://machine.domain.com/webadaptor/rest/services/<mission_id>/connectionInfo?appId=customApplicationID&f=pjson

JSON Response example


{
    "url": "wss://machine.domain.com/webadaptor/ws/services/9bdab85df6ce46c4b7af435f68c5c1e8/MessageServer",
    "missionId": "9bdab85df6ce46c4b7af435f68c5c1e8",
    "token": "<token>"
}