ALalloy
Cases

Get a case by a uniquely defined case token

Changed on
<Callout type="warning" title="Deprecated Warning"> This endpoint is deprecated in favor of using Investigations. </Callout>

Retrieves a single case uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-".

get/cases/{case_token}

Request

Path parameters

case_tokenstring required

Token of case to get.

Response

Case

case_tokenstring

A unique identifier for the case itself, generated by Alloy's internal system

entity_tokenstring

A unique identifier for the entity itself, generated by Alloy's internal system. Currently, cases can only have one entity related to it

statusstring

The current status of the case. This is nullable, as some cases may not have an initial status

closedboolean

This represents if the case is open or not

sandboxboolean

This represents if the case is a "real" case, or if has been used as a test. Similar to the "environment" on evaluations

unreadboolean

This represents if the case has been read by a user, since it's last update

created_atnumber

A Unix timestamp for when the case was created

updated_atnumber

A Unix timestamp for when the case was last updated

closed_atnumber

A Unix timestamp for when the case was closed. This is null if the case is still open

assigned_agent_emailstring

If the case is currently assigned, this is the email of that individual

assigned_agent_namestring

If the case is currently assigned, this is the full name of that individual

program_namestring
alertsstring[]

The tags related to the case. ALL of these tags MUST be case generating, at the time they were linked to the case. All of these tags must have the same type

customer_tag_type_namestring

This is essentially the "Case Type." All tags associated to a case, must have the same type as this value tied to the case

customer_tag_type_descriptionstring

This is an extended description for the type itself

is_escalatedboolean

An indicator for if the case was escalated to a different assignee. This is cleared out, upon a different assignee being chosen

is_manualboolean

Represents if the case was generated by Alloy's internal system, or some kind of manual interaction

created_by_agent_emailstring

If the case was manually generated, this is the full name of who took that action

created_by_agent_namestring

If the case was manually generated, this is the email of who took that action

Changes

  • 615aa97a5ddbRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status