ServiceNow Zurich — Table API writes (modeled core)

This reference is readable without JavaScript. Download the OpenAPI document.

Runtime

/api/purple-suite/{instanceId}/contracts/itsm/servicenow

[
  {
    "method": "post",
    "path": "/api/now/table/:tableName",
    "operationId": "post_table_post_now_table_tablename"
  },
  {
    "method": "post",
    "path": "/api/now/:api_version/table/:tableName",
    "operationId": "post_table_post_now_table_tablename__versioned_url"
  },
  {
    "method": "patch",
    "path": "/api/now/table/:tableName/:sys_id",
    "operationId": "patch_table_patch_now_table_tablename_sys_id"
  },
  {
    "method": "patch",
    "path": "/api/now/:api_version/table/:tableName/:sys_id",
    "operationId": "patch_table_patch_now_table_tablename_sys_id__versioned_url"
  },
  {
    "method": "put",
    "path": "/api/now/table/:tableName/:sys_id",
    "operationId": "put_table_put_now_table_tablename_sys_id"
  },
  {
    "method": "put",
    "path": "/api/now/:api_version/table/:tableName/:sys_id",
    "operationId": "put_table_put_now_table_tablename_sys_id__versioned_url"
  },
  {
    "method": "delete",
    "path": "/api/now/table/:tableName/:sys_id",
    "operationId": "delete_table_delete_now_table_tablename_sys_id"
  },
  {
    "method": "delete",
    "path": "/api/now/:api_version/table/:tableName/:sys_id",
    "operationId": "delete_table_delete_now_table_tablename_sys_id__versioned_url"
  }
]

Credentials

HTTP Basic — emulator compatibility: basic
Authorization: Basic base64(user:password). This is ServiceNow's real transport for these routes, declared in the pinned document as an http/basic scheme. PurpleSuite maps the password position to the selected instance key and ignores the username, which authenticates as the synthetic integration identity purple.integration. No vendor-visible header is added.
Credential model: instance-key

Coverage and limitations

{
  "documentScope": "bounded",
  "runtimeFidelity": "modeled",
  "counts": {
    "operations": 8
  },
  "notes": [
    "Four Table API write operations, each mounted at its default and versioned URL. All four are modeled-core, with narrowed table and field schemas; this is not full ServiceNow runtime parity.",
    "POST creates persistent records with generated sys_id and transactional number allocation; PUT/PATCH change supplied fields; DELETE is persistent and deletion-stable. These records share storage with Table GET and Aggregate.",
    "Basic authentication uses the instance key in the vendor password position. No hosted OAuth, business rules, ACL administration, custom fields, or workflow engine is claimed."
  ]
}

Modeled core. See each operation's explicit executable schema and boundaries.

Servers

[
  {
    "url": "/api/purple-suite/{instanceId}/contracts/itsm/servicenow",
    "description": "PurpleSuite instance-scoped ServiceNow emulation"
  }
]

Authentication schemes

{
  "basicAuth": {
    "type": "http",
    "scheme": "basic"
  }
}

Each operation lists its security requirements. An empty security array permits an unauthenticated request. Use the scheme and headers declared for the selected contract.

Operations

POST /api/now/table/{tableName}
POST /api/now/{api_version}/table/{tableName}
PATCH /api/now/table/{tableName}/{sys_id}
PUT /api/now/table/{tableName}/{sys_id}
DELETE /api/now/table/{tableName}/{sys_id}
PATCH /api/now/{api_version}/table/{tableName}/{sys_id}
PUT /api/now/{api_version}/table/{tableName}/{sys_id}
DELETE /api/now/{api_version}/table/{tableName}/{sys_id}

POST /api/now/table/{tableName}

Table - POST /now/table/{tableName}

Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields.

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "post_table_post_now_table_tablename",
  "summary": "Table - POST /now/table/{tableName}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "201": {
      "description": "Record written.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.TableRecordSingle"
          }
        }
      },
      "headers": {
        "Location": {
          "schema": {
            "type": "string",
            "format": "uri"
          },
          "description": "Created record URL."
        }
      }
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}",
  "x-servicenow-default-url": "/api/now/table/{tableName}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "short_description": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "priority": {
              "type": "string"
            },
            "assigned_to": {
              "type": "string"
            },
            "assignment_group": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

POST /api/now/{api_version}/table/{tableName}

Table - POST /now/table/{tableName}

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "post_table_post_now_table_tablename__versioned_url",
  "summary": "Table - POST /now/table/{tableName}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "201": {
      "description": "Record written.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.TableRecordSingle"
          }
        }
      },
      "headers": {
        "Location": {
          "schema": {
            "type": "string",
            "format": "uri"
          },
          "description": "Created record URL."
        }
      }
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "api_version",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "v1",
          "v2"
        ]
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}",
  "x-servicenow-default-url": "/api/now/table/{tableName}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "short_description": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "priority": {
              "type": "string"
            },
            "assigned_to": {
              "type": "string"
            },
            "assignment_group": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

PATCH /api/now/table/{tableName}/{sys_id}

Table - PATCH /now/table/{tableName}/{sys_id}

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "patch_table_patch_now_table_tablename_sys_id",
  "summary": "Table - PATCH /now/table/{tableName}/{sys_id}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "200": {
      "description": "Record written.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.TableRecordSingle"
          }
        }
      }
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "sys_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}/{sys_id}",
  "x-servicenow-default-url": "/api/now/table/{tableName}/{sys_id}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "short_description": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "priority": {
              "type": "string"
            },
            "assigned_to": {
              "type": "string"
            },
            "assignment_group": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

PUT /api/now/table/{tableName}/{sys_id}

Table - PUT /now/table/{tableName}/{sys_id}

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "put_table_put_now_table_tablename_sys_id",
  "summary": "Table - PUT /now/table/{tableName}/{sys_id}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "200": {
      "description": "Record written.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.TableRecordSingle"
          }
        }
      }
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "sys_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}/{sys_id}",
  "x-servicenow-default-url": "/api/now/table/{tableName}/{sys_id}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "short_description": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "priority": {
              "type": "string"
            },
            "assigned_to": {
              "type": "string"
            },
            "assignment_group": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

DELETE /api/now/table/{tableName}/{sys_id}

Table - DELETE /now/table/{tableName}/{sys_id}

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "delete_table_delete_now_table_tablename_sys_id",
  "summary": "Table - DELETE /now/table/{tableName}/{sys_id}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "204": {
      "description": "Record deleted; no response body."
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "sys_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}/{sys_id}",
  "x-servicenow-default-url": "/api/now/table/{tableName}/{sys_id}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields."
}

PATCH /api/now/{api_version}/table/{tableName}/{sys_id}

Table - PATCH /now/table/{tableName}/{sys_id}

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "patch_table_patch_now_table_tablename_sys_id__versioned_url",
  "summary": "Table - PATCH /now/table/{tableName}/{sys_id}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "200": {
      "description": "Record written.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.TableRecordSingle"
          }
        }
      }
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "sys_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "api_version",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "v1",
          "v2"
        ]
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}/{sys_id}",
  "x-servicenow-default-url": "/api/now/table/{tableName}/{sys_id}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "short_description": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "priority": {
              "type": "string"
            },
            "assigned_to": {
              "type": "string"
            },
            "assignment_group": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

PUT /api/now/{api_version}/table/{tableName}/{sys_id}

Table - PUT /now/table/{tableName}/{sys_id}

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "put_table_put_now_table_tablename_sys_id__versioned_url",
  "summary": "Table - PUT /now/table/{tableName}/{sys_id}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "200": {
      "description": "Record written.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.TableRecordSingle"
          }
        }
      }
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "sys_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "api_version",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "v1",
          "v2"
        ]
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}/{sys_id}",
  "x-servicenow-default-url": "/api/now/table/{tableName}/{sys_id}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "short_description": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "priority": {
              "type": "string"
            },
            "assigned_to": {
              "type": "string"
            },
            "assignment_group": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

DELETE /api/now/{api_version}/table/{tableName}/{sys_id}

Table - DELETE /now/table/{tableName}/{sys_id}

Authentication

[
  {
    "basicAuth": []
  }
]

Request, responses and operation details

{
  "operationId": "delete_table_delete_now_table_tablename_sys_id__versioned_url",
  "summary": "Table - DELETE /now/table/{tableName}/{sys_id}",
  "tags": [
    "Table API"
  ],
  "responses": {
    "204": {
      "description": "Record deleted; no response body."
    },
    "400": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "401": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "403": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "404": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "406": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "415": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    },
    "500": {
      "description": "ServiceNow platform error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/purplesuite.PlatformError"
          }
        }
      }
    }
  },
  "x-docs-topic": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html",
  "parameters": [
    {
      "name": "X-no-response-body",
      "in": "header",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      },
      "description": "Suppress the response body after a successful write."
    },
    {
      "name": "tableName",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "incident",
          "change_request",
          "problem"
        ]
      }
    },
    {
      "name": "sys_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "api_version",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "v1",
          "v2"
        ]
      }
    },
    {
      "name": "sysparm_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false",
          "all"
        ]
      }
    },
    {
      "name": "sysparm_fields",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "sysparm_exclude_reference_link",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    },
    {
      "name": "sysparm_input_display_value",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "x-servicenow-versioned-url": "/api/now/{api_version}/table/{tableName}/{sys_id}",
  "x-servicenow-default-url": "/api/now/table/{tableName}/{sys_id}",
  "x-purplesuite-classification": "modeled-core",
  "description": "Executable core for incident, change_request, and problem. Editable fields are explicitly narrowed; arbitrary custom tables, fields, business rules, UI policies, domain separation, and plugins are not replicated. Unsupported writes fail closed. PUT and PATCH update supplied fields; neither deletes omitted fields."
}

Schemas and reusable components

schemas

purplesuite.TableRecord

{
  "type": "object",
  "description": "A table record. Columns depend on the table. Each value is a string when sysparm_display_value is false or true, an object carrying link/value for a reference field, or an object carrying display_value/value when sysparm_display_value=all.",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string"
      },
      {
        "type": "object",
        "properties": {
          "display_value": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "link": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    ]
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html"
}

purplesuite.TableRecordList

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/purplesuite.TableRecord"
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html"
}

purplesuite.TableRecordSingle

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "$ref": "#/components/schemas/purplesuite.TableRecord"
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html"
}

purplesuite.PlatformError

{
  "type": "object",
  "required": [
    "error",
    "status"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "message",
        "detail"
      ],
      "properties": {
        "message": {
          "type": "string",
          "example": "No Record found"
        },
        "detail": {
          "type": "string",
          "example": "Record doesn't exist or ACL restricts the record retrieval"
        }
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "failure"
      ]
    }
  },
  "description": "ServiceNow's platform error envelope. The status codes and their meanings are vendor-documented; the JSON envelope itself is not printed on any reference page and is corroborated from real instance responses. See COVERAGE_LEDGER.md.",
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/reference/r_RESTAPIHTTPResponseCodes.html"
}

purplesuite.AggregateResult

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stats": {
            "type": "object",
            "properties": {
              "count": {
                "type": "string"
              },
              "avg": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              },
              "min": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              },
              "max": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              },
              "sum": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              }
            }
          },
          "groupby_fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "display_value": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AggregateAPI.html"
}

purplesuite.AttachmentMetadata

{
  "type": "object",
  "properties": {
    "sys_id": {
      "type": "string"
    },
    "file_name": {
      "type": "string"
    },
    "table_name": {
      "type": "string"
    },
    "table_sys_id": {
      "type": "string"
    },
    "content_type": {
      "type": "string"
    },
    "size_bytes": {
      "type": "string"
    },
    "size_compressed": {
      "type": "string"
    },
    "compressed": {
      "type": "string"
    },
    "download_link": {
      "type": "string",
      "format": "uri"
    },
    "average_image_color": {
      "type": "string"
    },
    "image_width": {
      "type": "string"
    },
    "image_height": {
      "type": "string"
    },
    "hash": {
      "type": "string"
    },
    "sys_created_on": {
      "type": "string"
    },
    "sys_updated_on": {
      "type": "string"
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html"
}

purplesuite.AttachmentList

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/purplesuite.AttachmentMetadata"
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html"
}

purplesuite.AttachmentSingle

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "$ref": "#/components/schemas/purplesuite.AttachmentMetadata"
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html"
}

purplesuite.CmdbInstance

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "attributes": {
          "$ref": "#/components/schemas/purplesuite.TableRecord"
        },
        "outbound_relations": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/purplesuite.CmdbRelation"
          }
        },
        "inbound_relations": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/purplesuite.CmdbRelation"
          }
        }
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html"
}

purplesuite.CmdbRelation

{
  "type": "object",
  "properties": {
    "sys_id": {
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/purplesuite.CmdbReference"
    },
    "target": {
      "$ref": "#/components/schemas/purplesuite.CmdbReference"
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html"
}

purplesuite.CmdbReference

{
  "type": "object",
  "properties": {
    "display_value": {
      "type": "string"
    },
    "link": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html"
}

purplesuite.CmdbMeta

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "parent": {
          "type": "string"
        },
        "icon": {
          "type": "string"
        },
        "icon_url": {
          "type": "string"
        },
        "is_extendable": {
          "type": "string"
        },
        "children": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "attributes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "element": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "max_length": {
                "type": "string"
              },
              "is_inherited": {
                "type": "string"
              },
              "is_mandatory": {
                "type": "string"
              },
              "is_display": {
                "type": "string"
              },
              "reference": {
                "type": "string"
              },
              "read_only": {
                "type": "string"
              }
            }
          }
        },
        "relationship_rules": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "parent": {
                "type": "string"
              },
              "child": {
                "type": "string"
              },
              "relation_type": {
                "type": "string"
              }
            }
          }
        },
        "identification_rules": {
          "type": "object",
          "properties": {
            "applies_to": {
              "type": "string"
            },
            "identifiers": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "related_rules": {
              "type": "array",
              "items": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-meta-api.html"
}

purplesuite.ImportSetResult

{
  "type": "object",
  "description": "The Import Set API is the one in-scope operation whose envelope is not solely `result`: `import_set` and `staging_table` are siblings of it.",
  "required": [
    "import_set",
    "staging_table",
    "result"
  ],
  "properties": {
    "import_set": {
      "type": "string",
      "example": "ISET0010001"
    },
    "staging_table": {
      "type": "string",
      "example": "imp_user"
    },
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transform_map": {
            "type": "string"
          },
          "table": {
            "type": "string"
          },
          "display_name": {
            "type": "string"
          },
          "display_value": {
            "type": "string"
          },
          "record_link": {
            "type": "string",
            "format": "uri"
          },
          "status": {
            "type": "string"
          },
          "sys_id": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_ImportSetAPI.html"
}

purplesuite.DataClasses

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "parent": {
            "type": "string"
          },
          "sys_id": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/data-classification-api.html"
}

purplesuite.CiLifecycleBoolean

{
  "type": "object",
  "description": "These operations document `result` as a bare boolean, not an object.",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "boolean"
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html"
}

purplesuite.CiLifecycleResult

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "result": {
          "type": "string"
        },
        "operationalState": {
          "type": "string"
        },
        "ciActions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html"
}

purplesuite.ScimListResponse

{
  "type": "object",
  "required": [
    "schemas",
    "totalResults",
    "Resources"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
      ]
    },
    "totalResults": {
      "type": "integer"
    },
    "startIndex": {
      "type": "integer"
    },
    "itemsPerPage": {
      "type": "integer"
    },
    "Resources": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  },
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html"
}

purplesuite.ScimResource

{
  "type": "object",
  "required": [
    "schemas",
    "id"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "id": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "resourceType": {
          "type": "string"
        },
        "created": {
          "type": "string"
        },
        "lastModified": {
          "type": "string"
        },
        "location": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": true,
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html"
}

purplesuite.ScimError

{
  "type": "object",
  "required": [
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "object",
      "properties": {
        "details": {
          "type": "string"
        },
        "schemas": {
          "type": "string"
        },
        "scimType": {
          "type": "string"
        },
        "status": {
          "type": "string"
        }
      }
    }
  },
  "description": "SCIM's error envelope is plural `errors` and has no `status: \"failure\"` sibling. It is not interchangeable with purplesuite.PlatformError.",
  "x-purplesuite-response-source": "https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html"
}

securitySchemes

basicAuth

{
  "type": "http",
  "scheme": "basic"
}

Document metadata and extensions

{
  "openapi": "3.0.3",
  "info": {
    "title": "ServiceNow Zurich Table API writes",
    "version": "zurich",
    "description": "Modeled core. See each operation's explicit executable schema and boundaries."
  },
  "security": [
    {
      "basicAuth": []
    }
  ]
}