Create Jira issue template

Note: This endpoint is in public beta and it’s subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/integration/jira/issue-templateshttps://api.ap2.datadoghq.com/api/v2/integration/jira/issue-templateshttps://api.datadoghq.eu/api/v2/integration/jira/issue-templateshttps://api.ddog-gov.com/api/v2/integration/jira/issue-templateshttps://api.us2.ddog-gov.com/api/v2/integration/jira/issue-templateshttps://api.datadoghq.com/api/v2/integration/jira/issue-templateshttps://api.us3.datadoghq.com/api/v2/integration/jira/issue-templateshttps://api.us5.datadoghq.com/api/v2/integration/jira/issue-templates

Overview

Create a new Jira issue template.

Request

Body Data (required)

Expand All

Field

Type

Description

data

object

Data object for creating a Jira issue template

attributes

object

Attributes for creating a Jira issue template

fields

object

Custom fields for the Jira issue template

issue_type_id

string

The ID of the Jira issue type

jira-account

object

Reference to the Jira account

id [required]

uuid

The ID of the Jira account

name

string

The name of the issue template

project_id

string

The ID of the Jira project

type

enum

Type identifier for Jira issue template resources Allowed enum values: jira-issue-template

{
  "data": {
    "attributes": {
      "fields": {
        "description": {
          "payload": "Test",
          "type": "json"
        }
      },
      "issue_type_id": "12730",
      "jira-account": {
        "id": "80f16d40-1fba-486e-b1fc-983e6ca19bec"
      },
      "name": "test-template",
      "project_id": "10772"
    },
    "type": "jira-issue-template"
  }
}

Response

Created

Response containing a single Jira issue template

Expand All

Field

Type

Description

data [required]

object

Data object for a Jira issue template

attributes [required]

object

Attributes of a Jira issue template

fields [required]

object

Custom fields for the Jira issue template

issue_type_id [required]

string

The ID of the Jira issue type

name [required]

string

The name of the issue template

project_id [required]

string

The ID of the Jira project

id [required]

uuid

Unique identifier for the Jira issue template

relationships

object

Relationships of a Jira issue template

jira-account [required]

object

Relationship to a Jira account

data [required]

object

Data object for a Jira account

attributes [required]

object

Attributes of a Jira account

consumer_key [required]

string

The consumer key for the Jira account

instance_url [required]

string

The URL of the Jira instance

last_webhook_timestamp

date-time

Timestamp of the last webhook received

id [required]

string

Unique identifier for the Jira account

type [required]

enum

Type identifier for Jira account resources Allowed enum values: jira-account

type [required]

enum

Type identifier for Jira issue template resources Allowed enum values: jira-issue-template

included

[object]

Array of Jira account data objects

attributes [required]

object

Attributes of a Jira account

consumer_key [required]

string

The consumer key for the Jira account

instance_url [required]

string

The URL of the Jira instance

last_webhook_timestamp

date-time

Timestamp of the last webhook received

id [required]

string

Unique identifier for the Jira account

type [required]

enum

Type identifier for Jira account resources Allowed enum values: jira-account

{
  "data": {
    "attributes": {
      "fields": {
        "description": {
          "payload": "Test Description",
          "type": "json"
        }
      },
      "issue_type_id": "456",
      "name": "Test Template",
      "project_id": "123"
    },
    "id": "65b3341b-0680-47f9-a6d4-134db45c603e",
    "relationships": {
      "jira-account": {
        "data": {
          "attributes": {
            "consumer_key": "consumer-key-1",
            "instance_url": "https://example.atlassian.net",
            "last_webhook_timestamp": "2024-01-15T10:30:00Z"
          },
          "id": "account-1",
          "type": "jira-account"
        }
      }
    },
    "type": "jira-issue-template"
  },
  "included": [
    {
      "attributes": {
        "consumer_key": "consumer-key-1",
        "instance_url": "https://example.atlassian.net",
        "last_webhook_timestamp": "2024-01-15T10:30:00Z"
      },
      "id": "account-1",
      "type": "jira-account"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "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
# 

# 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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/jira/issue-templates" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "fields": { "description": { "payload": "Test", "type": "json" } }, "issue_type_id": "12730", "jira-account": { "id": "80f16d40-1fba-486e-b1fc-983e6ca19bec" }, "name": "test-template", "project_id": "10772" }, "type": "jira-issue-template" } } EOF
"""
Create Jira issue template returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.jira_integration_api import JiraIntegrationApi
from datadog_api_client.v2.model.jira_issue_template_create_request import JiraIssueTemplateCreateRequest
from datadog_api_client.v2.model.jira_issue_template_create_request_attributes import (
    JiraIssueTemplateCreateRequestAttributes,
)
from datadog_api_client.v2.model.jira_issue_template_create_request_attributes_jira_account import (
    JiraIssueTemplateCreateRequestAttributesJiraAccount,
)
from datadog_api_client.v2.model.jira_issue_template_create_request_data import JiraIssueTemplateCreateRequestData
from datadog_api_client.v2.model.jira_issue_template_type import JiraIssueTemplateType
from uuid import UUID

body = JiraIssueTemplateCreateRequest(
    data=JiraIssueTemplateCreateRequestData(
        attributes=JiraIssueTemplateCreateRequestAttributes(
            fields=dict([("description", "{'payload': 'Test', 'type': 'json'}")]),
            issue_type_id="12730",
            jira_account=JiraIssueTemplateCreateRequestAttributesJiraAccount(
                id=UUID("80f16d40-1fba-486e-b1fc-983e6ca19bec"),
            ),
            name="test-template",
            project_id="10772",
        ),
        type=JiraIssueTemplateType.JIRA_ISSUE_TEMPLATE,
    ),
)

configuration = Configuration()
configuration.unstable_operations["create_jira_issue_template"] = True
with ApiClient(configuration) as api_client:
    api_instance = JiraIntegrationApi(api_client)
    response = api_instance.create_jira_issue_template(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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Create Jira issue template returns "Created" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.create_jira_issue_template".to_sym] = true
end
api_instance = DatadogAPIClient::V2::JiraIntegrationAPI.new

body = DatadogAPIClient::V2::JiraIssueTemplateCreateRequest.new({
  data: DatadogAPIClient::V2::JiraIssueTemplateCreateRequestData.new({
    attributes: DatadogAPIClient::V2::JiraIssueTemplateCreateRequestAttributes.new({
      fields: {
        "description": "{'payload': 'Test', 'type': 'json'}",
      },
      issue_type_id: "12730",
      jira_account: DatadogAPIClient::V2::JiraIssueTemplateCreateRequestAttributesJiraAccount.new({
        id: "80f16d40-1fba-486e-b1fc-983e6ca19bec",
      }),
      name: "test-template",
      project_id: "10772",
    }),
    type: DatadogAPIClient::V2::JiraIssueTemplateType::JIRA_ISSUE_TEMPLATE,
  }),
})
p api_instance.create_jira_issue_template(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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Create Jira issue template 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"
	"github.com/google/uuid"
)

func main() {
	body := datadogV2.JiraIssueTemplateCreateRequest{
		Data: &datadogV2.JiraIssueTemplateCreateRequestData{
			Attributes: &datadogV2.JiraIssueTemplateCreateRequestAttributes{
				Fields: map[string]interface{}{
					"description": "{'payload': 'Test', 'type': 'json'}",
				},
				IssueTypeId: datadog.PtrString("12730"),
				JiraAccount: &datadogV2.JiraIssueTemplateCreateRequestAttributesJiraAccount{
					Id: uuid.MustParse("80f16d40-1fba-486e-b1fc-983e6ca19bec"),
				},
				Name:      datadog.PtrString("test-template"),
				ProjectId: datadog.PtrString("10772"),
			},
			Type: datadogV2.JIRAISSUETEMPLATETYPE_JIRA_ISSUE_TEMPLATE.Ptr(),
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.CreateJiraIssueTemplate", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewJiraIntegrationApi(apiClient)
	resp, r, err := api.CreateJiraIssueTemplate(ctx, body)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `JiraIntegrationApi.CreateJiraIssueTemplate`:\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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Create Jira issue template returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.JiraIntegrationApi;
import com.datadog.api.client.v2.model.JiraIssueTemplateCreateRequest;
import com.datadog.api.client.v2.model.JiraIssueTemplateCreateRequestAttributes;
import com.datadog.api.client.v2.model.JiraIssueTemplateCreateRequestAttributesJiraAccount;
import com.datadog.api.client.v2.model.JiraIssueTemplateCreateRequestData;
import com.datadog.api.client.v2.model.JiraIssueTemplateResponse;
import com.datadog.api.client.v2.model.JiraIssueTemplateType;
import java.util.Map;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.createJiraIssueTemplate", true);
    JiraIntegrationApi apiInstance = new JiraIntegrationApi(defaultClient);

    JiraIssueTemplateCreateRequest body =
        new JiraIssueTemplateCreateRequest()
            .data(
                new JiraIssueTemplateCreateRequestData()
                    .attributes(
                        new JiraIssueTemplateCreateRequestAttributes()
                            .fields(
                                Map.ofEntries(
                                    Map.entry(
                                        "description", "{'payload': 'Test', 'type': 'json'}")))
                            .issueTypeId("12730")
                            .jiraAccount(
                                new JiraIssueTemplateCreateRequestAttributesJiraAccount()
                                    .id(UUID.fromString("80f16d40-1fba-486e-b1fc-983e6ca19bec")))
                            .name("test-template")
                            .projectId("10772"))
                    .type(JiraIssueTemplateType.JIRA_ISSUE_TEMPLATE));

    try {
      JiraIssueTemplateResponse result = apiInstance.createJiraIssueTemplate(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling JiraIntegrationApi#createJiraIssueTemplate");
      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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Create Jira issue template returns "Created" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_jira_integration::JiraIntegrationAPI;
use datadog_api_client::datadogV2::model::JiraIssueTemplateCreateRequest;
use datadog_api_client::datadogV2::model::JiraIssueTemplateCreateRequestAttributes;
use datadog_api_client::datadogV2::model::JiraIssueTemplateCreateRequestAttributesJiraAccount;
use datadog_api_client::datadogV2::model::JiraIssueTemplateCreateRequestData;
use datadog_api_client::datadogV2::model::JiraIssueTemplateType;
use std::collections::BTreeMap;
use uuid::Uuid;

#[tokio::main]
async fn main() {
    let body = JiraIssueTemplateCreateRequest::new().data(
        JiraIssueTemplateCreateRequestData::new()
            .attributes(
                JiraIssueTemplateCreateRequestAttributes::new()
                    .fields(BTreeMap::from([]))
                    .issue_type_id("12730".to_string())
                    .jira_account(JiraIssueTemplateCreateRequestAttributesJiraAccount::new(
                        Uuid::parse_str("80f16d40-1fba-486e-b1fc-983e6ca19bec")
                            .expect("invalid UUID"),
                    ))
                    .name("test-template".to_string())
                    .project_id("10772".to_string()),
            )
            .type_(JiraIssueTemplateType::JIRA_ISSUE_TEMPLATE),
    );
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.CreateJiraIssueTemplate", true);
    let api = JiraIntegrationAPI::with_config(configuration);
    let resp = api.create_jira_issue_template(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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * Create Jira issue template returns "Created" response
 */

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

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.createJiraIssueTemplate"] = true;
const apiInstance = new v2.JiraIntegrationApi(configuration);

const params: v2.JiraIntegrationApiCreateJiraIssueTemplateRequest = {
  body: {
    data: {
      attributes: {
        fields: {
          description: "{'payload': 'Test', 'type': 'json'}",
        },
        issueTypeId: "12730",
        jiraAccount: {
          id: "80f16d40-1fba-486e-b1fc-983e6ca19bec",
        },
        name: "test-template",
        projectId: "10772",
      },
      type: "jira-issue-template",
    },
  },
};

apiInstance
  .createJiraIssueTemplate(params)
  .then((data: v2.JiraIssueTemplateResponse) => {
    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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"