@pipedream/servicenow 0.6.0 → 0.8.0

package/README.md

@@ -31,13 +31,14 @@ First, sign into your [ServiceNow Developer Portal](https://developer.servicenow
 ### Create the OAuth Validator app
 
 1. Copy the client ID and secret from the `Pipedream` app you created above.
-2. Name this app `Pipedream OAuth Validator` and add the previously copied client ID and secret. 
-3. Set the grant type to **Authorization Code** and the **Token URL** to `oauth_token.do`.
-4. Use the same **Redirect URL** as before.
+2. Go back to the **System OAuth > Application Registry > New** and select **Connect to an OAuth Provider (simplified)**
+3. Name this app `Pipedream OAuth Validator` and add the previously copied client ID and secret. 
+4. Set the grant type to **Authorization Code** and the **Token URL** to `oauth_token.do`.
+5. Use the same **Redirect URL** as before.
 
-5. Visit [Pipedream's account page](https://pipedream.com/accounts), and click **Click Here to Connect An App**. Search for **ServiceNow** and select it. Enter the client ID, client secret, and your instance name (e.g., `dev98042` from `https://dev98042.service-now.com/`).
+6. Visit [Pipedream's account page](https://pipedream.com/accounts), and click **Click Here to Connect An App**. Search for **ServiceNow** and select it. Enter the client ID, client secret, and your instance name (e.g., `dev98042` from `https://dev98042.service-now.com/`).
 
-6. Press **Connect**. A new window will prompt you to login to your ServiceNow instance, authorizing Pipedream's access to the ServiceNow REST API.
+7. Press **Connect**. A new window will prompt you to login to your ServiceNow instance, authorizing Pipedream's access to the ServiceNow REST API.
 
 ## ServiceNow Authorization Reference
 

package/actions/create-table-record/create-table-record.mjs

@@ -1,123 +1,77 @@
-// legacy_hash_id: a_k6irW7
-import { axios } from "@pipedream/platform";
+import servicenow from "../../servicenow.app.mjs";
+import { parseObject } from "../../common/utils.mjs";
 
 export default {
   key: "servicenow-create-table-record",
   name: "Create Table Record",
-  description: "Inserts one record in the specified table.",
-  version: "0.1.1",
+  description: "Inserts one record in the specified table. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html#title_table-POST)",
+  version: "1.0.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
-    servicenow: {
-      type: "app",
-      app: "servicenow",
-    },
-    table_name: {
-      type: "string",
-      description: "The name of the table where the record will be created.",
+    servicenow,
+    table: {
+      propDefinition: [
+        servicenow,
+        "table",
+      ],
     },
-    table_record: {
+    recordData: {
+      label: "Record Data",
       type: "object",
-      description: "The table record object. Use name-value pairs for each field of the record.",
+      description: "The data to create the record with, as key-value pairs (e.g. `{ \"name\": \"John Doe\", \"email\": \"john.doe@example.com\" }`)",
     },
-    api_version: {
-      type: "string",
-      description: "API version number. Version numbers identify the endpoint version that a URI accesses. By specifying a version number in your URIs, you can ensure that future updates to the REST API do not negatively impact your integration. Use `lastest` to use the latest REST endpoint for your instance version.",
-      optional: true,
-      options: [
-        "lastest",
-        "v1",
-        "v2",
+    responseDataFormat: {
+      propDefinition: [
+        servicenow,
+        "responseDataFormat",
       ],
     },
-    request_format: {
-      type: "string",
-      description: "Format of REST request body",
-      optional: true,
-      options: [
-        "application/json",
-        "application/xml",
+    excludeReferenceLinks: {
+      propDefinition: [
+        servicenow,
+        "excludeReferenceLinks",
       ],
     },
-    response_format: {
-      type: "string",
-      description: "Format of REST response body.",
-      optional: true,
-      options: [
-        "application/json",
-        "application/xml",
+    responseFields: {
+      propDefinition: [
+        servicenow,
+        "responseFields",
       ],
     },
-    x_no_response_body: {
-      type: "boolean",
-      description: "By default, responses include body content detailing the modified record. Set this request header to true to suppress the response body.",
-      optional: true,
-    },
-    sysparm_display_value: {
-      type: "string",
-      description: "Return field display values (true), actual values (false), or both (all) (default: false).",
-      optional: true,
-      options: [
-        "true",
-        "false",
-        "all",
+    inputDisplayValue: {
+      propDefinition: [
+        servicenow,
+        "inputDisplayValue",
       ],
     },
-    sysparm_exclude_reference_link: {
-      type: "boolean",
-      description: "Flag that indicates whether to exclude Table API links for reference fields.\n* `true`: Exclude Table API links for reference fields.\n* `false`: Include Table API links for reference fields.",
-      optional: true,
-    },
-    sysparm_fields: {
-      type: "string",
-      description: "A comma-separated list of fields to return in the response.",
-      optional: true,
-    },
-    sysparm_input_display_value: {
-      type: "boolean",
-      description: "Flag that indicates whether to set field values using the display value or the actual value.\n* `true`: Treats input values as display values and they are manipulated so they can be stored properly in the database.\n* `false`: Treats input values as actual values and stored them in the database without manipulation.",
-      optional: true,
-    },
-    sysparm_view: {
-      type: "string",
-      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
-      optional: true,
-      options: [
-        "desktop",
-        "mobile",
-        "both",
+    responseView: {
+      propDefinition: [
+        servicenow,
+        "responseView",
       ],
     },
   },
   async run({ $ }) {
-  // See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#table-POST
-
-    if (!this.table_name || !this.table_record) {
-      throw new Error("Must provide table_name, and table_record parameters.");
-    }
-
-    var apiVersion = "";
-    if (this.api_version == "v1" || this.api_version == "v2") {
-      apiVersion = this.api_version + "/";
-    }
-
-    return await axios($, {
-      method: "post",
-      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}`,
-      headers: {
-        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
-        "Accept": this.request_format || "application/json",
-        "Content-Type": this.response_format || "application/json",
-        "X-no-response-body": this.x_no_response_body,
-      },
+    const response = await this.servicenow.createTableRecord({
+      $,
+      table: this.table,
+      data: parseObject(this.recordData),
       params: {
-        sysparm_display_value: this.sysparm_display_value,
-        sysparm_exclude_reference_link: this.sysparm_exclude_reference_link,
-        sysparm_fields: this.sysparm_fields,
-        sysparm_input_display_value: this.sysparm_input_display_value,
-        sysparm_view: this.sysparm_view,
+        sysparm_display_value: this.responseDataFormat,
+        sysparm_exclude_reference_link: this.excludeReferenceLinks,
+        sysparm_fields: this.responseFields?.join?.() || this.responseFields,
+        sysparm_input_display_value: this.inputDisplayValue,
+        sysparm_view: this.responseView,
       },
-      data: this.table_record,
     });
+
+    $.export("$summary", `Successfully created record in table "${this.table}"`);
+
+    return response;
   },
 };

package/actions/delete-table-record/delete-table-record.mjs

@@ -0,0 +1,53 @@
+import servicenow from "../../servicenow.app.mjs";
+
+export default {
+  key: "servicenow-delete-table-record",
+  name: "Delete Table Record",
+  description: "Deletes the specified record from a table. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html#title_table-DELETE)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    servicenow,
+    table: {
+      propDefinition: [
+        servicenow,
+        "table",
+      ],
+    },
+    recordId: {
+      propDefinition: [
+        servicenow,
+        "recordId",
+      ],
+    },
+    queryNoDomain: {
+      propDefinition: [
+        servicenow,
+        "queryNoDomain",
+      ],
+    },
+  },
+  async run({ $ }) {
+    await this.servicenow.deleteTableRecord({
+      $,
+      table: this.table,
+      recordId: this.recordId,
+      params: {
+        sysparm_query_no_domain: this.queryNoDomain,
+      },
+    });
+
+    $.export("$summary", `Successfully deleted record ${this.recordId} from table "${this.table}"`);
+
+    return {
+      success: true,
+      recordId: this.recordId,
+      table: this.table,
+    };
+  },
+};

package/actions/get-record-counts-by-field/get-record-counts-by-field.mjs

@@ -0,0 +1,133 @@
+import { ConfigurationError } from "@pipedream/platform";
+import servicenow from "../../servicenow.app.mjs";
+
+export default {
+  key: "servicenow-get-record-counts-by-field",
+  name: "Get Record Counts by Field",
+  description: "Retrieves the count of records grouped by a specified field from a ServiceNow table. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    servicenow,
+    table: {
+      propDefinition: [
+        servicenow,
+        "table",
+      ],
+    },
+    groupByField: {
+      type: "string",
+      label: "Group By Field",
+      description: "The field to group records by (e.g., `priority`, `state`, `category`)",
+    },
+    count: {
+      type: "boolean",
+      label: "Count",
+      description: "If true, returns the number of records returned by the query",
+      optional: true,
+      default: true,
+    },
+    query: {
+      label: "Query",
+      type: "string",
+      description: "An [encoded query string](https://www.servicenow.com/docs/bundle/zurich-platform-user-interface/page/use/using-lists/concept/c_EncodedQueryStrings.html) to filter records before aggregation (e.g., `active=true^priority=1`)",
+      optional: true,
+    },
+    aggregateInfo: {
+      type: "alert",
+      alertType: "info",
+      content: "You must provide at least one Aggregate Field. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats) for more information.",
+    },
+    avgFields: {
+      type: "string[]",
+      label: "Average Aggregate Fields",
+      description: "Numeric fields to calculate averages for (e.g., `reassignment_count`, `reopen_count`)",
+      optional: true,
+    },
+    minFields: {
+      type: "string[]",
+      label: "Minimum Aggregate Fields",
+      description: "Numeric fields to find minimum values for",
+      optional: true,
+    },
+    maxFields: {
+      type: "string[]",
+      label: "Maximum Aggregate Fields",
+      description: "Numeric fields to find maximum values for",
+      optional: true,
+    },
+    sumFields: {
+      type: "string[]",
+      label: "Sum Aggregate Fields",
+      description: "Numeric fields to calculate sums for",
+      optional: true,
+    },
+    havingQuery: {
+      type: "string",
+      label: "Having Query",
+      description: "Filter the aggregated results (e.g., `COUNT>10` to only show groups with more than 10 records)",
+      optional: true,
+    },
+    responseDataFormat: {
+      propDefinition: [
+        servicenow,
+        "responseDataFormat",
+      ],
+    },
+    orderBy: {
+      type: "string",
+      label: "Order By",
+      description: "Field to sort results by. Prefix with `^ORDER_BY` for ascending or `^ORDER_BYDESC` for descending (e.g., `^ORDER_BYDESC` + field name)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const params = {
+      sysparm_count: this.count,
+      sysparm_query: this.query,
+      sysparm_group_by: this.groupByField,
+      sysparm_display_value: this.responseDataFormat,
+      sysparm_having: this.havingQuery,
+      sysparm_order_by: this.orderBy,
+    };
+
+    let hasAggregateFields = false;
+
+    // Add aggregate functions for each field type
+    if (this.avgFields?.length) {
+      params.sysparm_avg_fields = this.avgFields.join?.() || this.avgFields;
+      hasAggregateFields = true;
+    }
+    if (this.minFields?.length) {
+      params.sysparm_min_fields = this.minFields.join?.() || this.minFields;
+      hasAggregateFields = true;
+    }
+    if (this.maxFields?.length) {
+      params.sysparm_max_fields = this.maxFields.join?.() || this.maxFields;
+      hasAggregateFields = true;
+    }
+    if (this.sumFields?.length) {
+      params.sysparm_sum_fields = this.sumFields.join?.() || this.sumFields;
+      hasAggregateFields = true;
+    }
+
+    if (!hasAggregateFields) {
+      throw new ConfigurationError("You must provide at least one Aggregate Field. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_AggregateAPI.html#title_aggregate-GET-stats) for more information.");
+    }
+
+    const response = await this.servicenow.getRecordCountsByField({
+      $,
+      table: this.table,
+      params,
+    });
+
+    $.export("$summary", `Successfully retrieved ${response?.length || 0} records grouped by field "${this.groupByField}"`);
+
+    return response;
+  },
+};

package/actions/get-table-record-by-id/get-table-record-by-id.mjs

@@ -0,0 +1,77 @@
+import servicenow from "../../servicenow.app.mjs";
+
+export default {
+  key: "servicenow-get-table-record-by-id",
+  name: "Get Table Record by ID",
+  description: "Retrieves a single record from a table by its ID. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html#title_table-GET-id)",
+  version: "1.0.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    servicenow,
+    table: {
+      propDefinition: [
+        servicenow,
+        "table",
+      ],
+    },
+    recordId: {
+      propDefinition: [
+        servicenow,
+        "recordId",
+      ],
+    },
+    responseDataFormat: {
+      propDefinition: [
+        servicenow,
+        "responseDataFormat",
+      ],
+    },
+    excludeReferenceLinks: {
+      propDefinition: [
+        servicenow,
+        "excludeReferenceLinks",
+      ],
+    },
+    responseFields: {
+      propDefinition: [
+        servicenow,
+        "responseFields",
+      ],
+    },
+    responseView: {
+      propDefinition: [
+        servicenow,
+        "responseView",
+      ],
+    },
+    queryNoDomain: {
+      propDefinition: [
+        servicenow,
+        "queryNoDomain",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.servicenow.getTableRecordById({
+      $,
+      table: this.table,
+      recordId: this.recordId,
+      params: {
+        sysparm_display_value: this.responseDataFormat,
+        sysparm_exclude_reference_link: this.excludeReferenceLinks,
+        sysparm_fields: this.responseFields?.join?.() || this.responseFields,
+        sysparm_view: this.responseView,
+        sysparm_query_no_domain: this.queryNoDomain,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved record ${this.recordId} from table "${this.table}"`);
+
+    return response;
+  },
+};

package/actions/get-table-records/get-table-records.mjs

@@ -1,137 +1,135 @@
-// legacy_hash_id: a_wdid84
-import { axios } from "@pipedream/platform";
+import { ConfigurationError } from "@pipedream/platform";
+import servicenow from "../../servicenow.app.mjs";
 
 export default {
   key: "servicenow-get-table-records",
   name: "Get Table Records",
-  description: "Retrieves multiple records for the specified table.",
-  version: "0.3.1",
+  description: "Retrieves multiple records for the specified table. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html#title_table-GET)",
+  version: "1.0.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
-    servicenow: {
-      type: "app",
-      app: "servicenow",
-    },
-    table_name: {
-      type: "string",
-      description: "The name of the table containing the records to retrieve.",
-    },
-    api_version: {
-      type: "string",
-      description: "API version number. Version numbers identify the endpoint version that a URI accesses. By specifying a version number in your URIs, you can ensure that future updates to the REST API do not negatively impact your integration. Use `lastest` to use the latest REST endpoint for your instance version.",
-      optional: true,
-      options: [
-        "lastest",
-        "v1",
-        "v2",
+    servicenow,
+    table: {
+      propDefinition: [
+        servicenow,
+        "table",
       ],
     },
-    request_format: {
-      type: "string",
-      description: "Format of REST request body",
-      optional: true,
-      options: [
-        "application/json",
-        "application/xml",
-        "text/xml",
-      ],
+    filterInfo: {
+      type: "alert",
+      alertType: "info",
+      content: "You must provide either a `Query` or at least one `Filter` prop. ",
     },
-    response_format: {
+    query: {
+      label: "Query",
       type: "string",
-      description: "Format of REST response body.",
+      description: "An [encoded query string](https://www.servicenow.com/docs/bundle/zurich-platform-user-interface/page/use/using-lists/concept/c_EncodedQueryStrings.html) to filter records by (e.g., `active=true^priority=1`). This overrides any other filters set.",
       optional: true,
-      options: [
-        "application/json",
-        "application/xml",
-        "text/xml",
-      ],
     },
-    sysparm_query: {
+    filterCreatedAtDate: {
       type: "string",
+      label: "Filter by Date Created",
+      description: "Return records created only after the given date, in the format `YYYY-MM-DD HH:MM:SS` (e.g. `2026-01-01 00:00:00`).",
       optional: true,
     },
-    sysparm_display_value: {
+    filterUpdatedAtDate: {
       type: "string",
-      description: "Return field display values (true), actual values (false), or both (all) (default: false).",
+      label: "Filter by Date Updated",
+      description: "Return records updated only after the given date, in the format `YYYY-MM-DD HH:MM:SS` (e.g. `2026-01-01 00:00:00`).",
       optional: true,
-      options: [
-        "true",
-        "false",
-        "all",
-      ],
     },
-    sysparm_exclude_reference_link: {
+    filterActive: {
       type: "boolean",
-      description: "True to exclude Table API links for reference fields (default: false).",
+      label: "Filter by Active",
+      description: "If set to `true`, only return records that are active. If set to `false`, only return records that are inactive. May not be available for all tables.",
       optional: true,
     },
-    sysparm_suppress_pagination_header: {
-      type: "boolean",
-      description: "True to supress pagination header (default: false).",
-      optional: true,
-    },
-    sysparm_fields: {
-      type: "string",
-      description: "A comma-separated list of fields to return in the response.",
-      optional: true,
+    responseDataFormat: {
+      propDefinition: [
+        servicenow,
+        "responseDataFormat",
+      ],
     },
-    sysparm_limit: {
-      type: "string",
-      description: "The maximum number of results returned per page (default: 10,000).",
-      optional: true,
+    excludeReferenceLinks: {
+      propDefinition: [
+        servicenow,
+        "excludeReferenceLinks",
+      ],
     },
-    sysparm_view: {
-      type: "string",
-      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
-      optional: true,
+    responseFields: {
+      propDefinition: [
+        servicenow,
+        "responseFields",
+      ],
     },
-    sysparm_query_category: {
-      type: "string",
-      description: "Name of the query category (read replica category) to use for queries.",
+    limit: {
+      type: "integer",
+      label: "Limit",
+      description: "The maximum number of results to return",
+      min: 1,
+      default: 10000,
       optional: true,
     },
-    sysparm_query_no_domain: {
-      type: "boolean",
-      description: "True to access data across domains if authorized (default: false).",
-      optional: true,
+    responseView: {
+      propDefinition: [
+        servicenow,
+        "responseView",
+      ],
     },
-    sysparm_no_count: {
-      type: "boolean",
-      description: "Do not execute a select count(*) on table (default: false).",
-      optional: true,
+    queryNoDomain: {
+      propDefinition: [
+        servicenow,
+        "queryNoDomain",
+      ],
     },
   },
   async run({ $ }) {
-  // See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#table-GET-id                    */
+    let query = this.query;
 
-    if (!this.table_name) {
-      throw new Error("Must provide table_name parameter.");
-    }
+    // If no query is provided, build one from the filters
+    if (!query) {
+      const filters = [];
+
+      if (this.filterCreatedAtDate) {
+        filters.push(`sys_created_on>=${this.filterCreatedAtDate}`);
+      }
+
+      if (this.filterUpdatedAtDate) {
+        filters.push(`sys_updated_on>=${this.filterUpdatedAtDate}`);
+      }
+
+      if (this.filterActive !== undefined) {
+        filters.push(`active=${this.filterActive}`);
+      }
 
-    var apiVersion = "";
-    if (this.api_version == "v1" || this.api_version == "v2") {
-      apiVersion = this.api_version + "/";
+      if (!filters.length) {
+        throw new ConfigurationError("You must provide either a `Query` or at least one `Filter` prop.");
+      }
+
+      query = filters.join("^");
     }
 
-    return await axios($, {
-      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}`,
-      headers: {
-        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
-        "Accept": this.request_format || "application/json",
-        "Content-Type": this.response_format || "application/json",
-      },
+    const response = await this.servicenow.getTableRecords({
+      $,
+      table: this.table,
       params: {
-        sysparm_query: this.sysparm_query,
-        sysparm_display_value: this.sysparm_display_value,
-        sysparm_exclude_reference_link: this.sysparm_exclude_reference_link,
-        sysparm_suppress_pagination_header: this.sysparm_suppress_pagination_header,
-        sysparm_fields: this.sysparm_fields,
-        sysparm_limit: this.sysparm_limit,
-        sysparm_view: this.sysparm_view,
-        sysparm_query_category: this.sysparm_query_category,
-        sysparm_query_no_domain: this.sysparm_query_no_domain,
-        sysparm_no_count: this.sysparm_no_count,
+        sysparm_query: query,
+        sysparm_display_value: this.responseDataFormat,
+        sysparm_exclude_reference_link: this.excludeReferenceLinks,
+        sysparm_fields: this.responseFields?.join?.() || this.responseFields,
+        sysparm_limit: this.limit,
+        sysparm_view: this.responseView,
+        sysparm_query_no_domain: this.queryNoDomain,
       },
     });
+
+    $.export("$summary", `Successfully retrieved ${response?.length || 0} record(s) from table "${this.table}"`);
+
+    return response;
   },
 };

package/actions/update-table-record/update-table-record.mjs

@@ -1,130 +1,94 @@
-// legacy_hash_id: a_4riE2J
-import { axios } from "@pipedream/platform";
+import servicenow from "../../servicenow.app.mjs";
+import { parseObject } from "../../common/utils.mjs";
 
 export default {
   key: "servicenow-update-table-record",
   name: "Update Table Record",
-  description: "Updates the specified record with the name-value pairs included in the request body.",
-  version: "0.1.1",
+  description: "Updates the specified record with the name-value pairs included in the request body. [See the documentation](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html#title_table-PATCH)",
+  version: "1.0.0",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
-    servicenow: {
-      type: "app",
-      app: "servicenow",
-    },
-    table_name: {
-      type: "string",
-      description: "The name of the table containing the record to update.",
-    },
-    sys_id: {
-      type: "string",
-      description: "Unique identifier of the record to update.",
-    },
-    update_fields: {
-      type: "object",
-      description: "An object with name-value pairs with the fields to update in the specified record.\n**Note:** All fields within a record may not be available for update. For example, fields that have a prefix of \"sys_\" are typically system parameters that are automatically generated and cannot be updated.",
-    },
-    api_version: {
-      type: "string",
-      description: "API version number. Version numbers identify the endpoint version that a URI accesses. By specifying a version number in your URIs, you can ensure that future updates to the REST API do not negatively impact your integration. Use `lastest` to use the latest REST endpoint for your instance version.",
-      optional: true,
-      options: [
-        "lastest",
-        "v1",
-        "v2",
+    servicenow,
+    table: {
+      propDefinition: [
+        servicenow,
+        "table",
       ],
     },
-    request_format: {
-      type: "string",
-      description: "Format of REST request body",
-      optional: true,
-      options: [
-        "application/json",
-        "application/xml",
-        "text/xml",
+    recordId: {
+      propDefinition: [
+        servicenow,
+        "recordId",
       ],
     },
-    response_format: {
-      type: "string",
-      description: "Format of REST response body.",
-      optional: true,
-      options: [
-        "application/json",
-        "application/xml",
-        "text/xml",
-      ],
+    updateFields: {
+      label: "Update Fields",
+      type: "object",
+      description: "The fields to update in the record, as key-value pairs (e.g. `{ \"name\": \"Jane Doe\", \"status\": \"active\" }`). **Note:** System fields (prefixed with `sys_`) are typically auto-generated and cannot be updated.",
     },
-    x_no_response_body: {
+    replaceRecord: {
       type: "boolean",
-      description: "By default, responses include body content detailing the modified record. Set this request header to true to suppress the response body.",
+      label: "Replace Record",
+      description: "If true, replaces the entire record with the provided fields (uses PUT instead of PATCH). Any fields not provided will be cleared.",
       optional: true,
     },
-    sysparm_display_value: {
-      type: "string",
-      description: "Return field display values (true), actual values (false), or both (all) (default: false).",
-      optional: true,
-      options: [
-        "true",
-        "false",
-        "all",
+    responseDataFormat: {
+      propDefinition: [
+        servicenow,
+        "responseDataFormat",
       ],
     },
-    sysparm_fields: {
-      type: "string",
-      description: "A comma-separated list of fields to return in the response.",
-      optional: true,
+    responseFields: {
+      propDefinition: [
+        servicenow,
+        "responseFields",
+      ],
     },
-    sysparm_input_display_value: {
-      type: "boolean",
-      description: "Flag that indicates whether to set field values using the display value or the actual value.\n* `true`: Treats input values as display values and they are manipulated so they can be stored properly in the database.\n* `false`: Treats input values as actual values and stored them in the database without manipulation.",
-      optional: true,
+    inputDisplayValue: {
+      propDefinition: [
+        servicenow,
+        "inputDisplayValue",
+      ],
     },
-    sysparm_view: {
-      type: "string",
-      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
-      optional: true,
-      options: [
-        "desktop",
-        "mobile",
-        "both",
+    responseView: {
+      propDefinition: [
+        servicenow,
+        "responseView",
       ],
     },
-    sysparm_query_no_domain: {
-      type: "boolean",
-      description: "True to access data across domains if authorized (default: false).",
-      optional: true,
+    queryNoDomain: {
+      propDefinition: [
+        servicenow,
+        "queryNoDomain",
+      ],
     },
   },
   async run({ $ }) {
-  /* See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#c_TableAPI
-    Section Table - PATCH /now/table/{tableName}/{sys_id}                      */
-
-    if (!this.table_name || !this.sys_id || !this.update_fields) {
-      throw new Error("Must provide table_name, sys_id, and update_fields parameters.");
-    }
-
-    var apiVersion = "";
-    if (this.api_version == "v1" || this.api_version == "v2") {
-      apiVersion = this.api_version + "/";
-    }
-
-    return await axios($, {
-      method: "patch",
-      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}/${this.sys_id}`,
-      headers: {
-        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
-        "Accept": this.request_format || "application/json",
-        "Content-Type": this.response_format || "application/json",
-        "X-no-response-body": this.x_no_response_body,
-      },
+    const response = await this.servicenow.updateTableRecord({
+      $,
+      table: this.table,
+      recordId: this.recordId,
+      replace: this.replaceRecord,
+      data: parseObject(this.updateFields),
       params: {
-        sysparm_display_value: this.sysparm_display_value,
-        sysparm_fields: this.sysparm_fields,
-        sysparm_input_display_value: this.sysparm_input_display_value,
-        sysparm_view: this.sysparm_view,
-        sysparm_query_no_domain: this.sysparm_query_no_domain,
+        sysparm_display_value: this.responseDataFormat,
+        sysparm_fields: this.responseFields?.join?.() || this.responseFields,
+        sysparm_input_display_value: this.inputDisplayValue,
+        sysparm_view: this.responseView,
+        sysparm_query_no_domain: this.queryNoDomain,
       },
-      data: this.update_fields,
     });
+
+    const action = this.replaceRecord
+      ? "replaced"
+      : "updated";
+    $.export("$summary", `Successfully ${action} record ${this.recordId} in table "${this.table}"`);
+
+    return response;
   },
 };

package/common/constants.mjs

@@ -0,0 +1,31 @@
+const DEFAULT_SEVERITY_OPTIONS = [
+  {
+    label: "Critical",
+    value: "1",
+  },
+  {
+    label: "High",
+    value: "2",
+  },
+  {
+    label: "Moderate",
+    value: "3",
+  },
+  {
+    label: "Low",
+    value: "4",
+  },
+];
+
+const INCIDENT_SEVERITY_OPTIONS = [
+  ...DEFAULT_SEVERITY_OPTIONS,
+  {
+    label: "Planning",
+    value: "5",
+  },
+];
+
+export default {
+  DEFAULT_SEVERITY_OPTIONS,
+  INCIDENT_SEVERITY_OPTIONS,
+};

package/common/utils.mjs

@@ -0,0 +1,15 @@
+import { ConfigurationError } from "@pipedream/platform";
+
+export function parseObject(value) {
+  if (!value) return undefined;
+
+  if (typeof value === "string") {
+    try {
+      return JSON.parse(value);
+    } catch (e) {
+      throw new ConfigurationError(`Invalid JSON: ${value}`);
+    }
+  }
+
+  return value;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pipedream/servicenow",
-  "version": "0.6.0",
-  "description": "Pipedream servicenow Components",
+  "version": "0.8.0",
+  "description": "Pipedream ServiceNow Components",
   "main": "servicenow.app.mjs",
   "keywords": [
     "pipedream",
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.0"
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/servicenow.app.mjs

@@ -1,11 +1,169 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "servicenow",
-  propDefinitions: {},
+  propDefinitions: {
+    table: {
+      type: "string",
+      label: "Table",
+      description: "Search for a table or provide a table name (not label)",
+      useQuery: true,
+      async options({ query }) {
+        if (!(query?.length > 1)) {
+          console.log("Please input a search term");
+          return [];
+        }
+        const data = await this.getTableRecords({
+          table: "sys_db_object",
+          params: {
+            sysparm_query: `nameLIKE${query}^ORlabelLIKE${query}`,
+            sysparm_fields: "name,label",
+          },
+        });
+        return data.map(({
+          label, name,
+        }) => ({
+          label,
+          value: name,
+        }));
+      },
+    },
+    recordId: {
+      type: "string",
+      label: "Record ID",
+      description: "The ID (`sys_id` field) of the record",
+    },
+    responseDataFormat: {
+      label: "Response Data Format",
+      type: "string",
+      description: "The format to return response fields in",
+      optional: true,
+      options: [
+        {
+          value: "true",
+          label: "Returns the display values for all fields",
+        },
+        {
+          value: "false",
+          label: "Returns the actual values from the database",
+        },
+        {
+          value: "all",
+          label: "Returns both actual and display values",
+        },
+      ],
+    },
+    excludeReferenceLinks: {
+      type: "boolean",
+      label: "Exclude Reference Links",
+      description: "If true, the response excludes Table API links for reference fields",
+      optional: true,
+    },
+    responseFields: {
+      type: "string[]",
+      label: "Response Fields",
+      description: "The fields to return in the response. By default, all fields are returned",
+      optional: true,
+    },
+    inputDisplayValue: {
+      label: "Input Display Value",
+      type: "boolean",
+      description: "If true, the input values are treated as display values (and are manipulated so they can be stored properly in the database)",
+      optional: true,
+    },
+    responseView: {
+      label: "Response View",
+      type: "string",
+      description: "Render the response according to the specified UI view (overridden by `Response Fields`)",
+      optional: true,
+      options: [
+        "desktop",
+        "mobile",
+        "both",
+      ],
+    },
+    queryNoDomain: {
+      type: "boolean",
+      label: "Query Across Domains",
+      description: "If true, allows access to data across domains (if authorized)",
+      optional: true,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    async _makeRequest({
+      $ = this,
+      headers,
+      ...args
+    }) {
+      const response = await axios($, {
+        baseURL: `https://${this.$auth.instance_name}.service-now.com/api/now`,
+        headers: {
+          ...headers,
+          "Authorization": `Bearer ${this.$auth.oauth_access_token}`,
+        },
+        ...args,
+      });
+      return response.result;
+    },
+    async createTableRecord({
+      table, ...args
+    }) {
+      return this._makeRequest({
+        method: "post",
+        url: `/table/${table}`,
+        headers: {
+          "Content-Type": "application/json",
+        },
+        ...args,
+      });
+    },
+    async updateTableRecord({
+      table, recordId, replace, ...args
+    }) {
+      return this._makeRequest({
+        method: replace
+          ? "put"
+          : "patch",
+        url: `/table/${table}/${recordId}`,
+        headers: {
+          "Content-Type": "application/json",
+        },
+        ...args,
+      });
+    },
+    async deleteTableRecord({
+      table, recordId, ...args
+    }) {
+      return this._makeRequest({
+        method: "delete",
+        url: `/table/${table}/${recordId}`,
+        ...args,
+      });
+    },
+    async getTableRecordById({
+      table, recordId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/table/${table}/${recordId}`,
+        ...args,
+      });
+    },
+    async getTableRecords({
+      table, ...args
+    }) {
+      return this._makeRequest({
+        url: `/table/${table}`,
+        ...args,
+      });
+    },
+    async getRecordCountsByField({
+      table, ...args
+    }) {
+      return this._makeRequest({
+        url: `/stats/${table}`,
+        ...args,
+      });
     },
   },
 };

package/actions/get-table-record-by-sysid/get-table-record-by-sysid.mjs

@@ -1,112 +0,0 @@
-// legacy_hash_id: a_rJid2e
-import { axios } from "@pipedream/platform";
-
-export default {
-  key: "servicenow-get-table-record-by-sysid",
-  name: "Get Table Record By SysId",
-  description: "Retrieves the record identified by the specified sys_id from the specified table.",
-  version: "0.3.1",
-  type: "action",
-  props: {
-    servicenow: {
-      type: "app",
-      app: "servicenow",
-    },
-    table_name: {
-      type: "string",
-      description: "The name of the table containing the record to retrieve.",
-    },
-    sys_id: {
-      type: "string",
-      description: "Unique identifier of the record to retrieve.",
-    },
-    api_version: {
-      type: "string",
-      description: "API version number. Version numbers identify the endpoint version that a URI accesses. By specifying a version number in your URIs, you can ensure that future updates to the REST API do not negatively impact your integration. Use `lastest` to use the latest REST endpoint for your instance version.",
-      optional: true,
-      options: [
-        "lastest",
-        "v1",
-        "v2",
-      ],
-    },
-    request_format: {
-      type: "string",
-      description: "Format of REST request body",
-      optional: true,
-      options: [
-        "application/json",
-        "application/xml",
-        "text/xml",
-      ],
-    },
-    response_format: {
-      type: "string",
-      description: "Format of REST response body.",
-      optional: true,
-      options: [
-        "application/json",
-        "application/xml",
-        "text/xml",
-      ],
-    },
-    sysparm_display_value: {
-      type: "string",
-      description: "Return field display values (true), actual values (false), or both (all) (default: false).",
-      optional: true,
-      options: [
-        "true",
-        "false",
-        "all",
-      ],
-    },
-    sysparm_exclude_reference_link: {
-      type: "boolean",
-      description: "True to exclude Table API links for reference fields (default: false).",
-      optional: true,
-    },
-    sysparm_fields: {
-      type: "string",
-      description: "A comma-separated list of fields to return in the response.",
-      optional: true,
-    },
-    sysparm_view: {
-      type: "string",
-      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
-      optional: true,
-    },
-    sysparm_query_no_domain: {
-      type: "boolean",
-      description: "True to access data across domains if authorized (default: false).",
-      optional: true,
-    },
-  },
-  async run({ $ }) {
-  // See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#table-GET-id                      */
-
-    if (!this.table_name || !this.sys_id) {
-      throw new Error("Must provide table_name, and sys_id parameters.");
-    }
-
-    var apiVersion = "";
-    if (this.api_version == "v1" || this.api_version == "v2") {
-      apiVersion = this.api_version + "/";
-    }
-
-    return await axios($, {
-      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}/${this.sys_id}`,
-      headers: {
-        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
-        "Accept": this.request_format || "application/json",
-        "Content-Type": this.response_format || "application/json",
-      },
-      params: {
-        sysparm_display_value: this.sysparm_display_value,
-        sysparm_exclude_reference_link: this.sysparm_exclude_reference_link,
-        sysparm_fields: this.sysparm_fields,
-        sysparm_view: this.sysparm_view,
-        sysparm_query_no_domain: this.sysparm_query_no_domain,
-      },
-    });
-  },
-};