Description: Return a list of the configured custom fields that meet a certain criteria
Example: https://api.totalsynergy.com/api/v2/Organisation/testOrg/CustomFields?ParentTypeId=1
Optional Parameters:
| ParentTypeId |
Only show the custom fields for a particular tyoe
- 1:Project
- 2:Contact
- 3:Personnel
- 4:Stage
- 6:Staff
|
| ActiveId |
Show active, non active or all (default) custom fields
- 0:Not active
- 1:Active
- 2:All
|
| Search |
Return records that contain the search term in the name field |
Response:
{
"currentPage": 1,
"pageSize": 2,
"totalItems": 2,
"items": [
{
"id": 1,
"name": "External Code",
"description": "",
"parentTypeId": 1,
"parentTypeDisplay": "Project",
"dataTypeId": 2,
"dataTypeDisplay": "Text",
"isMandatory": false,
"isActive": true,
"isAlert": false,
"decimalPlaces": 0,
"sort": 0,
"alertAfterDays": 0,
"alertMessage": null,
"alertBefore": false,
"alertBeforeDays": 0,
"alertBeforeMessage": null,
"customFieldOptions": []
},
{
"id": 2,
"name": "Ranking",
"description": "",
"parentTypeId": 2,
"parentTypeDisplay": "Contact",
"dataTypeId": 5,
"dataTypeDisplay": "Drop down list",
"isMandatory": false,
"isActive": true,
"isAlert": false,
"decimalPlaces": 0,
"sort": 0,
"alertAfterDays": 0,
"alertMessage": null,
"alertBefore": false,
"alertBeforeDays": 0,
"alertBeforeMessage": null,
"customFieldOptions": []
}
]
}