Create a work item link

v2 (latest)

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

概要

Creates a directional link between two work items (for example, work item A blocks work item B). The parent and child work items and their relationship type must be specified.

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

リクエスト

Body Data (required)

Work item link create request.

Expand All

フィールド

タイプ

説明

data [required]

object

Data object for creating a work item link.

{
  "data": {
    "attributes": {
      "child_entity_id": "4417921d-0866-4a38-822c-6f2a0f65f77d",
      "child_entity_type": "CASE",
      "parent_entity_id": "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
      "parent_entity_type": "CASE",
      "relationship": "BLOCKS"
    },
    "type": "link"
  }
}

応答

Created

Response containing a single work item link.

Expand All

フィールド

タイプ

説明

data [required]

object

A directional link representing a relationship between two entities. At least one entity must be a work item.

{
  "data": {
    "attributes": {
      "child_entity_id": "4417921d-0866-4a38-822c-6f2a0f65f77d",
      "child_entity_type": "CASE",
      "parent_entity_id": "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
      "parent_entity_type": "CASE",
      "relationship": "BLOCKS"
    },
    "id": "804cd682-55f6-4541-ab00-b608b282ea7d",
    "type": "link"
  }
}

Bad Request

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

Unauthorized

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

Forbidden

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

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

コード例

                  ## 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/link" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "child_entity_id": "4417921d-0866-4a38-822c-6f2a0f65f77d",
      "child_entity_type": "CASE",
      "parent_entity_id": "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
      "parent_entity_type": "CASE",
      "relationship": "BLOCKS"
    },
    "type": "link"
  }
}
EOF

                

"""
Create a case link 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_link_attributes import CaseLinkAttributes
from datadog_api_client.v2.model.case_link_create import CaseLinkCreate
from datadog_api_client.v2.model.case_link_create_request import CaseLinkCreateRequest
from datadog_api_client.v2.model.case_link_resource_type import CaseLinkResourceType

body = CaseLinkCreateRequest(
    data=CaseLinkCreate(
        attributes=CaseLinkAttributes(
            child_entity_id="4417921d-0866-4a38-822c-6f2a0f65f77d",
            child_entity_type="CASE",
            parent_entity_id="bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
            parent_entity_type="CASE",
            relationship="BLOCKS",
        ),
        type=CaseLinkResourceType.LINK,
    ),
)

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_link(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 link 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::CaseLinkCreateRequest.new({
  data: DatadogAPIClient::V2::CaseLinkCreate.new({
    attributes: DatadogAPIClient::V2::CaseLinkAttributes.new({
      child_entity_id: "4417921d-0866-4a38-822c-6f2a0f65f77d",
      child_entity_type: "CASE",
      parent_entity_id: "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
      parent_entity_type: "CASE",
      relationship: "BLOCKS",
    }),
    type: DatadogAPIClient::V2::CaseLinkResourceType::LINK,
  }),
})
p api_instance.create_case_link(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 link 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.CaseLinkCreateRequest{
		Data: datadogV2.CaseLinkCreate{
			Attributes: datadogV2.CaseLinkAttributes{
				ChildEntityId:    "4417921d-0866-4a38-822c-6f2a0f65f77d",
				ChildEntityType:  "CASE",
				ParentEntityId:   "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
				ParentEntityType: "CASE",
				Relationship:     "BLOCKS",
			},
			Type: datadogV2.CASELINKRESOURCETYPE_LINK,
		},
	}
	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.CreateCaseLink(ctx, body)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `CaseManagementApi.CreateCaseLink`:\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 link 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.CaseLinkAttributes;
import com.datadog.api.client.v2.model.CaseLinkCreate;
import com.datadog.api.client.v2.model.CaseLinkCreateRequest;
import com.datadog.api.client.v2.model.CaseLinkResourceType;
import com.datadog.api.client.v2.model.CaseLinkResponse;

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);

    CaseLinkCreateRequest body =
        new CaseLinkCreateRequest()
            .data(
                new CaseLinkCreate()
                    .attributes(
                        new CaseLinkAttributes()
                            .childEntityId("4417921d-0866-4a38-822c-6f2a0f65f77d")
                            .childEntityType("CASE")
                            .parentEntityId("bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f")
                            .parentEntityType("CASE")
                            .relationship("BLOCKS"))
                    .type(CaseLinkResourceType.LINK));

    try {
      CaseLinkResponse result = apiInstance.createCaseLink(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CaseManagementApi#createCaseLink");
      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 link returns "Created" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_case_management::CaseManagementAPI;
use datadog_api_client::datadogV2::model::CaseLinkAttributes;
use datadog_api_client::datadogV2::model::CaseLinkCreate;
use datadog_api_client::datadogV2::model::CaseLinkCreateRequest;
use datadog_api_client::datadogV2::model::CaseLinkResourceType;

#[tokio::main]
async fn main() {
    let body = CaseLinkCreateRequest::new(CaseLinkCreate::new(
        CaseLinkAttributes::new(
            "4417921d-0866-4a38-822c-6f2a0f65f77d".to_string(),
            "CASE".to_string(),
            "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f".to_string(),
            "CASE".to_string(),
            "BLOCKS".to_string(),
        ),
        CaseLinkResourceType::LINK,
    ));
    let configuration = datadog::Configuration::new();
    let api = CaseManagementAPI::with_config(configuration);
    let resp = api.create_case_link(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 link 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.CaseManagementApiCreateCaseLinkRequest = {
  body: {
    data: {
      attributes: {
        childEntityId: "4417921d-0866-4a38-822c-6f2a0f65f77d",
        childEntityType: "CASE",
        parentEntityId: "bf0cbac6-4c16-4cfb-b6bf-ca5e0ec37a4f",
        parentEntityType: "CASE",
        relationship: "BLOCKS",
      },
      type: "link",
    },
  },
};

apiInstance
  .createCaseLink(params)
  .then((data: v2.CaseLinkResponse) => {
    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"

Create a work item link

概要

リクエスト

Body Data (required)

応答

コード例

Create a work item link

Create a work item link

Instructions

Create a work item link

Instructions

Create a work item link

Instructions

Create a work item link

Instructions

Create a work item link

Instructions

Create a work item link

Instructions

How can I help you today?