Develop > Developer Reference > Using APIs > Universal CMDB REST API > Reference > Get Protocol

Get Protocol

This call returns JSON data about a single protocol definition. It is used for UI design.

URL

/probesetup/protocols/{protocolname}

Method

GET

URL Parameters

Required:

protocolname = [String]

Data Parameters

None

Success response

Status: 200

Response: 

{
  "name": "[attribute name]",
  "displayName": "[attribute display name]",
  "superClass": "[attribute super class]",
  "allAttributes": [
    {
      "name": "[attribute name]",
      "displayName": "[attribute display name]",
      "type": "[attribute type]",
      "qualifiers": []
    },
    {
      "name": "[attribute name]",
      "displayName": "[attribute display name]",
      "type": "[attribute type]",
      "qualifiers": [
        {
          "name": "HIDDEN_ATTRIBUTE|STATIC_ATTRIBUTE|DASH_ATTRIBUTE|…",
          "properties": []
        }
      ]
    },
    …
    {
      "name": "[attribute name]",
      "displayName": "[attribute display name]",
      "type": "[attribute type]",
      "qualifiers": []
    }
  ]
}

Note The …(three dots) denotes that there can be more values.

Error response

Status: 400 (Bad Request)

Content: Syntax/data provided in is not valid for the request

Status: 401 (Unauthorized)

Content: User not authorized or invalid session token

Status: 403 (Forbidden)

Content: Operation is not allowed (for any user)

Status: 404 (Not Found)

Content: The URI points to a non-existent resource/collection

Status: 405 (Method Not Allowed)

Content: The HTTP method is not allowed for the resource

Status: 406 (Not Acceptable)

Content: Media-type specified in the Accept header is not supported

Send Help Center feedback