POST /ariel/taggedfields/{tag}
Updates a tagged field with specified tag number.
Updates a tagged field with specified tag number.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
tag |
path |
Required |
String |
text/plain |
The number to be assigned to this tagged property |
format_class_name |
query |
Optional |
String |
text/plain |
Fully qualified name of formatter class |
format_params |
query |
Optional |
String |
text/plain |
Optional parameter for formatter |
description |
query |
Optional |
String |
text/plain |
Optional description of tagged property |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
Tagged field was successfully updated. |
|
404 |
1002 |
The catalog does not exist |
500 |
1020 |
Internal server error |
Response Description
Updated tagged field
Response Sample
{
"array": true,
"catalog": "String",
"created": 42,
"deleted": true,
"description": "String",
"format_class_name": "String",
"format_params": [
"String"
],
"modified": 42,
"name": "String",
"nullable": true,
"tag": 42,
"type": "String <one of: NULL, STRUCT, Byte, Short, Integer, Long, UnsignedByte, UnsignedShort, UnsignedInt, UnsignedLong, BigInteger, Double, Float, Port, Host, HostV4V6, HostV6, MACAddress, String, ByteArray, UnsignedIntHex, Boolean, Binary>"
}