ServiceNow · JSON Structure

Trouble Ticket Trouble Ticket Create Structure

Type: object Properties: 9 Required: 3
AutomationCloud ServicesDigital WorkflowsEnterprise PlatformITSMProcessesT1Workflow-AutomationWorkflows

TroubleTicketCreate is a JSON Structure definition published by ServiceNow, describing 9 properties, of which 3 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

name description severity status ticketType channel note relatedEntity relatedParty

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "name": "TroubleTicketCreate",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the trouble ticket, typically a short description of the issue"
    },
    "description": {
      "type": "string",
      "description": "A description of the issue"
    },
    "severity": {
      "type": "string",
      "description": "The severity of the issue (must provide choice value only):\n- 1: Critical\n- 2: High\n- 3: Moderate\n- 4: Low\n- 5: Planning (Incident only)\n",
      "enum": [
        "1",
        "2",
        "3",
        "4",
        "5"
      ]
    },
    "status": {
      "type": "string",
      "description": "The current status of the trouble ticket (can provide choice label or value)"
    },
    "ticketType": {
      "type": "string",
      "description": "The type of ticket to create",
      "enum": [
        "Case",
        "Incident",
        "Service Problem Case"
      ]
    },
    "channel": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the contact method (can provide choice label or value, e.g., 'Virtual Agent' or 'virtual_agent')"
        }
      }
    },
    "note": {
      "type": "array",
      "description": "List of work notes and comments to add to the ticket",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "Note text"
          },
          "@type": {
            "type": "string",
            "description": "Type of note (determines whether recorded in Work notes or Additional comments field)",
            "enum": [
              "comments",
              "work_notes"
            ]
          }
        },
        "required": [
          "text",
          "@type"
        ]
      }
    },
    "relatedEntity": {
      "type": "array",
      "description": "List of impacted assets, products, sold products, configuration items, or services",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Sys_id of the impacted item or service"
          },
          "@referredType": {
            "type": "string",
            "description": "Type of item or service",
            "enum": [
              "asset",
              "product",
              "product_inventory",
              "cmdb_ci",
              "cmdb_ci_service"
            ]
          }
        },
        "required": [
          "id",
          "@referredType"
        ]
      }
    },
    "relatedParty": {
      "type": "array",
      "description": "Details about contacts for the ticket",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Sys_id of the related party"
          },
          "@referredType": {
            "type": "string",
            "description": "Type of related party:\n- customer: Company or account for the ticket\n- customer_contact: Caller or contact for the ticket\n",
            "enum": [
              "customer",
              "customer_contact"
            ]
          }
        },
        "required": [
          "id",
          "@referredType"
        ]
      }
    }
  },
  "required": [
    "description",
    "severity",
    "status"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/trouble-ticket-trouble-ticket-create-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.