The "deleteTags" action permanently deletes one or more tags by ID or by name. The "delete" action permanently removes a record. It cannot be undone.
It removes all links to other items, including links to fields, labels, inputs, outputs, tags, etc.
Instead of permanently deleting a tag, you can run the "alterTag" action and set a tag's "status" property to "inactive". An inactive tag retains all its properties and links to other items. It is easy to restore an inactive tag by running the "alterTag" action and setting its status to "active".
The "ids" property specifies 0 or more ids. Each identifier in the array uniquely specifies a table row, indicating which records the action affects. It is required if the "primaryKeys" property is "null" or not specified.
The "ids" property is mutually exclusive with the "primaryKeys" property meaning it is required when "primaryKeys" is omitted or an error is returned if both have values.
It is typically an array of integers ("ids": [1,3,5]).
It can be an array of an array of strings ("ids": ["9555444333222111","9555444333222112", "9555444333222113"]).
A string "id" supports numbers larger than 9,007,199,254,740,991.
This is the largest number supported by many programming languages and JSON parser implementations that use IEEE double-precision floats to hold numbers.
It can be the primary key value of another field in the table making it useful when your table is created by another API, such as SQL, that allows any field in the table to be the primary key.
If your table does not have an "id" field but uses a "vin" field as the primary key, you can use vin values to look up records ("ids": [ "4Y1SL65848Z411439", "1HGBH41JXMN109186" ]).
If your table uses more than one field as the primary key, you must use the "primaryKeys" property to look up records.
Tip The "getRecordsByIds" action uses a primary key index to look up records. A primary key index must be a unique, non-null index without conditional filtering. For best performance and maximum simplicity, create tables using the JSON DB API because it automatically creates an auto increment "id" field that is indexed as a primary key.
Optional with default of "null".
Required when "primaryKeys" is omitted
array
0 or more ids
tagNames
The "tagNames" property specifies one or more tag names. You can use it to describe or delete tags.
Each item in the array is the exact name of a tag.
Required - No default value
string
1 to 256 bytes
Response properties ("result")
Property
Description
Type
Limits (inclusive)
deletedTags
The "deletedTags" property describes the tags that were deleted.
array of objects
zero or more objects containing the following properties:
"id"
"tagName"
deletedTags
.id
The "id" property is the unique identifier of an object such as a label or thing. In JSON, you may use an integer number or a string containing an integer number. The server automatically generates the "id" when you create a label and stores it in the label table as an integer. You cannot alter the "id" value. If your application needs to specify a specific numeric identifier for a label, use the "enum" property.
integer
0 to 2147483647
0 to 9223372036854770000 in the Thing API
deletedTags
.tagName
The "tagName" property is a string that specifies the unique name of a tag. See also "tagId".
In "createInput" and "createOutput", you can use the "tagId" or "tagName" properties to associate the connector with a tag.
In "alterInput" and "alterOutput", you can use the "tagId" or "tagName" properties to change the connector's association with a tag.
When assigning a tag to a connector, you can use either the "tagId" or "tagName" property but not both.
If a tag is associated with a connector, the response to the input and output actions include both the "tagId" or "tagName" properties; otherwise, these properties are omitted in the response.
Important The "propertyPath" property is deprecated for the "createInput", "createOutput", "alterInput", and "alterOutput" actions. Instead, use the "tagName" or "tagId" properties.
