Note : This endpoint is in public beta and it’s subject to change.
If you have any feedback, contact Datadog support .
PATCH https://api.ap1.datadoghq.com/api/v2/integration/jira/issue-templates/{issue_template_id} https://api.ap2.datadoghq.com/api/v2/integration/jira/issue-templates/{issue_template_id} https://api.datadoghq.eu/api/v2/integration/jira/issue-templates/{issue_template_id} https://api.ddog-gov.com/api/v2/integration/jira/issue-templates/{issue_template_id} https://api.us2.ddog-gov.com/api/v2/integration/jira/issue-templates/{issue_template_id} https://api.datadoghq.com/api/v2/integration/jira/issue-templates/{issue_template_id} https://api.us3.datadoghq.com/api/v2/integration/jira/issue-templates/{issue_template_id} https://api.us5.datadoghq.com/api/v2/integration/jira/issue-templates/{issue_template_id}
Overview Update a Jira issue template by ID.
Arguments Path Parameters issue_template_id [required ]
The ID of the Jira issue template to update
Request Body Data (required)
Expand All
Data object for updating a Jira issue template
Attributes for updating a Jira issue template
Custom fields for the Jira issue template
The name of the issue template
Type identifier for Jira issue template resources
Allowed enum values: jira-issue-template
{
"data" : {
"attributes" : {
"fields" : {
"description" : {
"payload" : "Updated Description" ,
"type" : "json"
}
},
"name" : "test_template_updated"
},
"type" : "jira-issue-template"
}
} Response OK
Response containing a single Jira issue template
Expand All
Data object for a Jira issue template
Attributes of a Jira issue template
Custom fields for the Jira issue template
The ID of the Jira issue type
The name of the issue template
The ID of the Jira project
Unique identifier for the Jira issue template
Relationships of a Jira issue template
Relationship to a Jira account
Data object for a Jira account
Attributes of a Jira account
The consumer key for the Jira account
The URL of the Jira instance
Timestamp of the last webhook received
Unique identifier for the Jira account
Type identifier for Jira account resources
Allowed enum values: jira-account
Type identifier for Jira issue template resources
Allowed enum values: jira-issue-template
Array of Jira account data objects
Attributes of a Jira account
The consumer key for the Jira account
The URL of the Jira instance
Timestamp of the last webhook received
Unique identifier for the Jira account
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
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
{
"errors" : [
"Bad Request"
]
} Code Example Copy
## default
#
# Path parameters export issue_template_id = "65b3341b-0680-47f9-a6d4-134db45c603e" # Curl command curl -X PATCH "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/${issue_template_id} " \
-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": "Updated Description",
"type": "json"
}
},
"name": "test_template_updated"
},
"type": "jira-issue-template"
}
}
EOF
"""
Update Jira issue template returns "OK" 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_type import JiraIssueTemplateType
from datadog_api_client.v2.model.jira_issue_template_update_request import JiraIssueTemplateUpdateRequest
from datadog_api_client.v2.model.jira_issue_template_update_request_attributes import (
JiraIssueTemplateUpdateRequestAttributes ,
)
from datadog_api_client.v2.model.jira_issue_template_update_request_data import JiraIssueTemplateUpdateRequestData
from uuid import UUID
body = JiraIssueTemplateUpdateRequest (
data = JiraIssueTemplateUpdateRequestData (
attributes = JiraIssueTemplateUpdateRequestAttributes (
fields = dict ([( "description" , "{'payload': 'Updated Description', 'type': 'json'}" )]),
name = "test_template_updated" ,
),
type = JiraIssueTemplateType . JIRA_ISSUE_TEMPLATE ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "update_jira_issue_template" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = JiraIntegrationApi ( api_client )
response = api_instance . update_jira_issue_template (
issue_template_id = UUID ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ), 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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# Update Jira issue template returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.update_jira_issue_template" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: JiraIntegrationAPI . new
body = DatadogAPIClient :: V2 :: JiraIssueTemplateUpdateRequest . new ({
data : DatadogAPIClient :: V2 :: JiraIssueTemplateUpdateRequestData . new ({
attributes : DatadogAPIClient :: V2 :: JiraIssueTemplateUpdateRequestAttributes . new ({
fields : {
"description" : "{'payload': 'Updated Description', 'type': 'json'}" ,
},
name : "test_template_updated" ,
}),
type : DatadogAPIClient :: V2 :: JiraIssueTemplateType :: JIRA_ISSUE_TEMPLATE ,
}),
})
p api_instance . update_jira_issue_template ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" , body )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// Update Jira issue template returns "OK" 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 . JiraIssueTemplateUpdateRequest {
Data : datadogV2 . JiraIssueTemplateUpdateRequestData {
Attributes : datadogV2 . JiraIssueTemplateUpdateRequestAttributes {
Fields : map [ string ] interface {}{
"description" : "{'payload': 'Updated Description', 'type': 'json'}" ,
},
Name : datadog . PtrString ( "test_template_updated" ),
},
Type : datadogV2 . JIRAISSUETEMPLATETYPE_JIRA_ISSUE_TEMPLATE ,
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.UpdateJiraIssueTemplate" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewJiraIntegrationApi ( apiClient )
resp , r , err := api . UpdateJiraIssueTemplate ( ctx , uuid . MustParse ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ), body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `JiraIntegrationApi.UpdateJiraIssueTemplate`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `JiraIntegrationApi.UpdateJiraIssueTemplate`:\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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// Update Jira issue template returns "OK" 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.JiraIssueTemplateResponse ;
import com.datadog.api.client.v2.model.JiraIssueTemplateType ;
import com.datadog.api.client.v2.model.JiraIssueTemplateUpdateRequest ;
import com.datadog.api.client.v2.model.JiraIssueTemplateUpdateRequestAttributes ;
import com.datadog.api.client.v2.model.JiraIssueTemplateUpdateRequestData ;
import java.util.Map ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.updateJiraIssueTemplate" , true );
JiraIntegrationApi apiInstance = new JiraIntegrationApi ( defaultClient );
JiraIssueTemplateUpdateRequest body =
new JiraIssueTemplateUpdateRequest ()
. data (
new JiraIssueTemplateUpdateRequestData ()
. attributes (
new JiraIssueTemplateUpdateRequestAttributes ()
. fields (
Map . ofEntries (
Map . entry (
"description" ,
"{'payload': 'Updated Description', 'type': 'json'}" )))
. name ( "test_template_updated" ))
. type ( JiraIssueTemplateType . JIRA_ISSUE_TEMPLATE ));
try {
JiraIssueTemplateResponse result =
apiInstance . updateJiraIssueTemplate (
UUID . fromString ( "65b3341b-0680-47f9-a6d4-134db45c603e" ), body );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling JiraIntegrationApi#updateJiraIssueTemplate" );
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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
// Update Jira issue template returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_jira_integration ::JiraIntegrationAPI ;
use datadog_api_client ::datadogV2 ::model ::JiraIssueTemplateType ;
use datadog_api_client ::datadogV2 ::model ::JiraIssueTemplateUpdateRequest ;
use datadog_api_client ::datadogV2 ::model ::JiraIssueTemplateUpdateRequestAttributes ;
use datadog_api_client ::datadogV2 ::model ::JiraIssueTemplateUpdateRequestData ;
use std ::collections ::BTreeMap ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let body = JiraIssueTemplateUpdateRequest ::new ( JiraIssueTemplateUpdateRequestData ::new (
JiraIssueTemplateUpdateRequestAttributes ::new ()
. fields ( BTreeMap ::from ([]))
. name ( "test_template_updated" . to_string ()),
JiraIssueTemplateType ::JIRA_ISSUE_TEMPLATE ,
));
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.UpdateJiraIssueTemplate" , true );
let api = JiraIntegrationAPI ::with_config ( configuration );
let resp = api
. update_jira_issue_template (
Uuid ::parse_str ( "00000000-0000-0000-0000-000000000000" ). expect ( "invalid UUID" ),
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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* Update Jira issue template returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.updateJiraIssueTemplate" ] = true ;
const apiInstance = new v2 . JiraIntegrationApi ( configuration );
const params : v2.JiraIntegrationApiUpdateJiraIssueTemplateRequest = {
body : {
data : {
attributes : {
fields : {
description : "{'payload': 'Updated Description', 'type': 'json'}" ,
},
name : "test_template_updated" ,
},
type : "jira-issue-template" ,
},
},
issueTemplateId : "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ,
};
apiInstance
. updateJiraIssueTemplate ( 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.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"