GET {version}/GetUserDefinedFields

Get User Defined Fields

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

None.

Response Information

Resource Description

List of User Defined Fields

Collection of UserDefinedField
NameDescriptionTypeAdditional 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": "2e25ab81-f2a5-4b02-8753-7871c398de44",
    "Text": "sample string 2",
    "id": "2e25ab81-f2a5-4b02-8753-7871c398de44",
    "itemName": "sample string 2",
    "FieldId": "31814df2-c155-4376-9d3a-b93d9d54a1fe",
    "SelectedValue": "sample string 4",
    "GroupId": "d2d7ca7a-bec1-45a5-8d40-8fb24cc709ef"
  },
  {
    "GUID": "2e25ab81-f2a5-4b02-8753-7871c398de44",
    "Text": "sample string 2",
    "id": "2e25ab81-f2a5-4b02-8753-7871c398de44",
    "itemName": "sample string 2",
    "FieldId": "31814df2-c155-4376-9d3a-b93d9d54a1fe",
    "SelectedValue": "sample string 4",
    "GroupId": "d2d7ca7a-bec1-45a5-8d40-8fb24cc709ef"
  }
]

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>31814df2-c155-4376-9d3a-b93d9d54a1fe</FieldId>
    <GUID>2e25ab81-f2a5-4b02-8753-7871c398de44</GUID>
    <GroupId>d2d7ca7a-bec1-45a5-8d40-8fb24cc709ef</GroupId>
    <SelectedValue>sample string 4</SelectedValue>
    <Text>sample string 2</Text>
  </UserDefinedField>
  <UserDefinedField>
    <FieldId>31814df2-c155-4376-9d3a-b93d9d54a1fe</FieldId>
    <GUID>2e25ab81-f2a5-4b02-8753-7871c398de44</GUID>
    <GroupId>d2d7ca7a-bec1-45a5-8d40-8fb24cc709ef</GroupId>
    <SelectedValue>sample string 4</SelectedValue>
    <Text>sample string 2</Text>
  </UserDefinedField>
</ArrayOfUserDefinedField>