Verizon 5G Edge API Portal
Verizon 5G EdgeThingSpace
HomeSDKsContext PluginAPI Reference
E T X App Configuration

Get a configuration by its identifier

GET
/api/v1/application/configurations/geofence

This endpoint fetches and returns a specific configuration's details. The configuration ID parameter, which was provided when the configuration was created through the POST request, is need to retrieve the configuration details.

Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.

Authorization

thingspace_oauth sessionToken
AuthorizationBearer <token>

This is the ThingSpace token, from Credentials and Tokens is used

In: header

SessionToken<token>

This is the Session/M2M token needed to authenticate the user. It should be acquired by using the ThingSpace APIs. For detail on how to obtain a Session/M2M token please refer to the

In: header

Query Parameters

id*string

The configuration identifier

Match^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?4[0-9a-fA-F]{3}-?[89abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$
Length32 <= length <= 36

Header Parameters

VendorID*string

The vendor's identifier

Match^[a-zA-Z0-9]+$
Length1 <= length <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/application/configurations/geofence?id=18bac1ff-c7bd-44d9-a7ad-06a093a94713" \  -H "VendorID: VerizonETX"
{  "id": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b",  "vendorId": "VerizonETX",  "name": "string",  "description": "string",  "geoFence": {    "type": "FeatureCollection",    "features": [      {        "type": "Feature",        "geometry": {          "type": "LineString",          "coordinates": [            [              -180            ],            [              -180            ]          ]        },        "properties": {}      }    ]  },  "messageStandard": "etsi",  "messages": [    {      "isPrivate": true,      "roadUserType": [        "VulnerableRoadUser"      ],      "triggerConditions": [        "enter"      ],      "limits": [        {          "speed": null        }      ],      "distributionType": [        "Targeted"      ],      "distributionSchedule": {        "repeatPeriod": 5,        "duration": 1,        "startTime": "2042-07-21T17:32:28Z"      },      "generic": {        "messageType": "string",        "messageFormat": "string",        "payload": "string"      }    }  ],  "isActive": true}

Get all configurations by VendorID GET

This endpoint fetches and returns the list of configurations defined by the Vendor. The list contains the configurations' identifier, name, description, and active flag. The vendor ID is provided when the configuration is created through the POST request. Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.

Create a configuration POST

This endpoint creates a new configuration in the system. The data for the new configuration should be provided as JSON in the body of the POST request. The system will return with a unique ID for the configuration, which is needed for any further manipulation (update or delete) of the configuration. Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.