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

Update a configuration

PUT
/api/v1/application/configurations/geofence

This endpoint updates an existing configuration. Similar to POST, the updated data for the configuration should be provided as JSON in the body of the PUT request. The configuration ID parameter, which was provided by the POST (create) operation, is required to do any updates on 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.

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

Request Body

application/json

Request for /api/v1/application/configurations/geofence PUT endpoint. It requires at least one of vendorId, name, description, geofence, messages and isActive fields to be populated.

Properties1 <= properties
name?string

Name of the configuration.

Match^[\w\+\-!()\`\[\]{=};\"':,.\/<>?|\s]+$
Length1 <= length <= 256
description?string

Description of the configuration.

Match^[\w\+\-!()\`\[\]{=};\"':,.\/<>?|\s]+$
Length1 <= length <= 2048
geoFence?

The GeoJSON representation of geofence. Geofence supports the following geometry types: LineString, Polygon, MultiLineString, and MultiPolygon. The system only supports a single Feature in the FeatureCollection, so only one Line, Polygon, MultiLine or MultiPolygon can be defined within one Geofencing configuration.

messageStandard?MessageStandard

Select which V2X messaging standard will be used for the message generation. The following options are supported:

  • "etsi": The message will be generated using the ETSI (European) standard (e.g. DENM).
  • "sae": The message will be generated using the SAE J2735 (North American) standard (e.g. RSA, TIM).
  • if not sent while POST, defaults to "sae"
  • mandatory to send "etsi" standard here, if ETSI messages are being sent in config

Value in

  • "etsi"
  • "sae"
messages?array<|||>

List of predefined messages that belongs to the geofence. These are the messages that are sent out by the system when the Trigger Condition for the message is met.

Items1 <= items <= 10
isActive?boolean

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/application/configurations/geofence?id=18bac1ff-c7bd-44d9-a7ad-06a093a94713" \  -H "VendorID: VerizonETX" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Delete a configuration DELETE

This endpoint deletes a specific configuration from the system. It requires the configuration ID parameter, which was provided by the POST (create) operation. Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.

Retrieve the certificate of a device or a software service in the ETX system. GET

With this API call the user can check the certificate of the device. At least one of the DeviceID, IMEI, ICCID or IMSI is required to make the call. Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.