ONoneuptime
Incident Role

Get Incident Role

Endpoint to retrieve a single Incident Role by ID

post/incident-role/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Incident Role to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "roleIcon": 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": "Incident Commander",
    "slug": "example-slug-value",
    "description": "Primary decision maker during an incident",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "color": {
      "_type": "Color",
      "value": "#ff0000"
    },
    "roleIcon": "Example short text",
    "isPrimaryRole": true,
    "isDeleteable": true,
    "canAssignMultipleUsers": true,
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

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