Resource: Custom Field Type ( /api/customfieldtype/{name} )
Custom field type resource
This resource supports the following methods: GET
Methods
GET
Retrieves a custom field type by its name.
Status Codes
These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 404 - NotFound | Returned if the custom field type does not exist. |
Example - Get custom field type
Example of fetching all custom field types.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {name} | Text | The name of the custom field type to retrieve. |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Items": [
{
"Name": "Text",
"DisplayName": "Text",
"Self": "http://localhost/api/customfieldtype/text"
}
]
}
|
Status Code
200 - OK