An operation to create or update User Defined Field definitions.
Resource URL
/webacs/api/v1/op/udfService/importUserTagDefinition
Since : 2.2
Request Payload Parameters
UDFDefinition[]
|
definitions
|
A list of User Defined Field Definitions
|
String
|
description
|
A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
|
String
|
name
|
A name of the User Defined Definition. The maximun lenght of the name is 128 characters. Extral characters will be trimmed. The name should be unique. The allowed characters are A-Z,a-z,0-9,_ and -
|
|
Response Parameters
String
|
operation
|
The name of the operation.
|
UDFResult[]
|
results
|
|
String
|
message
|
The system generated message
|
String
|
name
|
The name of the User Defined Field
|
String
|
status
|
The status of the operation on this User Defined Field
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/udfService/importUserTagDefinition
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitionImport>
<definitions>
<definition>
<description>String value</description>
<name>String value</name>
</definition>
</definitions>
</definitionImport>
Sample JSON Request Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/udfService/importUserTagDefinition.json
{
"definitionImport" : {
"definitions" : {
"definition" : {
"description" : "String value",
"name" : "String value"
}
}
}
}
Sample XML Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/udfService/importUserTagDefinition
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/udfService/importUserTagDefinition" responseType="operation">
<udfOperationResult>
<operation>String value</operation>
<results>
<result>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</result>
</results>
</udfOperationResult>
</mgmtResponse>
Sample JSON Response Payload
https://szier-m8-106.cisco.com/webacs/api/v1/op/udfService/importUserTagDefinition.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
"@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/udfService\/importUserTagDefinition",
"@responseType" : "operation",
"udfOperationResult" : {
"operation" : "String value",
"results" : {
"result" : {
"message" : "String value",
"name" : "String value",
"status" : "String value"
}
}
}
}
}