Optional requestFactory: CaseManagementApiRequestFactoryOptional responseProcessor: CaseManagementApiResponseProcessorPrivate configurationPrivate requestPrivate responseThe request object
Optional options: ConfigurationPerforms an aggregation query over cases, grouping results by specified fields and returning counts per group along with a total. Useful for dashboards and analytics.
The request object
Optional options: ConfigurationArchive case
The request object
Optional options: ConfigurationAssign case to a user
The request object
Optional options: ConfigurationApplies a single action (such as changing priority, status, assignment, or archiving) to multiple cases at once. The list of case IDs and the action type with its payload are specified in the request body.
The request object
Optional options: ConfigurationComment case
The request object
Optional options: ConfigurationReturns case counts, optionally grouped by one or more fields (for example, status, priority). Supports a query filter to narrow the scope.
The request object
Optional options: ConfigurationCreate a Case
The request object
Optional options: ConfigurationCreates an automation rule for a project. The rule defines a trigger event (for example, case created, status transitioned) and an action to execute.
The request object
Optional options: ConfigurationCreate a new Jira issue and link it to a case
The request object
Optional options: ConfigurationCreates a directional link between two cases (for example, case A blocks case B). The parent and child cases and their relationship type must be specified.
The request object
Optional options: ConfigurationCreate a new investigation notebook and link it to a case
The request object
Optional options: ConfigurationCreate a new ServiceNow incident ticket and link it to a case
The request object
Optional options: ConfigurationCreates a new saved case view with a name, filter query, and associated project. Optionally, a notification rule can be linked to the view.
The request object
Optional options: ConfigurationCreates a maintenance window for event management cases with a name, case filter query, and time range (start and end).
The request object
Optional options: ConfigurationCreate a project.
The request object
Optional options: ConfigurationCreate a notification rule for a project.
The request object
Optional options: ConfigurationPermanently deletes an automation rule from a project.
The request object
Optional options: ConfigurationDelete case comment
The request object
Optional options: ConfigurationDelete custom attribute from case
The request object
Optional options: ConfigurationDeletes an existing link between cases by link ID.
The request object
Optional options: ConfigurationPermanently deletes a saved case view.
The request object
Optional options: ConfigurationPermanently deletes a maintenance window.
The request object
Optional options: ConfigurationRemove a project using the project's id.
The request object
Optional options: ConfigurationDelete a notification rule using the notification rule's id.
The request object
Optional options: ConfigurationDisables an automation rule so it no longer triggers on case events. The rule configuration is preserved.
The request object
Optional options: ConfigurationEnables a previously disabled automation rule so it triggers on matching case events.
The request object
Optional options: ConfigurationMarks a case project as a favorite for the current authenticated user.
The request object
Optional options: ConfigurationGet the details of case by case_id
The request object
Optional options: ConfigurationReturns a single automation rule identified by its UUID, including its trigger, action, and current state (enabled/disabled).
The request object
Optional options: ConfigurationReturns a single saved case view identified by its UUID, including its query, associated project, and timestamps.
The request object
Optional options: ConfigurationGet the details of a project by project_id.
The request object
Optional options: ConfigurationGet all notification rules for a project.
The request object
Optional options: ConfigurationGet all projects.
Optional options: ConfigurationLink an incident to a case
The request object
Optional options: ConfigurationLink an existing Jira issue to a case
The request object
Optional options: ConfigurationReturns all automation rules configured for a project. Automation rules allow automatic actions to be triggered by case events like creation, status transitions, or attribute changes.
The request object
Optional options: ConfigurationReturns all links associated with a case. Links define relationships (for example, BLOCKS) between cases. Requires entity_type and entity_id query parameters.
The request object
Optional options: ConfigurationReturns the timeline of events for a case, including comments, status changes, and other activity. Supports pagination and sort order.
The request object
Optional options: ConfigurationReturns all saved case views for a given project. Views are saved search queries that allow quick access to filtered lists of cases.
The request object
Optional options: ConfigurationReturns the list of users who are watching a case. Watchers receive notifications about updates to the case.
The request object
Optional options: ConfigurationReturns all configured maintenance windows for event management cases. Maintenance windows define time periods during which case notifications and automation rules are suppressed for cases matching a given query.
Optional options: ConfigurationReturns the list of case projects that the current authenticated user has marked as favorites.
Optional options: ConfigurationUpdate the project associated with a case
The request object
Optional options: ConfigurationRemoves one or more previously added insights from a case by specifying their type and resource identifier in the request body.
The request object
Optional options: ConfigurationSearch cases.
The request object
Optional options: ConfigurationProvide a paginated version of searchCases returning a generator with all the items.
Optional options: ConfigurationUnarchive case
The request object
Optional options: ConfigurationUnassign case
The request object
Optional options: ConfigurationRemoves a case project from the current user's favorites list.
The request object
Optional options: ConfigurationRemove the link between a Jira issue and a case
The request object
Optional options: ConfigurationRemoves a user from the watchers list of a case. The user no longer receives notifications about updates to the case.
The request object
Optional options: ConfigurationUpdate case attributes
The request object
Optional options: ConfigurationUpdates the trigger, action, name, or state of an existing automation rule.
The request object
Optional options: ConfigurationUpdates the text content of an existing comment on a case timeline. The comment is identified by its cell ID.
The request object
Optional options: ConfigurationUpdate case custom attribute
The request object
Optional options: ConfigurationUpdate case description
The request object
Optional options: ConfigurationSets or updates the due date for a case. The due date is a calendar date (without a time component) indicating when the case should be resolved.
The request object
Optional options: ConfigurationSets the resolved reason for a security case (for example, FALSE_POSITIVE, TRUE_POSITIVE). Applicable to security-type cases.
The request object
Optional options: ConfigurationUpdate case title
The request object
Optional options: ConfigurationUpdates the name, query, or notification rule of an existing case view.
The request object
Optional options: ConfigurationUpdates the name, query, start time, or end time of an existing maintenance window.
The request object
Optional options: ConfigurationUpdate case priority
The request object
Optional options: ConfigurationUpdate a project.
The request object
Optional options: ConfigurationUpdate a notification rule.
The request object
Optional options: ConfigurationUpdate case status
The request object
Optional options: ConfigurationAdds a user (identified by their UUID) as a watcher of a case. The user receives notifications about subsequent updates to the case.
The request object
Optional options: ConfigurationGenerated using TypeDoc
Adds one or more insights to a case. Insights are references to related Datadog resources (such as monitors, security signals, incidents, or error tracking issues) that provide investigative context. Up to 100 insights can be added per request. Each insight requires a type (see
CaseInsightTypefor allowed values), a ref (URL path to the resource), and a resource_id.