--- title: "Get Security Case Status" method: POST path: "/security-case-status/{id}/get-item" tags: ["Security Case Status"] --- # Get Security Case Status `POST /security-case-status/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/security-case-status/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Security Case Status by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` SecurityCaseStatusSelectSchema: Select schema for SecurityCaseStatus. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `slug` boolean - `description` boolean - `color` boolean - `isNewStatus` boolean - `isAcknowledgedStatus` boolean - `isContainedStatus` boolean - `isClosedStatus` boolean - `order` boolean - `isArchived` boolean - `archivedAt` boolean - `archivedByUserId` boolean - `createdByUserId` boolean - `deletedByUserId` boolean ## Response `200` Successful response - object - `data` SecurityCaseStatus - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `version` number: Object version - `projectId` string, uuid, required: ID of the project this status belongs to. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [No access - you don't have permission for this operation] - `name` string, required: What the status is called, like Investigating or Triage. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `slug` string, required: Friendly globally unique name for the status. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [No access - you don't have permission for this operation] - `description` string: What a case in this status is waiting for, in a sentence. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `color` object, required: The status's colour, in hex (#32a852 for example). Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `isNewStatus` boolean: Is it the status every new case starts in? A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `isAcknowledgedStatus` boolean: Is it the status a reopened case moves to? From it down, a case counts as taken on. A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `isContainedStatus` boolean: Is it the status the time to contain is measured to? From it down, a case counts as contained. A project has one. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `isClosedStatus` boolean: Is it the status Close Case moves a case to? From it down, a case counts as closed and carries a verdict. A project has one. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `order` integer: Where this status sits in the project's list of security case statuses: 1 is the top. A case in a status at or below the acknowledged (contained, closed) status counts as acknowledged (contained, closed), so the new, acknowledged, contained and closed statuses have to stay in that order. A new status without a number goes just above the closed status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `isArchived` boolean, required: Archived statuses stay on the cases in them, but can't be picked again. The built-in statuses can't be archived. Permissions - Create: [Project Owner, Project Admin, Security Admin, Create Security Case Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [Project Owner, Project Admin, Security Admin, Edit Security Case Status] - `archivedAt` object: When this status was archived. Empty while it is not archived. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [No access - you don't have permission for this operation] - `archivedByUserId` string, uuid: ID of the person who archived this status. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: ID of the person who added this status. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: ID of the person who deleted this status. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Security Admin, Security Member, Security Viewer, Read Security Case Status], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)