GET {version}/GetUserDefinedFields
Get User Defined Fields
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of User Defined Fields
Collection of UserDefinedFieldName | Description | Type | Additional information |
---|---|---|---|
GUID | globally unique identifier |
None. |
|
Text | string |
None. |
|
id | string |
None. |
|
itemName | string |
None. |
|
FieldId | globally unique identifier |
None. |
|
SelectedValue | string |
None. |
|
GroupId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "GUID": "d5c37b39-eb1c-4d88-8fa5-cf3ed7669032", "Text": "sample string 2", "id": "d5c37b39-eb1c-4d88-8fa5-cf3ed7669032", "itemName": "sample string 2", "FieldId": "bd0609bf-e2be-44e6-a154-01ff1f6a38b4", "SelectedValue": "sample string 4", "GroupId": "ce09600e-099e-416e-b15c-cabd1cc39a1b" }, { "GUID": "d5c37b39-eb1c-4d88-8fa5-cf3ed7669032", "Text": "sample string 2", "id": "d5c37b39-eb1c-4d88-8fa5-cf3ed7669032", "itemName": "sample string 2", "FieldId": "bd0609bf-e2be-44e6-a154-01ff1f6a38b4", "SelectedValue": "sample string 4", "GroupId": "ce09600e-099e-416e-b15c-cabd1cc39a1b" } ]
application/xml, text/xml
Sample:
<ArrayOfUserDefinedField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model"> <UserDefinedField> <FieldId>bd0609bf-e2be-44e6-a154-01ff1f6a38b4</FieldId> <GUID>d5c37b39-eb1c-4d88-8fa5-cf3ed7669032</GUID> <GroupId>ce09600e-099e-416e-b15c-cabd1cc39a1b</GroupId> <SelectedValue>sample string 4</SelectedValue> <Text>sample string 2</Text> </UserDefinedField> <UserDefinedField> <FieldId>bd0609bf-e2be-44e6-a154-01ff1f6a38b4</FieldId> <GUID>d5c37b39-eb1c-4d88-8fa5-cf3ed7669032</GUID> <GroupId>ce09600e-099e-416e-b15c-cabd1cc39a1b</GroupId> <SelectedValue>sample string 4</SelectedValue> <Text>sample string 2</Text> </UserDefinedField> </ArrayOfUserDefinedField>