Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
fieldManagementV1

Get a custom field.

Get the details of a custom field.

get/v1/fields/{id}

Path parameters

idstring required

Identifier of a field.

Response

The details of the custom field.

fieldNamestring required

Field name.

fieldIdstring required

Identifier of the field.

dataTypestring required

Field type. Possible values are String, Long, Int, Double, and Boolean.

statestring required

Indicates whether the field is enabled and its values are being accepted. Possible values are Enabled and Disabled.

Example response

{
  "fieldName": "hostIP",
  "fieldId": "00000000031D02DA",
  "dataType": "String",
  "state": "Enabled"
}