Skip to main content
Tools Reference

Alloy Navigator Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Alloy Navigator Tools

alloy_ · 56 tools · Free 49 · Pro 7 IT service management and IT asset management on an installation the customer hosts or Alloy hosts for them, so the API address is a full base URL including its virtual directory rather than a vendor hostname. Reads are one tool per record type over a single generic endpoint, and list results arrive columnar: a Fields array naming each column and a Data array of positional rows that line up with it by index. Alloy Navigator has no direct create or update commands at all - every write runs a workflow action defined in the customer's own system and identified by a number read from the desktop Settings App, which is why the writing tools take that number, accept an arbitrary set of form fields, and are all marked destructive. Two record types, Software Catalog and Stock Rooms, can only be listed.

All connector tools · Alloy Navigator setup guide

Alloy Navigator tool groups

Service Desk

ToolPlanAccessSummary
alloy_list_all_ticketsFreeRead-onlyList and search the All Tickets aggregate — Incidents, Service Requests, Problems, Change Requests and Work Orders in one result set.
alloy_list_change_requestsFreeRead-onlyList and search Change Requests — planned changes moving through the approval and implementation workflow.
alloy_list_incidentsFreeRead-onlyList and search Incidents — the unplanned-interruption tickets that make up most service-desk volume.
alloy_list_my_ticketsFreeRead-onlyList the My Tickets aggregate — the tickets belonging to the account whose credentials StackJack is using, which for a StackJack connector is the application account rather than a person.
alloy_list_problemsFreeRead-onlyList and search Problems — the underlying causes that Incidents are grouped under.
alloy_list_service_requestsFreeRead-onlyList and search Service Requests — the catalog-driven "please do this for me" tickets, as opposed to Incidents, which report something broken.
alloy_list_work_ordersFreeRead-onlyList and search Work Orders — scheduled or dispatched pieces of work, typically raised off a Change Request or a Project rather than reported by a user.

[Alloy Navigator] List and search the All Tickets aggregate — Incidents, Service Requests, Problems, Change Requests and Work Orders in one result set. Use this when the question spans ticket types ("everything open for this customer") and the per-type tools when it does not; the aggregate exposes the fields common to all five, so a type-specific field may be missing here. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Change Requests — planned changes moving through the approval and implementation workflow. Pair with alloy_list_approval_requests and alloy_list_approval_stages to see where a change is stuck, and with alloy_list_work_orders for the work it spawned. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Incidents — the unplanned-interruption tickets that make up most service-desk volume. Filter on fields such as Status, Priority, Assignee, Organization or Due_Date to answer "what is open", "what is overdue" or "what is assigned to this technician". Tickets are identified by their Ticket number (e.g. T000002); pass one to alloy_get_object for every field, or to alloy_list_object_activities for the work log. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List the My Tickets aggregate — the tickets belonging to the account whose credentials StackJack is using, which for a StackJack connector is the application account rather than a person. For a named technician's queue, use alloy_list_incidents or alloy_list_all_tickets filtered on the Assignee field instead. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Problems — the underlying causes that Incidents are grouped under. Use this to find recurring root causes and known errors, then alloy_list_incidents filtered on the Problem to see everything it has generated. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Service Requests — the catalog-driven "please do this for me" tickets, as opposed to Incidents, which report something broken. Note for writes: Alloy has NO Create Action for Service Requests, so a new one is raised by running the "Submit Request" Step Action on a Service Catalog Item (see alloy_list_service_catalog_items and alloy_run_step_action). RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Work Orders — scheduled or dispatched pieces of work, typically raised off a Change Request or a Project rather than reported by a user. Use this for field-work scheduling questions and for technician workload alongside alloy_list_incidents. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

People and Organizations

ToolPlanAccessSummary
alloy_list_groupsFreeRead-onlyList and search Groups — the technician and user groups tickets are assigned and escalated to (underlying table User_Groups).
alloy_list_locationsFreeRead-onlyList and search Locations — sites, buildings, floors and rooms.
alloy_list_organizationsFreeRead-onlyList and search Organizations — the customer or business-unit tree (the underlying table is Organizational_Units, so this is a hierarchy, not a flat customer list).
alloy_list_personsFreeRead-onlyList and search Persons — every user, technician and contact in the system.
alloy_list_service_level_agreementsFreeRead-onlyList and search Service Level Agreements — the response and resolution targets tickets are measured against (underlying table SLA).
alloy_list_servicesFreeRead-onlyList and search Services — the business or IT services tickets and SLAs are attached to (email, VPN, payroll).

[Alloy Navigator] List and search Groups — the technician and user groups tickets are assigned and escalated to (underlying table User_Groups). Use this to resolve a group name on a ticket, or to find which queues exist before filtering alloy_list_incidents on an assignment group. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Locations — sites, buildings, floors and rooms. Assets and Persons both reference a Location, so this answers "which site is this device at" and "who is affected at this office". RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Organizations — the customer or business-unit tree (the underlying table is Organizational_Units, so this is a hierarchy, not a flat customer list). For an MSP this is the closest thing to "which client", and it is the natural filter for scoping ticket and asset questions to one customer. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Persons — every user, technician and contact in the system. This is how a name on a ticket becomes an email address, a phone number, an Organization and a Location. A Person's ID (e.g. PN000017) is also what the impersonation parameter on the workflow tools takes. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Service Level Agreements — the response and resolution targets tickets are measured against (underlying table SLA). Read the target here, then check a ticket's own Due_Date and Response fields with alloy_list_incidents or alloy_get_object to see whether it is breaching. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Services — the business or IT services tickets and SLAs are attached to (email, VPN, payroll). Use this to answer "which service is degraded" and to find the service a ticket names before checking its Service Level Agreement. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

Assets and Configuration

ToolPlanAccessSummary
alloy_list_all_cisFreeRead-onlyList and search the All CIs aggregate — every configuration item in one result set, spanning Computers, Hardware, Assets, Configurations and Networks.
alloy_list_assetsFreeRead-onlyList and search Assets — tracked items of any kind, including the non-physical ones (licenses, warranties, subscriptions) that are not Computers.
alloy_list_computersFreeRead-onlyList and search Computers — the discovered and inventoried machines, with their operating system, hardware profile, owner and location.
alloy_list_configurationsFreeRead-onlyList and search Configurations — configuration items in the CMDB that are neither Computers nor Hardware, such as services, applications and logical components, along with the relationships between…
alloy_list_hardwareFreeRead-onlyList and search Hardware — physical devices and components tracked separately from Computers, such as monitors, printers, docks and spare parts.
alloy_list_networksFreeRead-onlyList and search Networks — the network segments and subnets discovery scans and that assets are attached to.

[Alloy Navigator] List and search the All CIs aggregate — every configuration item in one result set, spanning Computers, Hardware, Assets, Configurations and Networks. Use this when the question crosses CI types ("everything at this location") and the specific tools when it does not; the aggregate exposes only the fields common to all of them. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Assets — tracked items of any kind, including the non-physical ones (licenses, warranties, subscriptions) that are not Computers. Use alloy_list_computers for discovered machines and this for the wider asset register, including purchase, ownership and disposal fields. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Computers — the discovered and inventoried machines, with their operating system, hardware profile, owner and location. This is the primary "what does this customer have" tool and the natural way to correlate a ticket to a device. Computers are identified by an ID such as C000057. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Configurations — configuration items in the CMDB that are neither Computers nor Hardware, such as services, applications and logical components, along with the relationships between them. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Hardware — physical devices and components tracked separately from Computers, such as monitors, printers, docks and spare parts. Use this for peripherals and for parts held against a Computer or a Stock Room. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Networks — the network segments and subnets discovery scans and that assets are attached to. Use this to scope an inventory question to a subnet or to find which segment a site uses. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

Software Assets

ToolPlanAccessSummary
alloy_list_productsFreeRead-onlyList and search Products — the internal product records assets, purchase orders and stock rules are built from (model, manufacturer, category).
alloy_list_software_catalogFreeRead-onlyList and search the Software Catalog — the normalized products Alloy recognizes, with manufacturer, platform and version.
alloy_list_software_licensesFreeRead-onlyList and search Software Licenses — entitlements owned, with seat counts, keys, purchase details and expiry.
alloy_list_tracked_softwareFreeRead-onlyList and search Tracked Software — the products Alloy is actively counting installations of, with install counts per product.
alloy_list_vendor_productsFreeRead-onlyList and search Vendor Products — a supplier's catalog entries for a Product, carrying that vendor's part number and price.

[Alloy Navigator] List and search Products — the internal product records assets, purchase orders and stock rules are built from (model, manufacturer, category). Use alloy_list_vendor_products for the reseller-facing catalog with pricing and part numbers. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search the Software Catalog — the normalized products Alloy recognizes, with manufacturer, platform and version. IMPORTANT: Software Catalog is one of two classes Alloy refuses on every single-record route, so alloy_get_object, alloy_list_object_activities, alloy_run_step_action and alloy_check_action_availability will all fail for these records. This tool is the only way in — filter on ID to retrieve one product. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Software Licenses — entitlements owned, with seat counts, keys, purchase details and expiry. Compare these against alloy_list_tracked_software (what is actually installed) to answer license-compliance questions: over-deployment, unused seats and renewals coming due. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Tracked Software — the products Alloy is actively counting installations of, with install counts per product. This is the deployment side of license compliance; pair it with alloy_list_software_licenses for the entitlement side. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Vendor Products — a supplier's catalog entries for a Product, carrying that vendor's part number and price. This is what links a Product to a Vendor and is the lookup behind a purchase-order line. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

Procurement and Stock

ToolPlanAccessSummary
alloy_list_consumablesFreeRead-onlyList and search Consumables — stocked items that get used up, such as toner, cables and media, with quantities, cost and invoice references.
alloy_list_contractsFreeRead-onlyList and search Contracts — support agreements, warranties, leases and maintenance contracts, with start and end dates, cost and the vendor behind them.
alloy_list_library_itemsFreeRead-onlyList and search Library Items — the loan pool of equipment, media and documentation that can be reserved and checked out (underlying table Library).
alloy_list_purchase_order_itemsFreeRead-onlyList and search Purchase Order Items — the individual lines of a purchase order, with product, quantity, cost and PO status.
alloy_list_purchase_ordersFreeRead-onlyList and search Purchase Orders — orders raised with suppliers, with status, vendor, totals and receipt state (underlying table PO).
alloy_list_reservationsFreeRead-onlyList and search Reservations — bookings of loanable equipment and library items, with the person, the item and the reserved period.
alloy_list_stock_roomsFreeRead-onlyList and search Stock Rooms — the storage locations holding spare hardware and consumables.
alloy_list_stock_rulesFreeRead-onlyList and search Stock Rules — the minimum and reorder levels defined per product and stock room.
alloy_list_vendorsFreeRead-onlyList and search Vendors — suppliers and manufacturers, with contact details and account references.

[Alloy Navigator] List and search Consumables — stocked items that get used up, such as toner, cables and media, with quantities, cost and invoice references. Pair with alloy_list_stock_rules to see reorder thresholds. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Contracts — support agreements, warranties, leases and maintenance contracts, with start and end dates, cost and the vendor behind them. Filter or sort on the expiry field to find renewals coming due. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Library Items — the loan pool of equipment, media and documentation that can be reserved and checked out (underlying table Library). Pair with alloy_list_reservations to see what is currently out. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Purchase Order Items — the individual lines of a purchase order, with product, quantity, cost and PO status. IDENTIFIER NOTE: these records have no OID, so the only way to address one with alloy_get_object is by the GUID primary key — request the ID field here first (add ID to the fields parameter), then pass that GUID. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field. Include ID to obtain the GUID needed by alloy_get_object.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Purchase Orders — orders raised with suppliers, with status, vendor, totals and receipt state (underlying table PO). Use alloy_list_purchase_order_items for the individual lines. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Reservations — bookings of loanable equipment and library items, with the person, the item and the reserved period. Use alloy_list_library_items for the catalog of what can be booked. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Stock Rooms — the storage locations holding spare hardware and consumables. IMPORTANT: Stock Rooms is one of two classes Alloy refuses on every single-record route, so alloy_get_object, alloy_list_object_activities, alloy_run_step_action and alloy_check_action_availability will all fail for these records. This tool is the only way in — filter on ID to retrieve one stock room. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Stock Rules — the minimum and reorder levels defined per product and stock room. Read these alongside alloy_list_consumables and alloy_list_hardware to answer "what is below its reorder point". RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Vendors — suppliers and manufacturers, with contact details and account references. Vendors are referenced by purchase orders, contracts and vendor products. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

Knowledge and Administration

ToolPlanAccessSummary
alloy_list_announcementsFreeRead-onlyList and search Announcements — the notices published to the Self Service Portal, such as outage and maintenance bulletins.
alloy_list_approval_requestsFreeRead-onlyList and search Approval Requests — the individual approvals raised against Change Requests, Service Requests and Purchase Orders, with the approver and the decision.
alloy_list_approval_stagesFreeRead-onlyList and search Approval Stages — the ordered steps of an approval chain, showing which stage a record has reached and what each stage requires.
alloy_list_documentsFreeRead-onlyList and search Documents — the document register: policies, procedures, diagrams and reference material held against organizations, assets or services.
alloy_list_knowledge_base_articlesFreeRead-onlyList and search Knowledge Base Articles — documented fixes, workarounds and how-to guidance (underlying table KB_Articles).
alloy_list_projectsFreeRead-onlyList and search Projects — multi-step pieces of work with owners, schedules and status.
alloy_list_service_catalog_itemsFreeRead-onlyList and search Service Catalog Items — the offerings users can request from the Self Service Portal (underlying table Service_Catalog_Items).
alloy_list_tasksFreeRead-onlyList and search Tasks — the individual steps under a Project or a ticket, with assignee, due date and completion state.

[Alloy Navigator] List and search Announcements — the notices published to the Self Service Portal, such as outage and maintenance bulletins. Useful for checking whether an incident is already being communicated before raising another one. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Approval Requests — the individual approvals raised against Change Requests, Service Requests and Purchase Orders, with the approver and the decision. Use this to answer "what is waiting on whom"; alloy_list_approval_stages gives the shape of the chain those requests belong to. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Approval Stages — the ordered steps of an approval chain, showing which stage a record has reached and what each stage requires. Read this with alloy_list_approval_requests to explain why something is not moving. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Documents — the document register: policies, procedures, diagrams and reference material held against organizations, assets or services. For the FILES attached to a specific record, use alloy_list_object_attachments instead. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Knowledge Base Articles — documented fixes, workarounds and how-to guidance (underlying table KB_Articles). Use searchText to find an article by keyword before answering a ticket, then alloy_get_object with the article's ID for the full body. Article bodies are HTML fields. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Projects — multi-step pieces of work with owners, schedules and status. Use alloy_list_tasks for the individual steps and alloy_list_work_orders for dispatched field work raised from a project. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Service Catalog Items — the offerings users can request from the Self Service Portal (underlying table Service_Catalog_Items). This is also the entry point for CREATING a Service Request: Alloy has no Create Action for Service Requests, so a new one is raised by running the "Submit Request" Step Action on the catalog item, with alloy_run_step_action. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] List and search Tasks — the individual steps under a Project or a ticket, with assignee, due date and completion state. Filter on the parent record to see one project's plan, or on assignee for a person's task list. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
searchTextstringnonullKeyword or partial-text search across the class's frequently-used text fields.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

Objects and Metadata

ToolPlanAccessSummary
alloy_check_action_availabilityFreeRead-onlyCheck whether a specific workflow Step Action can run on a specific record right now; responseObject.Result is true or false.
alloy_get_app_configFreeRead-onlyRetrieve the stored configuration of ONE external or mobile application registered in the Settings App under Services > Mobile Applications, including its Actions array of {ActionID, DisplayName,…
alloy_get_current_user_profileFreeRead-onlyRetrieve the Person record behind the credentials in use, as responseObject.Items of {name, caption, value}.
alloy_get_objectFreeRead-onlyRetrieve EVERY field of one record, whatever its type.
alloy_list_classification_valuesFreeRead-onlyRetrieve the legal values of one classification or reference field on one record type — the Statuses an Incident can hold, the Priorities, the Types a Computer can be.
alloy_list_object_activitiesFreeRead-onlyRetrieve the Activities — the work log — of one record: every note, status change, SLA violation and workflow event, newest first if you sort descending on Num.

[Alloy Navigator] Check whether a specific workflow Step Action can run on a specific record right now; responseObject.Result is true or false. ALWAYS CALL THIS BEFORE alloy_run_step_action — availability depends on the record's type, its current status and the workflow's own conditions, so a Close action is simply unavailable on an already-closed ticket. NOTE: this VALIDATES an action number you already have; nothing in the Alloy API can list them. Action numbers come from the desktop Settings App under Workflow and Business Logic. REFUSED for Software Catalog and Stock Room records.

ParamTypeRequiredDefaultDescription
actionIdintegeryesThe numeric workflow Step Action ID to test, e.g. 253. Read it from the Settings App.
oidstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.

[Alloy Navigator] Retrieve the stored configuration of ONE external or mobile application registered in the Settings App under Services > Mobile Applications, including its Actions array of {ActionID, DisplayName, ResponseText}. SCOPE WARNING: this returns only the actions configured for that one registered application, so it is NOT a catalog of the workflow actions available to alloy_run_step_action or alloy_create_object.

ParamTypeRequiredDefaultDescription
appNamestringyesThe application name (Application ID) exactly as registered in the Settings App, e.g. InventoryScanner.

[Alloy Navigator] Retrieve the Person record behind the credentials in use, as responseObject.Items of {name, caption, value}. Useful as a connection check and to confirm which identity Alloy sees. Pass impersonatingUserId to read another Person's profile instead — that runs the call with Self Service Portal rights only.

ParamTypeRequiredDefaultDescription
impersonatingUserIdstringnonullOptional Person GUID to read on behalf of. Downgrades the call to Self Service Portal rights.

[Alloy Navigator] Retrieve EVERY field of one record, whatever its type. Response shape differs from the list tools: responseObject.Items is an array of {name, caption, value} objects, one per field, so it is directly readable without zipping. IDENTIFIERS: tickets use their Ticket number (T000002); most other records use their ID (C000057); every record also accepts its GUID primary key in braces. REFUSED for Software Catalog and Stock Room records — use alloy_list_software_catalog or alloy_list_stock_rooms with an ID filter instead. Purchase Order Items have no ID of that form and must be addressed by the GUID returned in alloy_list_purchase_order_items.

ParamTypeRequiredDefaultDescription
oidstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.

[Alloy Navigator] Retrieve the legal values of one classification or reference field on one record type — the Statuses an Incident can hold, the Priorities, the Types a Computer can be. CALL THIS BEFORE FILTERING OR WRITING: classification fields take the display value exactly ("Immediate", "In Stock"), and guessing produces an empty result or a refused workflow action rather than an error you can read. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
objectClassstringyesRecord type, e.g. Incidents or Computers. Use the spelling shown in the Alloy Navigator connector documentation.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
refFieldstringyesThe classification or reference field to enumerate, e.g. Status or Type.
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending.

[Alloy Navigator] Retrieve the Activities — the work log — of one record: every note, status change, SLA violation and workflow event, newest first if you sort descending on Num. This is what answers "what has actually been done on this ticket". REFUSED for Software Catalog and Stock Room records. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated Activity field names to return, e.g. Num,Activity,Details,Created_Date. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
offsetintegerno0Records to skip, for paging (default 0).
oidstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.
pageSizeintegerno50Records to return (default 50, max 200).
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending. Sorting on Num descending gives newest first.

Attachments

ToolPlanAccessSummary
alloy_add_object_attachmentProWriteAttach a file to one record.
alloy_add_object_linkProWriteAttach a URL to one record as a link rather than a file.
alloy_delete_object_attachmentProDestructiveDESTRUCTIVE: permanently remove one attachment from a record.
alloy_get_attachment_contentFreeRead-onlyRetrieve one attachment's contents as base64, together with its file name, description and byte size: responseObject is {Data, FileName, Description, Size}.
alloy_list_object_attachmentsFreeRead-onlyList the attachments and links held against one record, with each attachment's ID, file name, type and creation date.
alloy_update_attachment_descriptionProWriteChange the description shown beside one attachment.

[Alloy Navigator] Attach a file to one record. Additive: it creates a new attachment and changes nothing that already exists, which is why it is not marked destructive. The content must be base64-encoded. To attach a URL rather than a file, use alloy_add_object_link. Adding an attachment requires Modify permission on the record.

ParamTypeRequiredDefaultDescription
base64DatastringyesThe file contents, base64-encoded.
descriptionstringnonullOptional description shown beside the attachment.
fileNamestringyesFile name including its extension, e.g. server-log.txt.
objectIdstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.

[Alloy Navigator] DESTRUCTIVE: permanently remove one attachment from a record. Alloy documents no undo and no recycle bin for this, so the file is gone. Confirm the attachment ID with alloy_list_object_attachments first, and read it with alloy_get_attachment_content if a copy is wanted. Removing an attachment requires Modify permission on the record.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe attachment's GUID, from alloy_list_object_attachments. Verify it before calling — this cannot be undone.
objectIdstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.

[Alloy Navigator] Retrieve one attachment's contents as base64, together with its file name, description and byte size: responseObject is {Data, FileName, Description, Size}. Get the attachment ID from alloy_list_object_attachments first. SIZE WARNING: the whole file arrives inline as base64, roughly a third larger than the original, so check Size in the listing before fetching anything large.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe attachment's GUID, from alloy_list_object_attachments.
objectIdstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.

[Alloy Navigator] List the attachments and links held against one record, with each attachment's ID, file name, type and creation date. Take the ID from here and pass it to alloy_get_attachment_content to read a file. This list adds a Caption to each entry of responseObject.Fields alongside Name and DataType. RESPONSE SHAPE: Alloy returns a columnar envelope — responseObject.Fields names each column (Name + DataType) and responseObject.Data is an array of POSITIONAL rows whose values line up with Fields by index, so zip them by position rather than expecting named properties. PAGING: offset + pageSize; Alloy returns no total count and no next-page link, so a page shorter than pageSize is the end of the collection. pageSize is capped at 200 (a StackJack safety cap — Alloy publishes no maximum). Use searchText for keyword search across the class's main text fields, filtersJson for exact or comparison filters, and alloy_list_classification_values to learn the legal values of a Status, Priority or other classification field before filtering on one. An empty Data array with a populated Fields array means the credential cannot see this record type, not that the class is empty.

ParamTypeRequiredDefaultDescription
fieldsstringnonullComma-separated field names to return. Omit to return every available field.
filtersJsonstringnonullOptional JSON array of filter conditions, e.g. [{"name":"Status","value":"Open","operation":"="}]. operation is one of =, <>, >, >=, <, <= (the comparison operators are for numeric and date fields). Field names are Alloy's database field names, as shown in the Fields array of a previous list.
objectIdstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.
offsetintegerno0Records to skip, for paging (default 0).
pageSizeintegerno50Records to return (default 50, max 200).
sortAscstringnonullComma-separated field names to sort ascending. Use either sortAsc or sortDesc, never both.
sortDescstringnonullComma-separated field names to sort descending, e.g. Created_Date for newest first.

[Alloy Navigator] Change the description shown beside one attachment. REPLACES the existing description rather than adding to it, and an empty string clears it — Alloy keeps no history of the previous text, so read the current one with alloy_list_object_attachments first if it matters. This is the only modification Alloy allows on an existing attachment: the file itself, its name and its record cannot be changed. It is not marked destructive because it touches one cosmetic field and cannot remove the attachment or its contents.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesThe attachment's GUID, from alloy_list_object_attachments.
descriptionstringno""The new description. Pass an empty string to clear it.
objectIdstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.

Workflow Actions

ToolPlanAccessSummary
alloy_create_objectProDestructiveCreate a record by running a workflow Create Action.
alloy_invoke_global_functionProDestructiveRun a global workflow function.
alloy_run_step_actionProDestructiveRun a workflow Step Action on one record.

[Alloy Navigator] Create a record by running a workflow Create Action. The record type is decided by the action number, not by a parameter. On success responseObject returns Succeed, ObjectID (the GUID) and ObjectOID (the new record's identifier). NO CREATE ACTION EXISTS FOR SERVICE REQUESTS — raise one instead by running the "Submit Request" Step Action on a Service Catalog Item with alloy_run_step_action. DESTRUCTIVE AND ARBITRARY: Alloy has no direct create or update API — every write runs a workflow action defined in this customer's own system, so what actually happens is whatever that action does. A single call can change status, reassign work, spend money or send email to a customer, and the credential StackJack uses is an application account, which Alloy documents as having full unrestricted access regardless of security roles. Confirm the intended effect with the person who owns the workflow before running one. WHERE ACTION NUMBERS COME FROM: they are specific to this customer's install and cannot be listed over the API. Read them in the desktop Settings App under Workflow and Business Logic > [Module] > [Object Class] > Workflow > Actions. alloy_check_action_availability can confirm a number you already have; nothing can enumerate them. FIELD NAMES ARE FORM LABELS, NOT DATABASE COLUMNS: use the labels printed on the action form in the Settings App. Reference fields take the referenced record's identifier (PN000017) or its name (Angelina Reyes); classification fields take the display value (Immediate) — get the legal values from alloy_list_classification_values; booleans take true/false or 1/0; HTML fields take markup; dates use W3C date-time format. CHECK responseObject.Succeed, NOT JUST success: Alloy warns that a form submitted with an unfilled mandatory field may not raise an error when that field already holds a default or the record's current value, so a call can report success without doing what was intended.

ParamTypeRequiredDefaultDescription
actionIdintegeryesThe numeric workflow Create Action ID from the Settings App, e.g. 388.
fieldsJsonstringyesJSON object of action-form labels to values, e.g. {"Name":"Asset API","Type":"Non-Physical","Associated":"PC00092"}.
impersonatingUserIdstringnonullOptional Person GUID to create on behalf of. Downgrades the call to Self Service Portal rights, which is the only way to reduce what it can do.

[Alloy Navigator] Run a global workflow function. THE WIDEST-REACHING TOOL IN THIS CONNECTOR: unlike the other two writes, a global function has no record scope at all — it runs across the whole system, and Alloy's own documented example finds and closes every ticket resolved more than a set number of days ago. A single call can therefore change thousands of records at once, and there is no per-record confirmation and no undo. Available from Alloy Navigator 2026 onward. DESTRUCTIVE AND ARBITRARY: Alloy has no direct create or update API — every write runs a workflow action defined in this customer's own system, so what actually happens is whatever that action does. A single call can change status, reassign work, spend money or send email to a customer, and the credential StackJack uses is an application account, which Alloy documents as having full unrestricted access regardless of security roles. Confirm the intended effect with the person who owns the workflow before running one. WHERE ACTION NUMBERS COME FROM: they are specific to this customer's install and cannot be listed over the API. Read them in the desktop Settings App under Workflow and Business Logic > [Module] > [Object Class] > Workflow > Actions. alloy_check_action_availability can confirm a number you already have; nothing can enumerate them. Parameters are the function's own Param_* names. Parameters of type ObjectScript are not supported by Alloy. CHECK responseObject.Succeed, NOT JUST success: Alloy warns that a form submitted with an unfilled mandatory field may not raise an error when that field already holds a default or the record's current value, so a call can report success without doing what was intended.

ParamTypeRequiredDefaultDescription
functionIdintegeryesThe numeric global workflow function ID from the Settings App, e.g. 1257.
parametersJsonstringyesJSON object of the function's parameters, e.g. {"Param_DaysThreshold":30,"Param_Comment":"Automatically closed due to inactivity."}. May include an Attachments array of {FileName, Description, Data, AttachmentArea}.

[Alloy Navigator] Run a workflow Step Action on one record. This is the ONLY way to update anything in Alloy Navigator — the same tool closes, cancels, reassigns, adds time and notifies, depending entirely on which action number is passed. Call alloy_check_action_availability first: an action that is not available for the record's current status will be refused. REFUSED for Software Catalog and Stock Room records. DESTRUCTIVE AND ARBITRARY: Alloy has no direct create or update API — every write runs a workflow action defined in this customer's own system, so what actually happens is whatever that action does. A single call can change status, reassign work, spend money or send email to a customer, and the credential StackJack uses is an application account, which Alloy documents as having full unrestricted access regardless of security roles. Confirm the intended effect with the person who owns the workflow before running one. WHERE ACTION NUMBERS COME FROM: they are specific to this customer's install and cannot be listed over the API. Read them in the desktop Settings App under Workflow and Business Logic > [Module] > [Object Class] > Workflow > Actions. alloy_check_action_availability can confirm a number you already have; nothing can enumerate them. FIELD NAMES ARE FORM LABELS, NOT DATABASE COLUMNS: use the labels printed on the action form in the Settings App. Reference fields take the referenced record's identifier (PN000017) or its name (Angelina Reyes); classification fields take the display value (Immediate) — get the legal values from alloy_list_classification_values; booleans take true/false or 1/0; HTML fields take markup; dates use W3C date-time format. CHECK responseObject.Succeed, NOT JUST success: Alloy warns that a form submitted with an unfilled mandatory field may not raise an error when that field already holds a default or the record's current value, so a call can report success without doing what was intended.

ParamTypeRequiredDefaultDescription
actionIdintegeryesThe numeric workflow Step Action ID from the Settings App, e.g. 1631.
fieldsJsonstringyesFlat JSON object of action-form labels to values, e.g. {"Activity.Time_Spent":84,"Comment":"Updated with the API"}. May include an Attachments array of {FileName, Description, Data}.
impersonatingUserIdstringnonullOptional Person GUID to act on behalf of. Downgrades the call to Self Service Portal rights, which is the only way to reduce what it can do.
oidstringyesObject identifier: a Ticket number (T000002), an ID (C000057), or the record's GUID primary key.