Skip to content

tools.ozone.set.deleteValues

Lexicon Version: 1

Type: procedure

Delete values from a specific set. Attempting to delete values that are not in the set will not result in an error

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
namestringName of the set to delete values from
valuesArray of stringArray of string values to delete from the setMin Items: 1
Possible Errors:
  • SetNotFound: set with the given name does not exist

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