Skip to content

tools.ozone.set.deleteSet

Lexicon Version: 1

Type: procedure

Delete an entire set. Attempting to delete a set that does not exist will result in an error.

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
namestringName of the set to delete
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

(No properties defined) Possible Errors:

  • SetNotFound: set with the given name does not exist

{
"lexicon": 1,
"id": "tools.ozone.set.deleteSet",
"defs": {
"main": {
"type": "procedure",
"description": "Delete an entire set. Attempting to delete a set that does not exist will result in an error.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the set to delete"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {}
}
},
"errors": [
{
"name": "SetNotFound",
"description": "set with the given name does not exist"
}
]
}
}
}