Provides a view of the User Defined Field Definitions of the system
Since Product Version: 2.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v2/data/UserDefinedFieldDefinition UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description |
---|---|
description String |
The description of the user defined field |
name String |
The name of the user defined field. The name is case insensitive and should be unique |
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 Payload
https://localhost/webacs/api/v2/data/UserDefinedFieldDefinition/15
<?xml version="1.0" ?>
<queryResponse type="UserDefinedFieldDefinition" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/UserDefinedFieldDefinition/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="userDefinedFieldDefinitionDTO" type="UserDefinedFieldDefinition" url="https://localhost/webacs/api/v2/data/UserDefinedFieldDefinition/15">
<userDefinedFieldDefinitionDTO displayName="String value" id="15" uuid="String value">
<description>String value</description>
<name>String value</name>
</userDefinedFieldDefinitionDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/UserDefinedFieldDefinition/15.json
{
"queryResponse" : {
"@type" : "UserDefinedFieldDefinition",
"@requestUrl" : "https://localhost/webacs/api/v2/data/UserDefinedFieldDefinition/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "userDefinedFieldDefinitionDTO",
"@type" : "UserDefinedFieldDefinition",
"@url" : "https://localhost/webacs/api/v2/data/UserDefinedFieldDefinition/15",
"userDefinedFieldDefinitionDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"description" : "String value",
"name" : "String value"
}
} ]
}
}