Manage ITSM Connection Metadata
    • PDF

    Manage ITSM Connection Metadata

    • PDF

    Article summary

    1. Get a list of Supported ITSM Connections

    This GET method retrieves a list of supported ITSM connections.

    GET{{url}}/api/itsm-manager/connection-templates/supported-types

    Request Example

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

    Response Example 

    Status: 200 OK
    [  "string"
    ]

    2. Get a list of ITSM Connection Metadata

    This GET method retrieves a list of ITSM connection metadata.

    GET{{url}}/api/itsm-manager/connection-templates

    Request Example

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

    Response Example 

    Status: 200 OK
    [
      {
        "type": "string",
        "supportedAuthTypes": [
          {
            "name": "string",
            "displayName": "string",
            "isDefault": true,
            "connAttributes": [
              {
                "name": "string",
                "displayName": "string",
                "description": "string",
                "dataType": "string",
                "isRequired": true,
                "privy": true
              }
            ]
          }
        ],
        "supportedTicketTypes": [
          {
            "name": "string",
            "displayName": "string",
            "defaultFilter": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            }
          }
        ]
      }
    ]

    3. Get an ITSM Connection Metadata

    This GET method retrieves ITSM connection metadata.

    GET{{url}}/api/itsm-manager/connection-templates/{type}

    Request Parameters

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

    ParameterDescriptionData TypeRequired
    typeType of an ITSM connection templateStringMandatory

    Request Example

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

    Response Example 

     "type": "string",  "supportedAuthTypes": [    {      "name": "string",      "displayName": "string",      "isDefault": true,      "connAttributes": [        {          "name": "string",          "displayName": "string",          "description": "string",          "dataType": "string",          "isRequired": true,          "privy": true        }      ]    }  ],  "supportedTicketTypes": [    {      "name": "string",      "displayName": "string",      "defaultFilter": {        "additionalProp1": "string",        "additionalProp2": "string",        "additionalProp3": "string"      }    }  ]
    }

    Status: 200 OK

    Was this article helpful?