For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/case-management/create-a-case-view.md. A documentation index is available at /llms.txt.

Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED

Create a case view

copy Copy pageCopied

POST https://api.ap1.datadoghq.com/api/v2/cases/viewshttps://api.ap2.datadoghq.com/api/v2/cases/viewshttps://api.datadoghq.eu/api/v2/cases/viewshttps://api.ddog-gov.com/api/v2/cases/viewshttps://api.us2.ddog-gov.com/api/v2/cases/viewshttps://api.uk1.datadoghq.com/api/v2/cases/viewshttps://api.datadoghq.com/api/v2/cases/viewshttps://api.us3.datadoghq.com/api/v2/cases/viewshttps://api.us5.datadoghq.com/api/v2/cases/views

Overview

Creates a new saved case view with a name, filter query, and associated project. Optionally, a notification rule can be linked to the view.

OAuth apps require the cases_write authorization scope to access this endpoint.

Request

Body Data (required)

Case view payload.

Expand All

Field

Type

Description

data [required]

object

Data object for creating a case view.

attributes [required]

object

Attributes required to create a case view.

name [required]

string

The name of the view.

np_rule_id

string

The identifier of a notification rule linked to this view. When set, users subscribed to the view receive alerts for matching cases.

project_id [required]

string

The UUID of the project this view belongs to. Views are scoped to a single project.

query [required]

string

The query used to filter cases in this view.

type [required]

enum

JSON:API resource type for case views. Allowed enum values: view

default: view

{
  "data": {
    "attributes": {
      "name": "Open bugs",
      "np_rule_id": "string",
      "project_id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
      "query": "status:open type:bug"
    },
    "type": "view"
  }
}

Response

Created

Response containing a single case view.

Expand All

Field

Type

Description

data [required]

object

A saved case view that provides a filtered, reusable list of cases matching a specific query. Views act as persistent dashboards for monitoring case subsets.

attributes [required]

object

Attributes of a case view, including the filter query and optional notification rule.

created_at [required]

date-time

Timestamp when the view was created.

modified_at

date-time

Timestamp when the view was last modified.

name [required]

string

A human-readable name for the view, displayed in the Case Management UI.

np_rule_id

string

The identifier of a notification rule linked to this view. When set, users subscribed to the view receive alerts for matching cases.

query [required]

string

The search query that determines which cases appear in this view. Uses the same syntax as the Case Management search bar (for example, status:open priority:P1).

id [required]

string

The view's identifier.

relationships

object

Related resources for the case view, including the creator, last modifier, and associated project.

created_by

object

Relationship to user.

data [required]

object

Relationship to user object.

id [required]

string

A unique identifier that represents the user.

type [required]

enum

User resource type. Allowed enum values: user

default: user

modified_by

object

Relationship to user.

data [required]

object

Relationship to user object.

id [required]

string

A unique identifier that represents the user.

type [required]

enum

User resource type. Allowed enum values: user

default: user

project

object

Relationship to project.

data [required]

object

Relationship to project object.

id [required]

string

A unique identifier that represents the project.

type [required]

enum

Project resource type. Allowed enum values: project

default: project

type [required]

enum

JSON:API resource type for case views. Allowed enum values: view

default: view

{
  "data": {
    "attributes": {
      "created_at": "2024-01-01T00:00:00.000Z",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "Open bugs",
      "np_rule_id": "string",
      "query": "status:open type:bug"
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "relationships": {
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "project": {
        "data": {
          "id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
          "type": "project"
        }
      }
    },
    "type": "view"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/views" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Open bugs",
      "project_id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
      "query": "status:open type:bug"
    },
    "type": "view"
  }
}
EOF

                
"""
Create a case view returns "Created" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.case_management_api import CaseManagementApi
from datadog_api_client.v2.model.case_view_create import CaseViewCreate
from datadog_api_client.v2.model.case_view_create_attributes import CaseViewCreateAttributes
from datadog_api_client.v2.model.case_view_create_request import CaseViewCreateRequest
from datadog_api_client.v2.model.case_view_resource_type import CaseViewResourceType

body = CaseViewCreateRequest(
    data=CaseViewCreate(
        attributes=CaseViewCreateAttributes(
            name="Open bugs",
            project_id="e555e290-ed65-49bd-ae18-8acbfcf18db7",
            query="status:open type:bug",
        ),
        type=CaseViewResourceType.VIEW,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = CaseManagementApi(api_client)
    response = api_instance.create_case_view(body=body)

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
# Create a case view returns "Created" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::CaseManagementAPI.new

body = DatadogAPIClient::V2::CaseViewCreateRequest.new({
  data: DatadogAPIClient::V2::CaseViewCreate.new({
    attributes: DatadogAPIClient::V2::CaseViewCreateAttributes.new({
      name: "Open bugs",
      project_id: "e555e290-ed65-49bd-ae18-8acbfcf18db7",
      query: "status:open type:bug",
    }),
    type: DatadogAPIClient::V2::CaseViewResourceType::VIEW,
  }),
})
p api_instance.create_case_view(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"
// Create a case view returns "Created" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.CaseViewCreateRequest{
		Data: datadogV2.CaseViewCreate{
			Attributes: datadogV2.CaseViewCreateAttributes{
				Name:      "Open bugs",
				ProjectId: "e555e290-ed65-49bd-ae18-8acbfcf18db7",
				Query:     "status:open type:bug",
			},
			Type: datadogV2.CASEVIEWRESOURCETYPE_VIEW,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewCaseManagementApi(apiClient)
	resp, r, err := api.CreateCaseView(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CaseManagementApi.CreateCaseView`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.CreateCaseView`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
// Create a case view returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.CaseManagementApi;
import com.datadog.api.client.v2.model.CaseViewCreate;
import com.datadog.api.client.v2.model.CaseViewCreateAttributes;
import com.datadog.api.client.v2.model.CaseViewCreateRequest;
import com.datadog.api.client.v2.model.CaseViewResourceType;
import com.datadog.api.client.v2.model.CaseViewResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);

    CaseViewCreateRequest body =
        new CaseViewCreateRequest()
            .data(
                new CaseViewCreate()
                    .attributes(
                        new CaseViewCreateAttributes()
                            .name("Open bugs")
                            .projectId("e555e290-ed65-49bd-ae18-8acbfcf18db7")
                            .query("status:open type:bug"))
                    .type(CaseViewResourceType.VIEW));

    try {
      CaseViewResponse result = apiInstance.createCaseView(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CaseManagementApi#createCaseView");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
// Create a case view returns "Created" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseViewCreate;
use datadog_api_client::datadogV2::model::CaseViewCreateAttributes;
use datadog_api_client::datadogV2::model::CaseViewCreateRequest;
use datadog_api_client::datadogV2::model::CaseViewResourceType;

#[tokio::main]
async fn main() {
    let body = CaseViewCreateRequest::new(CaseViewCreate::new(
        CaseViewCreateAttributes::new(
            "Open bugs".to_string(),
            "e555e290-ed65-49bd-ae18-8acbfcf18db7".to_string(),
            "status:open type:bug".to_string(),
        ),
        CaseViewResourceType::VIEW,
    ));
    let configuration = datadog::Configuration::new();
    let api = CaseManagementAPI::with_config(configuration);
    let resp = api.create_case_view(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Create a case view returns "Created" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
const apiInstance = new v2.CaseManagementApi(configuration);

const params: v2.CaseManagementApiCreateCaseViewRequest = {
  body: {
    data: {
      attributes: {
        name: "Open bugs",
        projectId: "e555e290-ed65-49bd-ae18-8acbfcf18db7",
        query: "status:open type:bug",
      },
      type: "view",
    },
  },
};

apiInstance
  .createCaseView(params)
  .then((data: v2.CaseViewResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"