Manage ITSM Connection Metadata

1. Get a list of Supported ITSM Connection Types

This GET method retrieves a list of all supported ITSM connections types.

Request Example

curl --location -g --request GET '{{url}}/api/itsm-manager/connection-templates/supported-types'
--header 'Authorization: TOKEN {{token}}'

Response Example 

[  
   "servicenow", 
   "jira" 
]

2. Get a list of ITSM Connection Metadata for all Supported Types

This GET method retrieves a list of ITSM connection metadata for all supported types.

Request Example

curl --location -g --request GET '{{url}}/api/itsm-manager/connection-templates'
--header 'Authorization: TOKEN {{token}}'

Response Example 

[ {
  "type" : "jira",
  "supportedAuthTypes" : [ {
    "name" : "apiTokenAuth",
    "displayName" : "API Token",
    "isDefault" : true,
    "connAttributes" : [ {
      "name" : "loginUrl",
      "displayName" : "Login URL",
      "description" : "Login URL of JIRA Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : false
    }, {
      "name" : "username",
      "displayName" : "Username",
      "description" : "Username of JIRA Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : false
    }, {
      "name" : "apiToken",
      "displayName" : "API Token",
      "description" : "API Token of JIRA Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : true
    } ]
  } ],
  "supportedTicketTypes" : [ {
    "name" : "issue",
    "displayName" : "Issue",
    "defaultFilter" : {
      "jql" : "assignee = \"{email}\""
    }
  } ]
}, {
  "type" : "servicenow",
  "supportedAuthTypes" : [ {
    "name" : "apiKeyAuth",
    "displayName" : "API Key",
    "isDefault" : true,
    "connAttributes" : [ {
      "name" : "loginUrl",
      "displayName" : "Login URL",
      "description" : "Login URL of ServiceNow Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : false
    }, {
      "name" : "apiKey",
      "displayName" : "API Key",
      "description" : "API Key of ServiceNow Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : true
    } ]
  }, {
    "name" : "basicAuth",
    "displayName" : "Basic Authentication",
    "isDefault" : false,
    "connAttributes" : [ {
      "name" : "loginUrl",
      "displayName" : "Login URL",
      "description" : "Login URL of ServiceNow Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : false
    }, {
      "name" : "username",
      "displayName" : "Username",
      "description" : "Username of ServiceNow Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : false
    }, {
      "name" : "password",
      "displayName" : "Password",
      "description" : "Password of ServiceNow Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : true
    } ]
  } ],
  "supportedTicketTypes" : [ {
    "name" : "incident",
    "displayName" : "Incident",
    "defaultFilter" : {
      "sysparm_query" : "assigned_to.email={email}"
    }
  }, {
    "name" : "change_request",
    "displayName" : "Change Request",
    "defaultFilter" : {
      "sysparm_query" : "assigned_to.email={email}"
    }
  } ]
} ]

3. Get an ITSM Connection Metadata for a Supported Type

This GET method retrieves ITSM connection metadata for a supported type.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location -g --request GET '{{url}}/api/itsm-manager/connection-templates/{type}'
--header 'Authorization: TOKEN {{token}}'

Response Example 

{
  "type" : "jira",
  "supportedAuthTypes" : [ {
    "name" : "apiTokenAuth",
    "displayName" : "API Token",
    "isDefault" : true,
    "connAttributes" : [ {
      "name" : "loginUrl",
      "displayName" : "Login URL",
      "description" : "Login URL of JIRA Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : false
    }, {
      "name" : "username",
      "displayName" : "Username",
      "description" : "Username of JIRA Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : false
    }, {
      "name" : "apiToken",
      "displayName" : "API Token",
      "description" : "API Token of JIRA Account",
      "dataType" : "string",
      "isRequired" : true,
      "privy" : true
    } ]
  } ],
  "supportedTicketTypes" : [ {
    "name" : "issue",
    "displayName" : "Issue",
    "defaultFilter" : {
      "jql" : "assignee = \"{email}\""
    }
  } ]
}