Coverage Set API’s

As with Determining Attributes, you can perform the ‘create’, ‘update’, ‘get all’, and ‘delete’ actions. You can also perform the ‘lock’ and ‘unlock’ actions on Coverage Sets via API calls. [Locking a coverage set prevents other users from changing it while you are working on it, and the unlock action removes the lock so that it is available for another user to work with it.]

The list of Coverage Set API’s is shown in the table below.

HTTP Method	URL	Action
POST	/core/1.0/API/coverageSet	Create
PATCH	/core/1.0/API/coverageSet	Update
DELETE	/core/1.0/API/coverageSet/:id	Delete
POST	/core/1.0/API/coverageSets	Get all Coverage sets for project
POST	/core/1.0/API/coverageSet/:id	Get Coverage set details
PATCH	/core/1.0/API/coverageSet/lock/:id	Lock coverage set
PATCH	/core/1.0/API/coverageSet/unlock/:id	Unlock coverage set

The list of fields used in the API’s is shown below, along with when/where they are required.

Field	Type	Values	Description	Mandatory
entity.name	String	Any	DA name (for create request)	Yes [create]
entity.id	String	Any	DA Id	Yes [update]
entity.determiningAttributes	Array	-	DA references	Yes
entity.determiningAttributes[].name	String	Any	DA name	Yes
entity.determiningAttributes[].version	String	Any	DA version	Yes