Natively ingest ServiceNow incidents into epistemic-graph as typed :Incident nodes.

Lists incidents via the ServiceNow API and pushes them (with their affected :ConfigurationItem and :Person assignee, via :affects / :assignedTo links) into the knowledge graph through the fast engine client. Best-effort: returns {"ingested": None} when no engine is reachable. CONCEPT:AU-KG.ingest.enterprise-source-extractor.

Activate a plugin based on the provided plugin_id.

:param plugin_id: The ID of the plugin to be activated. :type plugin_id: str

:return: Response containing parsed Pydantic model with information about the activation. :rtype: Response

:raises MissingParameterError: If plugin_id is not provided.

Adds a specified CI action to a specified list of CIs.

Add a new record to the specified table.

:param table: The name of the table. :type table: str :param data: Dictionary containing the field values for the new record. :type data: dict

:return: Response containing parsed Pydantic model with information about the added record. :rtype: Response

:raises MissingParameterError: If table or data is not provided. :raises ParameterError: If JSON serialization fails.

Invoke the api_request operation.

Install an application from the repository based on the provided parameters.

:param app_sys_id: The sys_id of the application to be installed. :type app_sys_id: str :param scope: The scope of the application. :type scope: str :param auto_upgrade_base_app: Flag indicating whether to auto-upgrade the base app. :type auto_upgrade_base_app: bool :param base_app_version: The version of the base app. :type base_app_version: str :param version: The version of the application to be installed. :type version: str

:return: Response containing parsed Pydantic model with information about the installation. :rtype: Response

:raises MissingParameterError: If app_sys_id or scope is not provided. :raises ParameterError: If auto_upgrade_base_app is not a boolean.

Publish an application to the repository based on the provided parameters.

:param app_sys_id: The sys_id of the application to be published. :type app_sys_id: str :param scope: The scope of the application. :type scope: str :param dev_notes: Development notes for the published version. :type dev_notes: str :param version: The version of the application to be published. :type version: str

:return: Response containing parsed Pydantic model with information about the publication. :rtype: Response

:raises MissingParameterError: If app_sys_id or scope is not provided.

Rollback an application in the repository based on the provided parameters.

:param app_sys_id: The sys_id of the application to be rolled back. :type app_sys_id: str :param scope: The scope of the application. :type scope: str :param version: The version of the application to be rolled back. :type version: str

:return: Response containing parsed Pydantic model with information about the rollback. :rtype: Response

:raises MissingParameterError: If app_sys_id, scope, or version is not provided.

Apply remote source control changes based on the provided parameters.

:param app_sys_id: The sys_id of the application for which changes should be applied. :type app_sys_id: str :param scope: The scope of the changes. :type scope: str :param branch_name: The name of the branch containing the changes. :type branch_name: str :param auto_upgrade_base_app: Flag indicating whether to auto-upgrade the base app. :type auto_upgrade_base_app: bool

:return: Response containing parsed Pydantic model with information about the applied changes. :rtype: Response

:raises MissingParameterError: If app_sys_id or scope is not provided. :raises ParameterError: If auto_upgrade_base_app is not a boolean.

Approve or reject a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param state: State to set the change request to (approved or rejected). :type state: str or None

:return: Response containing parsed Pydantic model with information about the approval/rejection. :rtype: Response

:raises MissingParameterError: If change_request_sys_id or state is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If state is not valid. :raises ParameterError: If JSON serialization or deserialization fails.

Initiate a batch installation with the provided parameters.

:param name: The name of the batch installation. :type name: str :param notes: Additional notes for the batch installation. :type notes: str :param packages: The packages to be installed in the batch. :type packages: str

:return: Response containing parsed Pydantic model with information about the batch installation. :rtype: Response

:raises MissingParameterError: If name or packages are not provided. :raises ParameterError: If notes is not a string.

Get the result of a batch installation based on the provided result ID.

:param result_id: The ID associated with the batch installation result. :type result_id: str

:return: Response containing parsed Pydantic model with batch installation result. :rtype: Response

:raises MissingParameterError: If result_id is not provided.

Sends multiple REST API requests in a single call.

:param batch_request_id: ID that identifies the batch of requests. :type batch_request_id: str :param rest_requests: List of request objects to include in the batch request. :type rest_requests: list

:return: Response containing the batch results. :rtype: Response

Rollback a batch installation based on the provided rollback ID.

:param rollback_id: The ID associated with the batch rollback. :type rollback_id: str

:return: Response containing parsed Pydantic model with information about the batch rollback. :rtype: Response

:raises MissingParameterError: If rollback_id is not provided.

Calculate and update the risk of a standard change request.

:param change_request_sys_id: Sys ID of the standard change request. :type change_request_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the calculated risk. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Check for conflicts in a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None

:return: Response containing parsed Pydantic model with information about conflicts. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Determines whether two specified CI actions are compatible.

Determines whether the lease has expired for the requester.

Determines whether a specified CI action is not allowed.

Determines whether an operational state transition is allowed.

Determines whether the specified user is a valid requester.

Checks if the orchestration task is under change control.

Verifies that the information being passed is valid for the creation of an orchestration task.

Creates a technical service qualification request.

Invoke the collect_graph_for_roots operation.

Initiate a suite scan for a combo based on the provided combo_sys_id.

:param combo_sys_id: The sys_id of the combo to be scanned. :type combo_sys_id: str

:return: Response containing parsed Pydantic model with information about the combo suite scan. :rtype: Response

:raises MissingParameterError: If combo_sys_id is not provided.

Create a new change request.

:param name_value_pairs: Name-value pairs providing details for the new change request. :type name_value_pairs: str or None :param change_type: Type of change (emergency, normal, standard). :type change_type: str or None :param standard_change_template_id: Sys ID of the standard change request template (if applicable). :type standard_change_template_id: str or None

:return: Response containing parsed Pydantic model with information about the created change request. :rtype: Response

:raises MissingParameterError: If name_value_pairs is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If change_type is specified but not valid. :raises ParameterError: If JSON serialization or deserialization fails.

Create associations between a change request and configuration items (CIs).

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param cmdb_ci_sys_ids: List of Sys IDs of CIs to associate with the change request. :type cmdb_ci_sys_ids: list or None :param association_type: Type of association (affected, impacted, offering). :type association_type: str or None :param refresh_impacted_services: Flag to refresh impacted services (applicable for 'affected' association). :type refresh_impacted_services: bool or None

:return: Response containing parsed Pydantic model with information about the created associations. :rtype: Response

:raises MissingParameterError: If change_request_sys_id, cmdb_ci_sys_ids, or association_type is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If association_type is not valid. :raises ParameterError: If JSON serialization or deserialization fails.

Create a new task associated with a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param data: Name-value pairs providing details for the new task. :type data: dict or None

:return: Response containing parsed Pydantic model with information about the created task. :rtype: Response

:raises MissingParameterError: If change_request_sys_id or name_value_pairs is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON serialization or deserialization fails.

Creates a single configuration item (CI).

:param className: CMDB class name. :type className: str :param attributes: Data attributes to define in the CI record. :type attributes: dict :param source: Discovery source. :type source: str :param inbound_relations: List of inbound relations. :type inbound_relations: list :param outbound_relations: List of outbound relations. :type outbound_relations: list

:return: Response containing created CI. :rtype: Response

Adds an inbound and/or outbound relation to the specified CI.

:param className: CMDB class name. :type className: str :param sys_id: Sys_id of the CI. :type sys_id: str :param inbound_relations: List of inbound relations. :type inbound_relations: list :param outbound_relations: List of outbound relations. :type outbound_relations: list :param source: Discovery source. :type source: str

:return: Response containing updated CI relations. :rtype: Response

Create a new incident record.

:param kwargs: Keyword arguments to initialize an IncidentModel instance. :type kwargs: dict

:return: Response containing parsed Pydantic model with information about the created incident record. :rtype: Response

:raises MissingParameterError: If data for the incident is not provided. :raises ParameterError: If JSON serialization of incident data fails. :raises ParameterError: If validation of parameters fails.

Create a new problem record.

:param kwargs: Keyword arguments to initialize a ProblemModel instance. :type kwargs: dict

:return: Response containing parsed Pydantic model with information about the created problem record. :rtype: Response

:raises MissingParameterError: If data for the problem is not provided. :raises ParameterError: If validation of parameters fails.

Invoke the delete_attachment operation.

Delete a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param change_type: Type of change (emergency, normal, standard). :type change_type: str or None

:return: Response containing parsed Pydantic model with information about the deleted change request. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Delete conflict scan information associated with a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param task_sys_id: Sys ID of the task associated with the change request. :type task_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the deleted conflict scan. :rtype: Response

:raises MissingParameterError: If either change_request_sys_id or task_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Delete a task associated with a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param task_sys_id: Sys ID of the task associated with the change request. :type task_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the deleted task. :rtype: Response

:raises MissingParameterError: If either change_request_sys_id or task_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Removes a configuration item (CI) action for a list of CIs.

Deletes the relation for the specified configuration item (CI).

:param className: CMDB class name. :type className: str :param sys_id: Sys_id of the CI. :type sys_id: str :param rel_sys_id: Sys_id of the relation to remove. :type rel_sys_id: str

:return: Response containing the operation result. :rtype: Response

:raises MissingParameterError: If className, sys_id, or rel_sys_id is not provided.

Delete an incident record.

:param incident_id: The sys_id of the incident record to delete. :type incident_id: str

:return: Response containing information about the deletion. :rtype: Response

:raises MissingParameterError: If incident_id is not provided.

Delete a problem record.

:param problem_id: The sys_id of the problem record to delete. :type problem_id: str

:return: Response containing information about the deletion. :rtype: Response

:raises MissingParameterError: If problem_id is not provided.

Deletes a specified product inventory record.

Delete a record from the specified table.

:param table: The name of the table. :type table: str :param table_record_sys_id: The sys_id of the record to be deleted. :type table_record_sys_id: str

:return: Response containing parsed Pydantic model with information about the deletion. :rtype: Response

:raises MissingParameterError: If table or table_record_sys_id is not provided.

Extends the specified CI action's lease expiration time.

Initiate a full instance scan.

:return: Response containing parsed Pydantic model with information about the full scan. :rtype: Response

Invoke the get_account operation.

Invoke the get_activity_subscriptions operation.

Get information about an application.

:param application_id: The unique identifier of the application. :type application_id: str

:return: Response containing parsed Pydantic model with information about the application. :rtype: Response

:raises MissingParameterError: If the required parameter application_id is not provided.

Invoke the get_attachment operation.

Retrieve details of a specific change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param change_type: Type of change (emergency, normal, standard). :type change_type: str or None

:return: Response containing parsed Pydantic model with information about the change request. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If change_type is specified but not valid. :raises ParameterError: If JSON deserialization fails.

Retrieve the configuration item (CI) associated with a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the associated CI. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve conflict information associated with a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the conflicts. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve change request models based on specified parameters.

:param order: Ordering parameter for sorting results. :type order: str or None :param name_value_pairs: Additional name-value pairs for filtering. :type name_value_pairs: str or None :param sysparm_query: Query parameter for filtering results. :type sysparm_query: str or None :param text_search: Text search parameter for searching results. :type text_search: str or None

:return: Response containing list of parsed Pydantic models with information about change request models. :rtype: Response

:raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve the next state of a specific change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the next state. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve the schedule of a change request based on CI sys ID.

:param cmdb_ci_sys_id: Sys ID of the CI (Configuration Item). :type cmdb_ci_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the change request schedule. :rtype: Response

:raises MissingParameterError: If cmdb_ci_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve tasks associated with a specific change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param order: Ordering parameter for sorting results. :type order: str or None :param name_value_pairs: Additional name-value pairs for filtering. :type name_value_pairs: str or None :param sysparm_query: Query parameter for filtering results. :type sysparm_query: str or None :param text_search: Text search parameter for searching results. :type text_search: str or None

:return: Response containing list of parsed Pydantic models with information about change request tasks. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve details of a change request worker.

:param worker_sys_id: Sys ID of the change request worker. :type worker_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the change request worker. :rtype: Response

:raises MissingParameterError: If worker_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve change requests based on specified parameters.

:param order: Ordering parameter for sorting results. :type order: str or None :param name_value_pairs: Additional name-value pairs for filtering. :type name_value_pairs: str or None :param sysparm_query: Query parameter for filtering results. :type sysparm_query: str or None :param text_search: Text search parameter for searching results. :type text_search: str or None :param change_type: Type of change (emergency, normal, standard, model). :type change_type: str or None

:return: Response containing list of parsed Pydantic models with information about change requests. :rtype: Response

:raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If change_type is specified but not valid. :raises ParameterError: If JSON serialization or deserialization fails. :raises ParameterError: If unexpected response format is encountered.

Returns a list of active CI actions for the specified CI.

Returns the current operational state for the specified CI.

Get Configuration Management Database (CMDB) information based on specified parameters.

:param cmdb_id: The unique identifier of the CMDB record :type cmdb_id: str

:return: Response containing parsed Pydantic model with CMDB information. :rtype: Response

:raises ParameterError: If the provided parameters are invalid.

Returns attributes and relationship information for a specified CI record.

:param className: CMDB class name. :type className: str :param sys_id: Sys_id of the CI record to retrieve. :type sys_id: str

:return: Response containing parsed Pydantic model with CI information. :rtype: Response

Returns the available configuration items (CI) for a specified CMDB class.

:param className: CMDB class name. :type className: str :param sysparm_limit: Maximum number of records to return. :type sysparm_limit: int or str :param sysparm_offset: Starting record index. :type sysparm_offset: int or str :param sysparm_query: Encoded query used to filter the result set. :type sysparm_query: str

:return: Response containing list of CIs. :rtype: Response

Invoke the get_data_classification operation.

Retrieves change request details for a specified orchestration pipeline execution.

Returns the schema object for a specified code resource.

Returns the current status of the specified onboarding event.

Returns the schema object for a specified orchestration resource.

Returns the schema object for a specific plan.

Get featured Knowledge Base articles.

:param sysparm_fields: Comma-separated list of field names to include in the response. :type sysparm_fields: str :param sysparm_limit: Maximum number of records to return. :type sysparm_limit: int :param sysparm_offset: Number of records to skip before starting the retrieval. :type sysparm_offset: int :param kb: Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to. :type kb: str :param language: List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. :type language: str

:return: Response containing list of parsed Pydantic models with information about the retrieved records. :rtype: Response

:raises ParameterError: If input parameters are invalid.

Fetch rich metadata for any flow/subflow.

Invoke the get_hr_profile operation.

Get details of a specific import set record.

:param table: The name of the table associated with the import set. :type table: str :param import_set_sys_id: The sys_id of the import set record. :type import_set_sys_id: str

:return: Response containing parsed Pydantic model with information about the import set record. :rtype: Response

:raises ParameterError: If import_set_sys_id or table is not provided.

Retrieve details of a specific incident record.

:param incident_id: The sys_id of the incident record. :type incident_id: str

:return: Response containing list of parsed Pydantic models with information about the retrieved records. :rtype: Response

:raises MissingParameterError: If table is not provided. :raises ParameterError: If input parameters are invalid.

Retrieve details of incident records.

:param name_value_pairs: Dictionary of name-value pairs for filtering records. :type name_value_pairs: str :param sysparm_display_value: Display values for reference fields ('True', 'False', or 'all'). :type sysparm_display_value: str :param sysparm_exclude_reference_link: Exclude reference links in the response. :type sysparm_exclude_reference_link: bool :param sysparm_fields: Comma-separated list of field names to include in the response. :type sysparm_fields: str :param sysparm_limit: Maximum number of records to return. Defaults to DEFAULT_INCIDENT_LIMIT when omitted; see Response.truncated. :type sysparm_limit: int :param sysparm_no_count: Do not include the total number of records in the response. :type sysparm_no_count: bool :param sysparm_offset: Number of records to skip before starting the retrieval. :type sysparm_offset: int :param sysparm_query: Encoded query string for filtering records. :type sysparm_query: str :param sysparm_query_category: Category to which the query belongs. :type sysparm_query_category: str :param sysparm_query_no_domain: Exclude records based on domain separation. :type sysparm_query_no_domain: bool :param sysparm_suppress_pagination_header: Suppress pagination headers in the response. :type sysparm_suppress_pagination_header: bool :param sysparm_view: Display style ('desktop', 'mobile', or 'both'). :type sysparm_view: str

:return: Response containing list of parsed Pydantic models with information about the retrieved records, plus truncated/applied_limit/next_offset metadata disclosing whether a default cap was applied and how to page past it. :rtype: Response

:raises MissingParameterError: If table is not provided. :raises ParameterError: If input parameters are invalid or an unknown argument is passed.

Get Knowledge Base article.

:param article_sys_id: The sys_id of the knowledge article. :type article_sys_id: str :param filter: Encoded query to use to filter the result set. :type filter: str :param sysparm_fields: Comma-separated list of field names to include in the response. :type sysparm_fields: str :param sysparm_limit: Maximum number of records to return. :type sysparm_limit: int :param sysparm_search_id: Unique identifier of search that returned this article :type sysparm_search_id: str :param sysparm_search_rank: Article search rank by click-rate :type sysparm_search_rank: str :param sysparm_update_view: Update view count and record an entry for the article :type sysparm_update_view: bool :param sysparm_offset: Number of records to skip before starting the retrieval. :type sysparm_offset: int :param sysparm_query: Encoded query string for filtering records. :type sysparm_query: str :param sysparm_query_category: Category to which the query belongs. :type sysparm_query_category: str :param kb: Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to. :type kb: str :param language: List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. :type language: str

:return: Response containing parsed Pydantic model with information about the retrieved record. :rtype: Response

:raises MissingParameterError: If article_sys_id is not provided. :raises ParameterError: If input parameters are invalid.

Get Knowledge Base article attachment.

:param article_sys_id: The Article Sys ID to search attachments for :type article_sys_id: str :param attachment_sys_id: The Attachment Sys ID :type attachment_sys_id: str

:return: Response containing parsed Pydantic model with information about the retrieved attachment. :rtype: Response

:raises MissingParameterError: If article_sys_id or attachment_sys_id is not provided. :raises ParameterError: If input parameters are invalid.

Get all Knowledge Base articles.

:param filter: Encoded query to use to filter the result set. :type filter: str :param sysparm_fields: Comma-separated list of field names to include in the response. :type sysparm_fields: str :param sysparm_limit: Maximum number of records to return. :type sysparm_limit: int :param sysparm_offset: Number of records to skip before starting the retrieval. :type sysparm_offset: int :param sysparm_query: Encoded query string for filtering records. :type sysparm_query: str :param sysparm_query_category: Category to which the query belongs. :type sysparm_query_category: str :param kb: Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to. :type kb: str :param language: List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. :type language: str

:return: Response containing list of parsed Pydantic models with information about the retrieved records. :rtype: Response

:raises MissingParameterError: If table is not provided. :raises ParameterError: If input parameters are invalid.

Get most viewed Knowledge Base articles.

:param sysparm_fields: Comma-separated list of field names to include in the response. :type sysparm_fields: str :param sysparm_limit: Maximum number of records to return. :type sysparm_limit: int :param sysparm_offset: Number of records to skip before starting the retrieval. :type sysparm_offset: int :param kb: Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to. :type kb: str :param language: List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. :type language: str

:return: Response containing list of parsed Pydantic models with information about the retrieved records. :rtype: Response

:raises ParameterError: If input parameters are invalid.

Retrieve details of a specific problem record.

:param problem_id: The sys_id of the problem record. :type problem_id: str

:return: Response containing parsed Pydantic model with information about the retrieved record. :rtype: Response

:raises MissingParameterError: If problem_id is not provided. :raises ParameterError: If input parameters are invalid.

Retrieve details of problem records.

:param name_value_pairs: Dictionary of name-value pairs for filtering records. :type name_value_pairs: str :param sysparm_display_value: Display values for reference fields ('True', 'False', or 'all'). :type sysparm_display_value: str :param sysparm_exclude_reference_link: Exclude reference links in the response. :type sysparm_exclude_reference_link: bool :param sysparm_fields: Comma-separated list of field names to include in the response. :type sysparm_fields: str :param sysparm_limit: Maximum number of records to return. :type sysparm_limit: int :param sysparm_no_count: Do not include the total number of records in the response. :type sysparm_no_count: bool :param sysparm_offset: Number of records to skip before starting the retrieval. :type sysparm_offset: int :param sysparm_query: Encoded query string for filtering records. :type sysparm_query: str :param sysparm_query_category: Category to which the query belongs. :type sysparm_query_category: str :param sysparm_query_no_domain: Exclude records based on domain separation. :type sysparm_query_no_domain: bool :param sysparm_suppress_pagination_header: Suppress pagination headers in the response. :type sysparm_suppress_pagination_header: bool :param sysparm_view: Display style ('desktop', 'mobile', or 'both'). :type sysparm_view: str

:return: Response containing list of parsed Pydantic models with information about the retrieved records. :rtype: Response

:raises ParameterError: If input parameters are invalid.

Retrieves a list of all product inventories.

Retrieves a technical qualification request by ID or list all.

Retrieve details of a standard change request model.

:param model_sys_id: Sys ID of the standard change request model. :type model_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the standard change request model. :rtype: Response

:raises MissingParameterError: If model_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve details of a standard change request template.

:param template_sys_id: Sys ID of the standard change request template. :type template_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the standard change request template. :rtype: Response

:raises MissingParameterError: If template_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Retrieve standard change request templates based on specified parameters.

:param order: Ordering parameter for sorting results. :type order: str or None :param name_value_pairs: Additional name-value pairs for filtering. :type name_value_pairs: str or None :param sysparm_query: Query parameter for filtering results. :type sysparm_query: str or None :param text_search: Text search parameter for searching results. :type text_search: str or None

:return: Response containing list of parsed Pydantic models with information about standard change request templates. :rtype: Response

:raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Invoke the get_stats operation.

Get records from the specified table based on provided parameters.

:param table: The name of the table. :type table: str :param name_value_pairs: Dictionary of name-value pairs for filtering records. :type name_value_pairs: str :param sysparm_display_value: Display values for reference fields ('True', 'False', or 'all'). :type sysparm_display_value: str :param sysparm_exclude_reference_link: Exclude reference links in the response. :type sysparm_exclude_reference_link: bool :param sysparm_fields: Comma-separated list of field names to include in the response. :type sysparm_fields: str :param sysparm_limit: Maximum number of records to return. :type sysparm_limit: int :param sysparm_no_count: Do not include the total number of records in the response. :type sysparm_no_count: bool :param sysparm_offset: Number of records to skip before starting the retrieval. :type sysparm_offset: int :param sysparm_query: Encoded query string for filtering records. :type sysparm_query: str :param sysparm_query_category: Category to which the query belongs. :type sysparm_query_category: str :param sysparm_query_no_domain: Exclude records based on domain separation. :type sysparm_query_no_domain: bool :param sysparm_suppress_pagination_header: Suppress pagination headers in the response. :type sysparm_suppress_pagination_header: bool :param sysparm_view: Display style ('desktop', 'mobile', or 'both'). :type sysparm_view: str

:return: Response containing list of parsed Pydantic models with information about the retrieved records. :rtype: Response

:raises MissingParameterError: If table is not provided. :raises ParameterError: If input parameters are invalid.

Get a specific record from the specified table.

:param table: The name of the table. :type table: str :param table_record_sys_id: The sys_id of the record to be retrieved. :type table_record_sys_id: str

:return: Response containing parsed Pydantic model with information about the retrieved record. :rtype: Response

:raises MissingParameterError: If table or table_record_sys_id is not provided.

Import a repository based on the provided parameters.

:param credential_sys_id: The sys_id of the credential to be used for the import. :type credential_sys_id: str :param mid_server_sys_id: The sys_id of the MID Server to be used for the import. :type mid_server_sys_id: str :param repo_url: The URL of the repository to be imported. :type repo_url: str :param branch_name: The name of the branch to be imported. :type branch_name: str :param auto_upgrade_base_app: Flag indicating whether to auto-upgrade the base app. :type auto_upgrade_base_app: bool

:return: Response containing parsed Pydantic model with information about the repository import. :rtype: Response

:raises MissingParameterError: If repo_url is not provided. :raises ParameterError: If auto_upgrade_base_app is not a boolean.

Inserts records into the Import Set table associated with the data source.

:param data_source_sys_id: Sys_id of the data source record. :type data_source_sys_id: str :param records: Array of objects to ingest. :type records: list

:return: Response containing ingestion result. :rtype: Response

Creates cost plans.

Insert a new record into the specified import set.

:param table: The name of the table associated with the import set. :type table: str :param data: Dictionary containing the field values for the new import set record. :type data: dict

:return: Response containing parsed Pydantic model with information about the inserted import set record. :rtype: Response

:raises ParameterError: If data or table is not provided. :raises ParameterError: If JSON serialization fails.

Insert multiple records into the specified import set.

:param table: The name of the table associated with the import set. :type table: str :param data: Dictionary containing the field values for multiple new import set records. :type data: dict

:return: Response containing list of parsed Pydantic models with information about the inserted import set records. :rtype: Response

:raises ParameterError: If data or table is not provided. :raises ParameterError: If JSON serialization fails.

Creates a project and associated project tasks.

Get progress information for an instance scan based on the provided progress ID.

:param progress_id: The ID associated with the instance scan progress. :type progress_id: str

:return: Response containing parsed Pydantic model with instance scan progress. :rtype: Response

:raises MissingParameterError: If progress_id is not provided.

Invoke the metricbase_insert operation.

Replaces attributes in the specified CI record (PATCH).

:param className: CMDB class name. :type className: str :param sys_id: Sys_id of the CI. :type sys_id: str :param attributes: Data attributes to replace. :type attributes: dict :param source: Discovery source. :type source: str

:return: Response containing updated CI. :rtype: Response

Partially update a record in the specified table.

:param table: The name of the table. :type table: str :param table_record_sys_id: The sys_id of the record to be updated. :type table_record_sys_id: str :param data: Dictionary containing the fields to be updated. :type data: dict

:return: Response containing parsed Pydantic model with information about the updated record. :rtype: Response

:raises MissingParameterError: If table, table_record_sys_id, or data is not provided. :raises ParameterError: If JSON serialization fails.

Initiate a point instance scan based on the provided parameters.

:param target_sys_id: The sys_id of the target instance. :type target_sys_id: str :param target_table: The table of the target instance. :type target_table: str

:return: Response containing parsed Pydantic model with information about the point scan. :rtype: Response

:raises MissingParameterError: If target_sys_id or target_table is not provided.

Processes a technical service qualification result.

Get progress information based on the provided progress ID.

:param progress_id: The ID associated with the progress. :type progress_id: str

:return: Response containing parsed Pydantic model with progress information. :rtype: Response

:raises MissingParameterError: If progress_id is not provided.

Refresh the authentication token :return: Response with new refreshed token.

:raises MissingParameterError: If the client was authenticated without OAuth client credentials (e.g. basic auth or a bearer token), so there is no client_id/client_secret to refresh with.

Refresh impacted services for a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the refreshed impacted services. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Registers an operator for a non-workflow user.

Enables orchestration tools to register artifacts into a ServiceNow instance.

Rollback a plugin based on the provided plugin_id.

:param plugin_id: The ID of the plugin to be rolled back. :type plugin_id: str

:return: Response containing parsed Pydantic model with information about the rollback. :rtype: Response

:raises MissingParameterError: If plugin_id is not provided.

Run a test suite based on the provided parameters.

:param test_suite_sys_id: The sys_id of the test suite to be run. :type test_suite_sys_id: str :param test_suite_name: The name of the test suite to be run. :type test_suite_name: str :param browser_name: The name of the browser for the test run. :type browser_name: str :param browser_version: The version of the browser for the test run. :type browser_version: str :param os_name: The name of the operating system for the test run. :type os_name: str :param os_version: The version of the operating system for the test run. :type os_version: str

:return: Response containing parsed Pydantic model with information about the test run. :rtype: Response

:raises MissingParameterError: If test_suite_sys_id or test_suite_name is not provided. :raises ParameterError: If browser_name is not a valid string.

Invoke the send_email operation.

Sets the operational state for a specified list of CIs.

Initiate a suite scan based on the provided suite_sys_id and sys_ids.

:param suite_sys_id: The sys_id of the suite to be scanned. :type suite_sys_id: str :param sys_ids: List of sys_ids representing app_scope_sys_ids for the suite scan. :type sys_ids: list :param scan_type: Type of scan to be performed (default is "scoped_apps"). :type scan_type: str

:return: Response containing parsed Pydantic model with information about the suite scan. :rtype: Response

:raises MissingParameterError: If suite_sys_id or sys_ids is not provided. :raises ParameterError: If JSON serialization fails.

Unregisters an operator for non-workflow users.

Update details of a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param name_value_pairs: New name-value pairs providing updated details for the change request. :type name_value_pairs: str or None :param change_type: Type of change (emergency, normal, standard, model). :type change_type: str or None

:return: Response containing parsed Pydantic model with information about the updated change request. :rtype: Response

:raises MissingParameterError: If change_request_sys_id or name_value_pairs is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If change_type is specified but not valid. :raises ParameterError: If JSON serialization or deserialization fails.

Update the schedule of a change request to the first available slot.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None

:return: Response containing parsed Pydantic model with information about the updated schedule. :rtype: Response

:raises MissingParameterError: If change_request_sys_id is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON deserialization fails.

Update details of a task associated with a change request.

:param change_request_sys_id: Sys ID of the change request. :type change_request_sys_id: str or None :param change_request_task_sys_id: Sys ID of the change request task. :type change_request_task_sys_id: str or None :param name_value_pairs: New name-value pairs providing updated details for the task. :type name_value_pairs: str or None

:return: Response containing parsed Pydantic model with information about the updated task. :rtype: Response

:raises MissingParameterError: If change_request_sys_id, change_request_task_sys_id, or name_value_pairs is not provided. :raises ParameterError: If invalid parameters or responses are encountered. :raises ParameterError: If JSON serialization or deserialization fails.

Updates the specified CI record (PUT).

:param className: CMDB class name. :type className: str :param sys_id: Sys_id of the CI. :type sys_id: str :param attributes: Data attributes to replace. :type attributes: dict :param source: Discovery source. :type source: str

:return: Response containing updated CI. :rtype: Response

Update an existing incident record.

:param incident_id: The sys_id of the incident record to update. :type incident_id: str :param data: Dictionary of field values to update. :type data: dict

:return: Response containing parsed Pydantic model with information about the updated incident record. :rtype: Response

:raises MissingParameterError: If incident_id or data is not provided. :raises ParameterError: If validation of parameters fails.

Update an existing problem record.

:param problem_id: The sys_id of the problem record to update. :type problem_id: str :param data: Dictionary of field values to update. :type data: dict

:return: Response containing parsed Pydantic model with information about the updated problem record. :rtype: Response

:raises MissingParameterError: If problem_id or data is not provided. :raises ParameterError: If validation of parameters fails.

Backs out an installation operation that was performed on an update set with a given sys_id.

:param update_set_id: Sys_id of the update set. :type update_set_id: str :param rollback_installs: Flag that indicates whether to rollback the batch installation performed during the update set commit. :type rollback_installs: bool

:return: Response containing parsed Pydantic model with progress information about the back out. :rtype: Response

:raises MissingParameterError: If update_set_id is not provided.

Commits an update set with a given sys_id.

:param remote_update_set_id: Sys_id of the update set to commit. :type remote_update_set_id: str :param force_commit: Flag that indicates whether to force commit the update set. :type force_commit: str

:return: Response containing parsed Pydantic model with progress information about the commit. :rtype: Response

:raises MissingParameterError: If remote_update_set_id is not provided.

Commits multiple update sets in a single request according to the order that they're provided.

:param remote_update_set_ids: List of sys_ids associated with any update sets to commit. Sys_ids are committed in the order given in the request. :type remote_update_set_ids: str :param force_commit: Flag that indicates whether to force commit the update set. :type force_commit: str

:return: Response containing parsed Pydantic model with progress information about the multiple commits. :rtype: Response

:raises MissingParameterError: If remote_update_set_ids is not provided.

Creates a new update set and inserts the new record in the Update Sets [sys_update_set] table.

:param update_set_name: Name to give the update set. :type update_set_name: str :param description: Description of the update set. :type description: str :param scope: The scope name of the application in which to create the new update set. :type scope: str :param sys_id: Sys_id of the application in which to create the new update set. :type sys_id: str

:return: Response containing parsed Pydantic model with information about the created update set. :rtype: Response

:raises MissingParameterError: If update_set_name is not provided or both sys_id and scope are not provided.

Previews an update set to check for any conflicts and retrieve progress information about the update set operation.

:param remote_update_set_id: Sys_id of the update set to preview. :type remote_update_set_id: str

:return: Response containing parsed Pydantic model with progress information about the preview. :rtype: Response

:raises MissingParameterError: If remote_update_set_id is not provided.

Retrieves an update set with a given sys_id and allows you to remove the existing retrieved update set from the instance.

:param update_set_id: Sys_id of the update set on the source instance from where the update set was retrieved. :type update_set_id: str :param update_source_id: Sys_id of the remote instance record. :type update_source_id: str :param update_source_instance_id: Instance ID of the remote instance. :type update_source_instance_id: str :param auto_preview: Flag that indicates whether to automatically preview the update set after retrieval. :type auto_preview: bool :param cleanup_retrieved: Flag that indicates whether to remove the existing retrieved update set from the instance. :type cleanup_retrieved: bool

:return: Response containing parsed Pydantic model with progress information about the retrieval. :rtype: Response

:raises MissingParameterError: If update_set_id is not provided.

Fully update a record in the specified table.

:param table: The name of the table. :type table: str :param table_record_sys_id: The sys_id of the record to be updated. :type table_record_sys_id: str :param data: Dictionary containing the fields to be updated. :type data: dict

:return: Response containing parsed Pydantic model with information about the updated record. :rtype: Response

:raises MissingParameterError: If table, table_record_sys_id, or data is not provided. :raises ParameterError: If JSON serialization fails.

Upload a file as an attachment on a table record.

Accepts either a server-local file_path (back-compat) or inline base64-encoded data (via AttachmentModel) — the latter is written to a temp file server-side for the upload and cleaned up afterward, so JSON-only MCP tool callers can upload without a filesystem path.

:param file_path: Path to a file on disk to upload. Mutually exclusive with data; takes precedence if both are given. :type file_path: str or None

:raises MissingParameterError: If table_name, table_sys_id, or file_name is missing, or if neither file_path nor data is provided.

Generates a Mermaid diagram representing the relationships between ServiceNow flows and subflows.

:param flow_identifiers: List of flow names or sys_ids to use as roots. If None, fetches all active flows. :param max_depth: Maximum recursion depth for subflow discovery. :param save_to_file: Whether to save the result to a markdown file. :param output_dir: Directory to save the report. Defaults to project/servicenow_flow_reports. :param mermaid_name: Base name for the generated file (used if destination_file is not provided). :param segment_by_root: If True, generates a separate diagram for each root flow. :param destination_file: Explicit full path to save the markdown report.

Configure instance authentication (now-sdk auth).

A password is piped via stdin with --password-stdin and is never placed in argv or in the returned command echo.

Compile Fluent sources into an installable package (now-sdk build).

Download configured dependencies + type defs (now-sdk dependencies).

Install/update the app on the target instance (now-sdk install, alias deploy).

Scaffold a new scoped app / Fluent project (now-sdk init, alias create).

Download + convert XML records into Fluent source (now-sdk transform).