Incident Grouping Rule

Get Incident Grouping Rule

Endpoint to retrieve a single Incident Grouping Rule by ID

post/incident-grouping-rule/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Incident Grouping Rule to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": 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,
    "criteria": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Example short text",
    "description": "This is an example of longer text content that might be stored in this field.",
    "priority": 42,
    "isEnabled": true,
    "matchCriteria": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "monitors": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "incidentSeverities": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "incidentLabels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "monitorLabels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "incidentTitlePattern": "This is an example of longer text content that might be stored in this field.",
    "incidentDescriptionPattern": "This is an example of longer text content that might be stored in this field.",
    "monitorNamePattern": "This is an example of longer text content that might be stored in this field.",
    "monitorDescriptionPattern": "This is an example of longer text content that might be stored in this field.",
    "groupByMonitor": true,
    "groupBySeverity": true,
    "groupByIncidentTitle": true,
    "groupByIncidentLabels": true,
    "groupByMonitorLabels": true,
    "enableTimeWindow": true,
    "timeWindowMinutes": 42,
    "groupByFields": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "episodeTitleTemplate": "This is an example of longer text content that might be stored in this field.",
    "episodeDescriptionTemplate": "This is an example of longer text content that might be stored in this field.",
    "enableResolveDelay": true,
    "resolveDelayMinutes": 42,
    "enableReopenWindow": true,
    "reopenWindowMinutes": 42,
    "enableInactivityTimeout": true,
    "inactivityTimeoutMinutes": 42,
    "onCallDutyPolicies": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "defaultAssignToUserId": "123e4567-e89b-12d3-a456-426614174000",
    "defaultAssignToTeamId": "123e4567-e89b-12d3-a456-426614174000",
    "episodeLabels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "episodeOwnerUsers": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "episodeOwnerTeams": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "episodeMemberRoles": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "episodeMemberRoleAssignments": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "showEpisodeOnStatusPage": true
  }
}

Changes

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