Datascope connects to a Nagent workspace with an API key. Once it is connected, agents can call 19 Datascope actions, such as "Create List", "Create List Element" and "Create Location". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Datascope, with input parameters and output schema.
DATASCOPE_CHANGE_FORM_ANSWERTool to change a specific answer in a submitted form. Use when you need to modify question values after a form has been submitted.
Input parameters
Code of the form response/submission to modify.
Name or ID of the form containing the answer to change.
Name of the question whose answer should be changed.
Subform index number (starting from 1) if the question is inside a subform. Leave blank for questions not in subforms.
New value to set for the specified question.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_CREATE_LISTTool to create a new empty list (metadata type) in DataScope with specified list_type. Use when you need to create a container for list elements like products, locations, or other categorized items.
Input parameters
List data object containing all list details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_CREATE_LIST_ELEMENTTool to create a new list element in a specific metadata list identified by metadata_type. Use when you need to add a new element to a list. For location objects, use the locations API instead.
Input parameters
List object containing element details
Internal code to identify the list (products, and more). For locations objects use locations API
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_CREATE_LOCATIONTool to create a new location in DataScope with geographic coordinates. Use when you need to register a physical location with name and code identifiers.
Input parameters
Location data object containing all location details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_CREATE_TASK_ASSIGNTool to create a task assignment for a specific form, user, and location with a deadline. Use when you need to assign a form to be completed by a specific user at a specific location and time.
Input parameters
Number of hours allocated to perform the task.
Custom code to identify or track the task.
Date and time of the assigned task in format YYYY-mm-dd HH:MM (e.g., '2026-02-20 10:00').
Company tax identifier or code associated with the location.
Company name associated with the location.
Code identifier of the Location where the task should be performed.
Internal identifier of the Form. ID in the URL https://www.mydatascope.com/task_forms/\[ID\]/edit
Email address of the Location.
Phone number of the Location.
User Email to whom the task is assigned.
GPS latitude coordinate of the location.
GPS longitude coordinate of the location.
Name of the location. Only needed if you need to create or update the location.
Physical address of the Location.
Instructions or notes for completing the task.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_ALL_LIST_ELEMENTSTool to retrieve all items from a specific metadata list in Datascope. Use when you need to fetch all elements belonging to a particular list type (products, locations, customers, etc.).
Input parameters
Internal code to identify the list (e.g., products, locations, etc.). This is required to specify which metadata list to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_ALL_LOCATIONSTool to retrieve all locations configured in the DataScope system. Use when you need to access location data including addresses, coordinates, and company associations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_ANSWERS_V4Tool to retrieve form answers using the v4 API endpoint. Use when you need to fetch form submissions from DataScope with the latest API version. Supports filtering by user, date range, location, and pagination for retrieving large result sets.
Input parameters
End of date range for results in ISO 8601 format (e.g., '2024-12-31T23:59:59Z'). Default is today if not provided.
Number of submissions to return. Default is 200. Maximum allowed value is 200.
Beginning of date range for results in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Default is last 7 days if not provided.
Pagination parameter for additional batches. Default is 0. Use this to retrieve subsequent pages of results.
The ID of the form to retrieve answers for. This parameter is required.
Filters results to responses from one specific user. If not provided, answers from all users are returned.
Filters to answers from a specific location. If not provided, answers from all locations are returned.
When true, returns only modified forms or new submissions. Default is false if not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_ANSWERS_WITH_FULL_METADATATool to retrieve last form answers with full metadata from DataScope (limit 600 results). Returns detailed response structure including answers array with question types, metadata references, and assignment information. Use when you need comprehensive answer data with question-level details and metadata associations.
Input parameters
Set the end date range. Default is today if not provided. Use ISO 8601 format or date format.
Set the start date range. Default is last 7 days if not provided. Use ISO 8601 format or date format.
If set, only get values of one form. When not provided, answers from all forms are returned.
If set, get values of only one user. This is a string identifier for the user.
Set to get answers of only one location. When not provided, answers from all locations are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_FORM_SCHEMATool to retrieve the schema definition for a specific form by its form ID. Use when you need to understand the structure of a form including all questions, field types, and configurations.
Input parameters
Unique identifier of the form to retrieve the schema for. Can be found in Configure > Configure App section.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_FORMS_LISTTool to retrieve all available forms/tasks from the DataScope system. Use when you need to get a list of forms that can be assigned or filled out.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_LAST_TICKETSTool to retrieve the last 5 tickets (findings) from the DataScope system. Use when you need to view recent tickets or findings.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_LIST_ELEMENTTool to retrieve a specific element from a metadata list by type and ID. Use when you need to fetch detailed information about a specific list element such as locations, products, or other metadata objects.
Input parameters
Internal identifier of the element of the list
Internal code to identify the list (e.g., 'products', 'locations', etc.)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_GET_TICKET_TYPESTool to retrieve available ticket types (findings types) from the DataScope system. Use when you need to access the list of ticket type configurations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_LIST_LAST_GENERATED_FILESTool to retrieve all generated files (PDFs, Excel) from a specific date range. Use when you need to access recently generated files within the last 90 days. Date format is MM/DD/YYYY.
Input parameters
Conclusion of the date range for file retrieval. Format: DD/MM/YYYY (e.g., '19/12/2019' for December 19, 2019). Defaults to today if not provided. Maximum date range is 90 days.
Beginning of the date range for file retrieval. Format: DD/MM/YYYY (e.g., '10/12/2019' for December 10, 2019). Defaults to last 7 days if not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_LIST_NOTIFICATIONSTool to retrieve all notifications (PDF and Excel files) from a date range. Use when you need to access notification details including type, URL, form information, and timestamps.
Input parameters
Set the end date range. Format should match the API requirements. Defaults to today if not provided.
Set the start date range. Format should match the API requirements. Defaults to last 7 days if not provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_UPDATE_BULK_LIST_ELEMENTSTool to bulk update metadata list objects with soft deletion of objects not in the incoming list. Use when you need to replace all objects in a metadata list. WARNING: This operation deletes all existing objects for the specified metadata_type and replaces them with new objects. Experimental endpoint.
Input parameters
Name of the list to be created or updated.
Array of objects to be created or updated. WARNING: All existing objects for this metadata_type will be soft-deleted and replaced with these objects. Objects with existing codes will be updated; new codes will create new objects.
Internal code to identify the list to update. WARNING: Cannot be 'locations'. This identifies which metadata list to bulk update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_UPDATE_LIST_ELEMENTTool to update an existing list element by ID with new name, description, code, or attributes. Use when you need to modify properties of a specific metadata object in DataScope.
Input parameters
The ID of the list element to update
List object containing updated element details
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DATASCOPE_UPDATE_LOCATIONTool to update an existing location in DataScope by ID. Use when you need to modify location details such as name, address, coordinates, or company information.
Input parameters
The ID of the location to update.
Location data object containing updated location details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 19 Datascope actions on Nagent, including "Create List", "Create List Element" and "Create Location". Create List: Create a new empty list (metadata type) in DataScope with specified list_type. Each action is listed on this page with its input parameters and its output.
Datascope connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create List takes 1 required input: list. It returns data, error and successful.