Name | Type | Read-only | Mandatory | Comment |
|---|---|---|---|---|
| id | integer | yes | no | |
| name | string | no | yes | |
| required | boolean | no | no | |
| active | boolean | no | no | |
| order | integer | no | no | |
| fieldType | string | no | yes | one of: text, textarea, select, checkbox, radio, date, number, datetime, time |
| locationId | integer | no | no | Location.id |
| groupId | integer | no | no | Group.id |
| categoryId | integer | no | no | Category.id |
| categoryOptionId | integer | no | no | CategoryOption.id |
Uri | Method | Request Data | Success Response Code | Description |
|---|---|---|---|---|
| /api/custom-fields | GET | 200 | Returns an Array of all CustomFields | |
| /api/custom-fields/{id} | GET | 200 | Returns one CustomField | |
| /api/custom-fields | POST | CustomField | 201 | Create new CustomField |
| /api/custom-fields/{id} | PUT | CustomField | 204 | Update an existing CustomField |
| /api/custom-fields/{id} | DELETE | 200 | Delete a CustomField |