Skip to main content

Technical Support Ticket Details

apiVersionstring
Example: v1
data object
attrs object[]
  • Array [
    • namestring

    Name of the attribute.

    Example: ticketType
    displayNamestring

    Recommended name if you are exposing this attribute in your own application.

    Example: Ticket Type
    descriptionstring

    Description of the attribute.

    Example: Applicable ticket type from ticket catalog
    criteria object
    dataTypestring

    Data type of the attribute.

    Example: string
    isRequiredboolean

    Specifies if the attribute is required.

    Example: true
    anyRequiredstring[]
    valuestring

    If a value is specified for this attribute, it will be defined and populated here. Value is returned for ticketType and nodeId, otherwise you will see options.

    Example: Technical Support
    options object[]
  • Array [
    • valuestring
    Example: Hard Down
    defaultValueboolean
    Example: false
    allowedForControllingFieldsstring[]
  • ]
  • ]
    • contacts object[]
  • Array [
    • attrs object[]
  • Array [
    • namestring
    Example: contactType
    displayNamestring
    Example: Contact Type
    descriptionstring
    Example: Indicator of what this contact should be reached out for (Technical or Primary)
    criteria object
    dataTypestring
    Example: string
    isRequiredboolean
    Example: true
    anyRequiredstring[]
    options object[]
  • Array [
    • valuestring
    Example: Primary
    defaultValueboolean
    Example: false
    allowedForControllingFieldsstring[]
  • ]
  • ]
    • minCountinteger
    Example: 1
    maxCountinteger
    Example: 20
  • ]
    • troubleshooting object
    attrs object[]
  • Array [
    • namestring
    Example: circuitPassTraffic
    displayNamestring
    Example: Circuit Passing Traffic
    descriptionstring
    Example: Has this circuit passed traffice before?
    criteria object
    dataTypestring
    Example: boolean
    isRequiredboolean
    Example: false
    anyRequiredstring[]
  • ]
    • isRequiredboolean
    Example: false
    Technical Support Ticket Details
    {
      "apiVersion": "v1",
      "data": {
        "attrs": [
          {
            "name": "ticketType",
            "displayName": "Ticket Type",
            "description": "Applicable ticket type from ticket catalog",
            "criteria": {
              "dataType": "string",
              "isRequired": true,
              "anyRequired": [
                "componentId, serviceId"
              ]
            },
            "value": "Technical Support",
            "options": [
              {
                "value": "Hard Down",
                "defaultValue": false,
                "allowedForControllingFields": [
                  "string"
                ]
              }
            ]
          }
        ],
        "contacts": [
          {
            "attrs": [
              {
                "name": "contactType",
                "displayName": "Contact Type",
                "description": "Indicator of what this contact should be reached out for (Technical or Primary)",
                "criteria": {
                  "dataType": "string",
                  "isRequired": true,
                  "anyRequired": [
                    "string"
                  ]
                },
                "options": [
                  {
                    "value": "Primary",
                    "defaultValue": false,
                    "allowedForControllingFields": [
                      "string"
                    ]
                  }
                ]
              }
            ],
            "minCount": 1,
            "maxCount": 20
          }
        ],
        "troubleshooting": {
          "attrs": [
            {
              "name": "circuitPassTraffic",
              "displayName": "Circuit Passing Traffic",
              "description": "Has this circuit passed traffice before?",
              "criteria": {
                "dataType": "boolean",
                "isRequired": false,
                "anyRequired": [
                  "string"
                ]
              }
            }
          ],
          "isRequired": false
        }
      }
    }