Custom fields¶
Get list of custom fields¶
Request¶
GET /customfields
| Parameter | Description |
|---|---|
| clientname | (mandatory) Portfolio name |
| authorization | (mandatory) Authentication token |
| select | (optional) List of fields to include into the result |
| filter | (optional) Filter parameters |
| sort | (optional) Sorting parameters |
Response sample¶
[
{
"Name": "Address",
"FieldType": {
"Name": "Text",
"DataType": 3,
"Description": "The attribute data should be interpreted as a string of text.",
"IsSystem": true,
"Id": "110cc2e6-5cae-4e6c-a435-19fe184acee0"
},
"IsSystem": false,
"IsReadonly": false,
"MaxLength": 0,
"Id": "ba37e9b8-f7c4-4a21-a0c7-2154260ee732"
}
]
Get list of custom field types¶
Request¶
GET /customfields/types
| Parameter | Description |
|---|---|
| clientname | (mandatory) Workspace name |
| Authorization | (mandatory) Authentication token |
| select | (optional) List of fields to include into the result |
| filter | (optional) Filter parameters |
| Sort | (optional) Sorting parameters |
Available fields¶
{"Id", "Name", "DataType", "Description", "Values": {"Id", "Name"}}
Response sample¶
[
{
"Name": "Dropdown",
"DataType": 3,
"Values": [
{
"Name": "Value 1",
"Id": "141393a5-7fb3-4559-858f-ca1c2d231c7a"
},
{
"Name": "Value 2",
"Id": "0aa6bffe-28d7-4418-8631-2152424bebfd"
}
],
"IsSystem": false,
"Id": "4e004b9b-c474-4926-904b-d1dcc41a048c"
}
]
Get list of custom field type values¶
Request¶
GET /customfields/types/{fieldTypeId:guid}/values
Get object structure group¶
GET /{entityType}/groups
Get fields in the object structure group¶
GET /{entityType}/groups/{groupId}/fields
Get object structure group (for a category)¶
GET /categories/{categoryId}/{entityType}/groups
Get fields in the object structure group (for a category)¶
GET /categories/{categoryId}/{entityType}/groups/{groupId}/fields