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
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
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/data/UserDefinedFieldDefinition
Response Parameters
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://10.56.58.149/webacs/api/v1/data/UserDefinedFieldDefinition/15
<?xml version="1.0" ?>
<queryResponse type="UserDefinedFieldDefinition" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v1/data/UserDefinedFieldDefinition/15" rootUrl="https://10.56.58.149/webacs/api/v1/data">
<entity dtoType="userDefinedFieldDefinitionDTO" type="UserDefinedFieldDefinition" url="https://10.56.58.149/webacs/api/v1/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://10.56.58.149/webacs/api/v1/data/UserDefinedFieldDefinition/15.json
{
"queryResponse" : {
"@type" : "UserDefinedFieldDefinition",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data\/UserDefinedFieldDefinition\/15",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "userDefinedFieldDefinitionDTO",
"@type" : "UserDefinedFieldDefinition",
"@url" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data\/UserDefinedFieldDefinition\/15",
"userDefinedFieldDefinitionDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"description" : "String value",
"name" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/UserDefinedFieldDefinition
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
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://10.56.58.149/webacs/api/v2/data/UserDefinedFieldDefinition/15
<?xml version="1.0" ?>
<queryResponse type="UserDefinedFieldDefinition" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v2/data/UserDefinedFieldDefinition/15" rootUrl="https://10.56.58.149/webacs/api/v2/data">
<entity dtoType="userDefinedFieldDefinitionDTO" type="UserDefinedFieldDefinition" url="https://10.56.58.149/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://10.56.58.149/webacs/api/v2/data/UserDefinedFieldDefinition/15.json
{
"queryResponse" : {
"@type" : "UserDefinedFieldDefinition",
"@requestUrl" : "https://10.56.58.149/webacs/api/v2/data/UserDefinedFieldDefinition/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "userDefinedFieldDefinitionDTO",
"@type" : "UserDefinedFieldDefinition",
"@url" : "https://10.56.58.149/webacs/api/v2/data/UserDefinedFieldDefinition/15",
"userDefinedFieldDefinitionDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"description" : "String value",
"name" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/UserDefinedFieldDefinition
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
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://10.56.58.149/webacs/api/v3/data/UserDefinedFieldDefinition/15
<?xml version="1.0" ?>
<queryResponse type="UserDefinedFieldDefinition" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v3/data/UserDefinedFieldDefinition/15" rootUrl="https://10.56.58.149/webacs/api/v3/data">
<entity dtoType="userDefinedFieldDefinitionDTO" type="UserDefinedFieldDefinition" url="https://10.56.58.149/webacs/api/v3/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://10.56.58.149/webacs/api/v3/data/UserDefinedFieldDefinition/15.json
{
"queryResponse" : {
"@type" : "UserDefinedFieldDefinition",
"@requestUrl" : "https://10.56.58.149/webacs/api/v3/data/UserDefinedFieldDefinition/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "userDefinedFieldDefinitionDTO",
"@type" : "UserDefinedFieldDefinition",
"@url" : "https://10.56.58.149/webacs/api/v3/data/UserDefinedFieldDefinition/15",
"userDefinedFieldDefinitionDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"description" : "String value",
"name" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/UserDefinedFieldDefinition
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
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://10.56.58.149/webacs/api/v4/data/UserDefinedFieldDefinition/15
<?xml version="1.0" ?>
<queryResponse type="UserDefinedFieldDefinition" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v4/data/UserDefinedFieldDefinition/15" rootUrl="https://10.56.58.149/webacs/api/v4/data">
<entity dtoType="userDefinedFieldDefinitionDTO" type="UserDefinedFieldDefinition" url="https://10.56.58.149/webacs/api/v4/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://10.56.58.149/webacs/api/v4/data/UserDefinedFieldDefinition/15.json
{
"queryResponse" : {
"@type" : "UserDefinedFieldDefinition",
"@requestUrl" : "https://10.56.58.149/webacs/api/v4/data/UserDefinedFieldDefinition/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "userDefinedFieldDefinitionDTO",
"@type" : "UserDefinedFieldDefinition",
"@url" : "https://10.56.58.149/webacs/api/v4/data/UserDefinedFieldDefinition/15",
"userDefinedFieldDefinitionDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"description" : "String value",
"name" : "String value"
}
} ]
}
}