floe-servicenow 0.1.0

data/docs/table.md

@@ -0,0 +1,320 @@
+# Table API Methods
+
+## Table of Contents
+
+| Method | Description |
+|--------|-------------|
+| [List Tables](#list-tables) | List all sys_db_object tables |
+| [Query Records](#query-records) | Retrieve multiple records with filtering |
+| [Get Record](#get-record) | Retrieve a single record by sys_id |
+| [Create Record](#create-record) | Create a new record in a table |
+| [Update Record](#update-record) | Replace all fields of a record (PUT) |
+| [Patch Record](#patch-record) | Update specific fields of a record (PATCH) |
+| [Delete Record](#delete-record) | Delete a record from a table |
+
+## List Tables
+
+Lists all `sys_db_object` tables.
+
+**Resource**: `servicenow://table/list_tables`
+
+**Required Parameters**:
+- `instance_id` (string): ServiceNow instance identifier used to build `https://#{instance_id}.service-now.com`
+
+**Optional Parameters**:
+- `query` (string): Query parameters e.g.: `active=true`
+- `limit` (integer): Maximum number of records to return
+- `offset` (integer): Starting record index for which to begin retrieving records. Use this value to paginate record retrieval.
+- `fields` (string): Comma-separated list of fields to return in the response.
+
+**Example**:
+
+```json
+{
+  "Resource": "servicenow://table/list_tables",
+  "Parameters": {
+    "instance_id": "dev12345",
+    "query": "active=true",
+    "limit": 2
+  }
+}
+```
+
+**Response**:
+
+```json
+{
+  "result": [
+    {
+      "name": "sn_mif_sync_data"
+    },
+    {
+      "name": "open_nlu_predict_log0000"
+    }
+  ]
+}
+```
+
+## Query Records
+
+Retrieve multiple records from a specific table with optional filtering.
+
+**Resource**: `servicenow://table/query_records`
+
+**Required Parameters**:
+- `instance_id` (string): ServiceNow instance identifier
+- `table_name` (string): Name of the table to query (e.g., "incident", "cmdb_ci")
+
+**Optional Parameters**:
+- `query` (string): Encoded query string (e.g., "active=true^priority=1")
+- `limit` (integer): Maximum number of records to return
+- `offset` (integer): Starting record index for pagination
+- `fields` (string): Comma-separated list of fields to return
+- `display_value` (string): Return display values ("true", "false", or "all")
+- `exclude_reference_link` (boolean): Exclude reference links from response
+
+**Example**:
+
+```json
+{
+  "Resource": "servicenow://table/query_records",
+  "Parameters": {
+    "instance_id": "dev12345",
+    "table_name": "incident",
+    "query": "active=true^priority=1",
+    "limit": 10,
+    "fields": "number,short_description,priority"
+  }
+}
+```
+
+**Response**:
+
+```json
+{
+  "result": [
+    {
+      "number": "INC0001",
+      "short_description": "Network connectivity issue",
+      "priority": "1"
+    }
+  ]
+}
+```
+
+## Get Record
+
+Retrieve a single record by its sys_id.
+
+**Resource**: `servicenow://table/get_record`
+
+**Required Parameters**:
+- `instance_id` (string): ServiceNow instance identifier
+- `table_name` (string): Name of the table
+- `sys_id` (string): Unique identifier of the record
+
+**Optional Parameters**:
+- `fields` (string): Comma-separated list of fields to return
+- `display_value` (string): Return display values ("true", "false", or "all")
+- `exclude_reference_link` (boolean): Exclude reference links from response
+
+**Example**:
+
+```json
+{
+  "Resource": "servicenow://table/get_record",
+  "Parameters": {
+    "instance_id": "dev12345",
+    "table_name": "incident",
+    "sys_id": "abc123def456",
+    "fields": "number,short_description,state"
+  }
+}
+```
+
+**Response**:
+
+```json
+{
+  "result": {
+    "number": "INC0001",
+    "short_description": "Network connectivity issue",
+    "state": "2"
+  }
+}
+```
+
+## Create Record
+
+Create a new record in a table.
+
+**Resource**: `servicenow://table/create_record`
+
+**Required Parameters**:
+- `instance_id` (string): ServiceNow instance identifier
+- `table_name` (string): Name of the table
+- `data` (object): Hash of field names and values for the new record
+
+**Optional Parameters**:
+- `display_value` (string): Return display values ("true", "false", or "all")
+- `exclude_reference_link` (boolean): Exclude reference links from response
+- `input_display_value` (boolean): Set field values using display values
+
+**Example**:
+
+```json
+{
+  "Resource": "servicenow://table/create_record",
+  "Parameters": {
+    "instance_id": "dev12345",
+    "table_name": "incident",
+    "data": {
+      "short_description": "New network issue",
+      "urgency": "2",
+      "impact": "2"
+    }
+  }
+}
+```
+
+**Response**:
+
+```json
+{
+  "result": {
+    "sys_id": "xyz789",
+    "number": "INC0010",
+    "short_description": "New network issue",
+    "urgency": "2",
+    "impact": "2"
+  }
+}
+```
+
+## Update Record
+
+Replace all fields of an existing record (PUT operation).
+
+**Resource**: `servicenow://table/update_record`
+
+**Required Parameters**:
+- `instance_id` (string): ServiceNow instance identifier
+- `table_name` (string): Name of the table
+- `sys_id` (string): Unique identifier of the record
+- `data` (object): Hash of field names and values (replaces entire record)
+
+**Optional Parameters**:
+- `display_value` (string): Return display values ("true", "false", or "all")
+- `exclude_reference_link` (boolean): Exclude reference links from response
+- `input_display_value` (boolean): Set field values using display values
+
+**Example**:
+
+```json
+{
+  "Resource": "servicenow://table/update_record",
+  "Parameters": {
+    "instance_id": "dev12345",
+    "table_name": "incident",
+    "sys_id": "abc123def456",
+    "data": {
+      "short_description": "Updated description",
+      "state": "3",
+      "priority": "2"
+    }
+  }
+}
+```
+
+**Response**:
+
+```json
+{
+  "result": {
+    "sys_id": "abc123def456",
+    "number": "INC0001",
+    "short_description": "Updated description",
+    "state": "3",
+    "priority": "2"
+  }
+}
+```
+
+## Patch Record
+
+Update specific fields of an existing record (PATCH operation).
+
+**Resource**: `servicenow://table/patch_record`
+
+**Required Parameters**:
+- `instance_id` (string): ServiceNow instance identifier
+- `table_name` (string): Name of the table
+- `sys_id` (string): Unique identifier of the record
+- `data` (object): Hash of field names and values to update
+
+**Optional Parameters**:
+- `display_value` (string): Return display values ("true", "false", or "all")
+- `exclude_reference_link` (boolean): Exclude reference links from response
+- `input_display_value` (boolean): Set field values using display values
+
+**Example**:
+
+```json
+{
+  "Resource": "servicenow://table/patch_record",
+  "Parameters": {
+    "instance_id": "dev12345",
+    "table_name": "incident",
+    "sys_id": "abc123def456",
+    "data": {
+      "state": "6"
+    }
+  }
+}
+```
+
+**Response**:
+
+```json
+{
+  "result": {
+    "sys_id": "abc123def456",
+    "number": "INC0001",
+    "state": "6"
+  }
+}
+```
+
+## Delete Record
+
+Delete a record from a table.
+
+**Resource**: `servicenow://table/delete_record`
+
+**Required Parameters**:
+- `instance_id` (string): ServiceNow instance identifier
+- `table_name` (string): Name of the table
+- `sys_id` (string): Unique identifier of the record to delete
+
+**Example**:
+
+```json
+{
+  "Resource": "servicenow://table/delete_record",
+  "Parameters": {
+    "instance_id": "dev12345",
+    "table_name": "incident",
+    "sys_id": "abc123def456"
+  }
+}
+```
+
+**Response**:
+
+```json
+{
+  "result": {
+    "success": true
+  }
+}
+```

data/examples/cmdb.asl

@@ -0,0 +1,90 @@
+{
+  "Comment": "ServiceNow CMDB API Examples - Demonstrates Configuration Item management and relationships",
+  "StartAt": "GetCIClasses",
+  "States": {
+    "GetCIClasses": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/get_ci_classes",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "limit": 5
+      },
+      "ResultPath": "$.ci_classes",
+      "Next": "QueryCIs"
+    },
+    "QueryCIs": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/query_cis",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "method": "GET",
+        "table": "cmdb_ci_server",
+        "limit": 1,
+        "fields": "sys_id,name,ip_address,os"
+      },
+      "ResultPath": "$.servers",
+      "Next": "CreateCI"
+    },
+    "CreateCI": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/create_ci",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "table": "cmdb_ci_server",
+        "name": "test-server-workflow",
+        "ip_address": "192.168.100.50",
+        "os": "Ubuntu 22.04",
+        "operational_status": "1"
+      },
+      "ResultPath": "$.new_ci",
+      "Next": "UpdateCI"
+    },
+    "UpdateCI": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/update_ci",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "sys_id.$": "$.new_ci.result.sys_id",
+        "table": "cmdb_ci_server",
+        "ip_address": "192.168.100.51",
+        "comments": "Updated by workflow"
+      },
+      "ResultPath": "$.updated_ci",
+      "Next": "DeleteCI"
+    },
+    "DeleteCI": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/delete_ci",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "sys_id.$": "$.new_ci.result.sys_id",
+        "table": "cmdb_ci_server"
+      },
+      "ResultPath": "$.delete_result",
+      "Next": "Success"
+    },
+    "Success": {
+      "Type": "Succeed"
+    }
+  }
+}

data/examples/create_server_ci.asl

@@ -0,0 +1,43 @@
+{
+  "Comment": "Example workflow to create a Server Configuration Item in ServiceNow CMDB",
+  "StartAt": "CreateServerCi",
+  "States": {
+    "CreateServerCi": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/create_ci",
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "table.$": "$.table",
+        "attributes": {
+          "name.$": "$.name",
+          "sys_class_name.$": "$.table",
+          "owned_by": "System Administrator",
+          "discovery_source": "Manual via IRE"
+        },
+        "outbound_relations": [],
+        "inbound_relations": []
+      },
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "ResultPath": "$.new_server",
+      "Next": "GetServerDetails"
+    },
+    "GetServerDetails": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/get_ci",
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "table.$": "$.table",
+        "sys_id.$": "$.new_server.attributes.sys_id"
+      },
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "ResultPath": "$.server_details",
+      "End": true
+    }
+  }
+}

data/examples/incident.asl

@@ -0,0 +1,53 @@
+{
+  "Comment": "Example create, resolve, and close a ServiceNow Incident",
+  "StartAt": "CreateIncident",
+  "States": {
+    "CreateIncident": {
+      "Type": "Task",
+      "Resource": "servicenow://incident/create_incident",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "short_description": "Test incident created by workflow",
+        "urgency": "3",
+        "impact": "3"
+      },
+      "ResultPath": "$.incident",
+      "Next": "ResolveIncident"
+    },
+    "ResolveIncident": {
+      "Type": "Task",
+      "Resource": "servicenow://incident/resolve_incident",
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "sys_id.$": "$.incident.result.sys_id",
+        "close_notes": "Issue resolved by workflow",
+        "close_code": "Solution provided"
+      },
+      "ResultPath": "$.resolved_incident",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Next": "CloseIncident"
+    },
+    "CloseIncident": {
+      "Type": "Task",
+      "Resource": "servicenow://incident/close_incident",
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "sys_id.$": "$.incident.result.sys_id",
+        "close_notes": "Incident closed by workflow",
+        "close_code": "Solution provided"
+      },
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "End": true
+    }
+  }
+}

data/examples/oauth.asl

@@ -0,0 +1,67 @@
+{
+  "Comment": "Example of OAuth flow (password or refresh_token grant) followed by authenticated API call",
+  "StartAt": "CheckGrantType",
+  "States": {
+    "CheckGrantType": {
+      "Type": "Choice",
+      "Choices": [
+        {
+          "Variable": "$.grant_type",
+          "StringEquals": "password",
+          "Next": "OauthTokenPassword"
+        },
+        {
+          "Variable": "$.grant_type",
+          "StringEquals": "refresh_token",
+          "Next": "OauthTokenRefresh"
+        }
+      ],
+      "Default": "OauthTokenPassword"
+    },
+    "OauthTokenPassword": {
+      "Type": "Task",
+      "Resource": "servicenow://oauth/token",
+      "Credentials": {
+        "client_secret.$": "$$.Credentials.client_secret",
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "client_id.$": "$.client_id",
+        "grant_type": "password"
+      },
+      "ResultPath": "$$.Credentials.oauth_token",
+      "Next": "GetCIClasses"
+    },
+    "OauthTokenRefresh": {
+      "Type": "Task",
+      "Resource": "servicenow://oauth/token",
+      "Credentials": {
+        "client_secret.$": "$$.Credentials.client_secret",
+        "refresh_token.$": "$$.Credentials.refresh_token"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "client_id.$": "$.client_id",
+        "grant_type": "refresh_token",
+        "scope": "useraccount"
+      },
+      "ResultPath": "$$.Credentials.oauth_token",
+      "Next": "GetCIClasses"
+    },
+    "GetCIClasses": {
+      "Type": "Task",
+      "Resource": "servicenow://cmdb/get_ci_classes",
+      "Credentials": {
+        "access_token.$": "$$.Credentials.oauth_token.access_token"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "limit": 5
+      },
+      "ResultPath": "$.ci_classes",
+      "End": true
+    }
+  }
+}

data/examples/service_catalog.asl

@@ -0,0 +1,77 @@
+{
+  "Comment": "ServiceNow Service Catalog API Examples - Demonstrates catalog browsing and item ordering",
+  "StartAt": "GetCatalogs",
+  "States": {
+    "GetCatalogs": {
+      "Type": "Task",
+      "Resource": "servicenow://service_catalog/get_catalogs",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "limit": 5
+      },
+      "ResultPath": "$.catalogs",
+      "Next": "GetCatalogItems"
+    },
+    "GetCatalogItems": {
+      "Type": "Task",
+      "Resource": "servicenow://service_catalog/get_items",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "limit": 10
+      },
+      "ResultPath": "$.catalog_items",
+      "Next": "GetCatalogItem"
+    },
+    "GetCatalogItem": {
+      "Type": "Task",
+      "Resource": "servicenow://service_catalog/get_item",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "item_id.$": "$.catalog_items.result[0].sys_id"
+      },
+      "ResultPath": "$.item_detail",
+      "Next": "SubmitCatalogItem"
+    },
+    "SubmitCatalogItem": {
+      "Type": "Task",
+      "Resource": "servicenow://service_catalog/submit_catalog_item",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "item_sys_id.$": "$.catalog_items.result[0].sys_id",
+        "sysparm_quantity": "1"
+      },
+      "ResultPath": "$.order",
+      "Next": "GetRequest"
+    },
+    "GetRequest": {
+      "Type": "Task",
+      "Resource": "servicenow://service_catalog/get_request",
+      "Credentials": {
+        "username.$": "$$.Credentials.username",
+        "password.$": "$$.Credentials.password"
+      },
+      "Parameters": {
+        "instance_id.$": "$.instance_id",
+        "request_id.$": "$.order.result.request_id"
+      },
+      "ResultPath": "$.request_detail",
+      "End": true
+    }
+  }
+}