GET https://api.ap1.datadoghq.com/api/v2/integration/servicenow/handles/{template_id} https://api.ap2.datadoghq.com/api/v2/integration/servicenow/handles/{template_id} https://api.datadoghq.eu/api/v2/integration/servicenow/handles/{template_id} https://api.ddog-gov.com/api/v2/integration/servicenow/handles/{template_id} https://api.us2.ddog-gov.com/api/v2/integration/servicenow/handles/{template_id} https://api.datadoghq.com/api/v2/integration/servicenow/handles/{template_id} https://api.us3.datadoghq.com/api/v2/integration/servicenow/handles/{template_id} https://api.us5.datadoghq.com/api/v2/integration/servicenow/handles/{template_id}
Overview Get a ServiceNow template by ID.
Arguments Path Parameters The ID of the ServiceNow template to retrieve
Response OK
Response containing a single ServiceNow template
Expand All
Data object for a ServiceNow template
Attributes of a ServiceNow template
The ID of the assignment group
The ID of the business service
Custom field mappings for the template
The handle name of the template
The ID of the ServiceNow instance
servicenow_tablename [required ]
The name of the destination ServiceNow table
Unique identifier for the ServiceNow template
Type identifier for ServiceNow template resources
Allowed enum values: servicenow_templates
{
"data" : {
"attributes" : {
"assignment_group_id" : "65b3341b-0680-47f9-a6d4-134db45c603e" ,
"business_service_id" : "65b3341b-0680-47f9-a6d4-134db45c603e" ,
"fields_mapping" : {
"<any-key>" : "string"
},
"handle_name" : "incident-template" ,
"instance_id" : "65b3341b-0680-47f9-a6d4-134db45c603e" ,
"servicenow_tablename" : "incident" ,
"user_id" : "65b3341b-0680-47f9-a6d4-134db45c603e"
},
"id" : "65b3341b-0680-47f9-a6d4-134db45c603e" ,
"type" : "servicenow_templates"
}
} 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"
}
]
} Not Found
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
# Path parameters export template_id = "65b3341b-0680-47f9-a6d4-134db45c603e" # Curl command curl -X GET "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/servicenow/handles/${template_id} " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Get ServiceNow template returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.service_now_integration_api import ServiceNowIntegrationApi
from uuid import UUID
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = ServiceNowIntegrationApi ( api_client )
response = api_instance . get_service_now_template (
template_id = UUID ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ),
)
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"
# Get ServiceNow template returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: ServiceNowIntegrationAPI . new
p api_instance . get_service_now_template ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" )
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"
// Get ServiceNow 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 () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewServiceNowIntegrationApi ( apiClient )
resp , r , err := api . GetServiceNowTemplate ( ctx , uuid . MustParse ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ))
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `ServiceNowIntegrationApi.GetServiceNowTemplate`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `ServiceNowIntegrationApi.GetServiceNowTemplate`:\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"
// Get ServiceNow template returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.ServiceNowIntegrationApi ;
import com.datadog.api.client.v2.model.ServiceNowTemplateResponse ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
ServiceNowIntegrationApi apiInstance = new ServiceNowIntegrationApi ( defaultClient );
try {
ServiceNowTemplateResponse result =
apiInstance . getServiceNowTemplate (
UUID . fromString ( "65b3341b-0680-47f9-a6d4-134db45c603e" ));
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling ServiceNowIntegrationApi#getServiceNowTemplate" );
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"
// Get ServiceNow template returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_service_now_integration ::ServiceNowIntegrationAPI ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = ServiceNowIntegrationAPI ::with_config ( configuration );
let resp = api
. get_service_now_template (
Uuid ::parse_str ( "00000000-0000-0000-0000-000000000000" ). expect ( "invalid UUID" ),
)
. 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
/**
* Get ServiceNow template returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . ServiceNowIntegrationApi ( configuration );
const params : v2.ServiceNowIntegrationApiGetServiceNowTemplateRequest = {
templateId : "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ,
};
apiInstance
. getServiceNowTemplate ( params )
. then (( data : v2.ServiceNowTemplateResponse ) => {
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"