An operation to delete User Defined Field definitions
Since Product Version: 2.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
DevNet Discussions
Resource URL
/webacs/api/v3/op/udfService/deleteUserTagDefinition UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description |
---|---|
names String[] |
Names of the User Defined Fields to delete. |
Response Parameters
Attribute | Description |
---|---|
operation String |
The name of the operation. |
List of operation results. |
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://localhost/webacs/api/v3/op/udfService/deleteUserTagDefinition
<?xml version="1.0" ?>
<definitionDeleteCandidates>
<names>
<name>String value</name>
<name>Another string value</name>
</names>
</definitionDeleteCandidates>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/udfService/deleteUserTagDefinition.json
{
"definitionDeleteCandidates" : {
"names" : {
"name" : [ "String value", "Another string value" ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/udfService/deleteUserTagDefinition
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/udfService/deleteUserTagDefinition" rootUrl="https://localhost/webacs/api/v3/op">
<udfOperationResult>
<operation>String value</operation>
<results>
<result>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</result>
<result>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</result>
</results>
</udfOperationResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/udfService/deleteUserTagDefinition.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/udfService/deleteUserTagDefinition",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"udfOperationResult" : [ {
"operation" : "String value",
"results" : {
"result" : [ {
"message" : "String value",
"name" : "String value",
"status" : "String value"
}, {
"message" : "String value",
"name" : "String value",
"status" : "String value"
} ]
}
} ]
}
}