An operation to create or update User Defined Field definitions.
Since Product Version: 2.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/udfService/importUserTagDefinition
Request Payload Parameters
definitions
UDFDefinition[]
|
A list of User Defined Field Definitions
|
description
String
|
A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
|
name
String
|
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
operation
String
|
The name of the operation.
|
results
UDFResult[]
|
List of operation results.
|
message
String
|
The system generated message
|
name
String
|
The name of the User Defined Field
|
status
String
|
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://localhost/webacs/api/v1/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<definitionImport>
<definitions>
<definition>
<description>String value</description>
<name>String value</name>
</definition>
</definitions>
</definitionImport>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/udfService/importUserTagDefinition.json
{
"definitionImport" : {
"definitions" : {
"definition" : {
"description" : "String value",
"name" : "String value"
}
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/udfService/importUserTagDefinition" rootUrl="https://localhost/webacs/api/v1/op">
<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://localhost/webacs/api/v1/op/udfService/importUserTagDefinition.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/udfService\/importUserTagDefinition",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"udfOperationResult" : {
"operation" : "String value",
"results" : {
"result" : {
"message" : "String value",
"name" : "String value",
"status" : "String value"
}
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/udfService/importUserTagDefinition
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
definitions
UDFDefinition[]
|
A list of User Defined Field Definitions
|
description
String
|
A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
|
name
String
|
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
operation
String
|
The name of the operation.
|
results
UDFResult[]
|
List of operation results.
|
message
String
|
The system generated message
|
name
String
|
The name of the User Defined Field
|
status
String
|
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://localhost/webacs/api/v2/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<definitionImport>
<definitions>
<definition>
<description>String value</description>
<name>String value</name>
</definition>
</definitions>
</definitionImport>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/udfService/importUserTagDefinition.json
{
"definitionImport" : {
"definitions" : {
"definition" : [ {
"description" : "String value",
"name" : "String value"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/udfService/importUserTagDefinition" rootUrl="https://localhost/webacs/api/v2/op">
<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://localhost/webacs/api/v2/op/udfService/importUserTagDefinition.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/udfService/importUserTagDefinition",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"udfOperationResult" : [ {
"operation" : "String value",
"results" : {
"result" : [ {
"message" : "String value",
"name" : "String value",
"status" : "String value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/udfService/importUserTagDefinition
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
definitions
UDFDefinition[]
|
A list of User Defined Field Definitions
|
description
String
|
A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
|
name
String
|
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
operation
String
|
The name of the operation.
|
results
UDFResult[]
|
List of operation results.
|
message
String
|
The system generated message
|
name
String
|
The name of the User Defined Field
|
status
String
|
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://localhost/webacs/api/v3/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<definitionImport>
<definitions>
<definition>
<description>String value</description>
<name>String value</name>
</definition>
<definition>
<description>Another string value</description>
<name>Another string value</name>
</definition>
</definitions>
</definitionImport>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/udfService/importUserTagDefinition.json
{
"definitionImport" : {
"definitions" : {
"definition" : [ {
"description" : "String value",
"name" : "String value"
}, {
"description" : "Another string value",
"name" : "Another string value"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/udfService/importUserTagDefinition" 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>Another string value</message>
<name>Another string value</name>
<status>Another string value</status>
</result>
</results>
</udfOperationResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/udfService/importUserTagDefinition.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/udfService/importUserTagDefinition",
"@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" : "Another string value",
"name" : "Another string value",
"status" : "Another string value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/udfService/importUserTagDefinition
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
definitions
UDFDefinition[]
|
A list of User Defined Field Definitions
|
description
String
|
A description of the User Defined Field. The maxium lenght of the description is 255 characters. Extral characters will be trimmed
|
name
String
|
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
operation
String
|
The name of the operation.
|
results
UDFResult[]
|
List of operation results.
|
message
String
|
The system generated message
|
name
String
|
The name of the User Defined Field
|
status
String
|
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://localhost/webacs/api/v4/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<definitionImport>
<definitions>
<definition>
<description>String value</description>
<name>String value</name>
</definition>
<definition>
<description>Another string value</description>
<name>Another string value</name>
</definition>
</definitions>
</definitionImport>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/udfService/importUserTagDefinition.json
{
"definitionImport" : {
"definitions" : {
"definition" : [ {
"description" : "String value",
"name" : "String value"
}, {
"description" : "Another string value",
"name" : "Another string value"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/udfService/importUserTagDefinition
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/udfService/importUserTagDefinition" rootUrl="https://localhost/webacs/api/v4/op">
<udfOperationResult>
<operation>String value</operation>
<results>
<result>
<message>String value</message>
<name>String value</name>
<status>String value</status>
</result>
<result>
<message>Another string value</message>
<name>Another string value</name>
<status>Another string value</status>
</result>
</results>
</udfOperationResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/udfService/importUserTagDefinition.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/udfService/importUserTagDefinition",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"udfOperationResult" : [ {
"operation" : "String value",
"results" : {
"result" : [ {
"message" : "String value",
"name" : "String value",
"status" : "String value"
}, {
"message" : "Another string value",
"name" : "Another string value",
"status" : "Another string value"
} ]
}
} ]
}
}