ONoneuptime
Incident Custom Field

Get Incident Custom Field

Endpoint to retrieve a single Incident Custom Field by ID

post/incident-custom-field/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Incident Custom Field to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "mapFromResourceType": true,
    "mapFromCustomFieldName": true,
    "variableKey": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Severity Level",
    "description": "This field tracks the severity level of the incident (Minor, Major, Critical)",
    "customFieldType": "Text",
    "dropdownOptions": "Option 1\nOption 2\nOption 3",
    "mapFromResourceType": "Monitor",
    "mapFromCustomFieldName": "Vendor",
    "isRequiredOnCreate": true,
    "sortOrder": 42,
    "showOnCreate": true,
    "includeInSubscriberNotifications": true,
    "variableKey": "expected_resolution",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.