Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Shape Library

The Shape Library API is used
to manage shape library in GIS settings within an organization.

POST /shapeLibrary/{organizationId}

Upload a single shape file to the Shape Library.

POST

Parameter	Mandatory	Type	Description
organizationId	y	long	The ID of the organization containing these critical events.
Authorization	y	string	Basic authorization header.
folder	n	string	The folder name of the shape file saved. If null, it will save under the root directory; if the folder does not exist, a new folder is created.
regionName	y	string	The region name of the shape file saved under the folder. The region name cannot be the same as the existing one.
file	y	body	The MultipartFile-shape file body. Some limitations: 1 File format: Support zipped SHP file (.zip) and KML file (.kml). 2 File size: The maximum size of a .zip file is 1MB and .kml file is 3MB.

HTTP Status Code	Response Body
200OK	The ID of the newly-created region shape library.
400	Missing or invalid request input.
401	Missing or invalid credentials.
500	Internal Error

Delete region or regions under the folder.

DELETE

Parameter	Mandatory	Type	Description
organizationId	y	long	The ID of the organization containing these critical events.
Authorization	y	string	Basic authorization header.
regionName	y	string	The region name you want to delete.

HTTP Status Code	Response Body
200OK	{ "message": "OK", "id": 281754149584908, "baseUri": "https://://api.everbridge.net/rest/shapeLibrary/241901148045319/", "instanceUri": "https://://api.everbridge.net/rest/shapeLibrary/241901148045319/281754149584908" }
400	Missing or invalid request input.
401	Missing or invalid credentials.
404	If name cannot be found in the shape library, return this: { "status": 404, "message": "Region name: test is not found" }
500	Internal Error