Datascope Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Datascope location.

Datascope

Create a Datascope Destination

1. Click the + icon on the Nexset that will be sent to the Datascope destination, and select the Send to Destination option from the menu.

2. Select the Datascope connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Datascope account, and click Next; or, create a new Datascope credential for use in this flow.

3. In Nexla, Datascope destinations can be created using pre-built endpoint templates, which expedite destination setup for common Datascope write endpoints. Each template is designed specifically for the corresponding Datascope endpoint, making destination configuration easy and efficient.
   • To configure this destination using a template, follow the instructions in Configure Using a Template.

   Datascope destinations can also be configured manually, allowing you to send data to Datascope endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Datascope endpoints. Each template is designed specifically for the corresponding Datascope endpoint, making destination setup easy and efficient.

• To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

  Change Form Answer

  Modifies a previously submitted form answer in Datascope. Use this endpoint to update specific question values in existing form submissions — for example, to correct data entry errors, update statuses, or enrich answers with information from other systems.

  • The request body must contain the following fields to identify and update the target answer:

    • form_name: The name of the form that contains the answer to be modified.
    • form_code: The unique code identifying the specific form submission.
    • question_name: The name of the question whose answer should be modified.
    • question_value: The new value to set for the specified question.
    • subform_index (optional): If the question belongs to a subform (repeating section), specify the index of the subform instance to target.
  • Ensure that the field names in your Nexset match the expected body fields above, or use Nexla's data transformation features to map your data to the required structure before sending to this endpoint.

  This endpoint modifies an existing form submission — it does not create new submissions. Ensure that the form_code value in your data corresponds to an existing submission in your Datascope account.

  Create Location

  Creates a new location in your Datascope account. Use this endpoint to programmatically add locations — such as customer sites, inspection points, or store branches — from data in another system, keeping your Datascope location catalogue in sync with your source of truth.

  • The request body should include the following fields:

    • name: The display name of the new location (required).
    • code: A unique identifier code for the location.
    • address: The street address of the location.
    • latitude and longitude: GPS coordinates of the location, enabling geolocation features in the Datascope mobile app.
    • Contact fields: Contact name, phone, and email for the location.
    • Company information (optional): Company name and related fields if the location is associated with a specific organization.
  • Ensure that your Nexset contains a record for each location to be created, with fields mapped to the expected structure above.

  Update Location

  Updates an existing location in your Datascope account by its numeric ID. Use this endpoint to keep location records current when address, contact, or company details change in your source system.

  • This endpoint requires the following configuration parameter:

    • Location ID: Enter the numeric ID of the Datascope location to update. Location IDs can be retrieved using the List Locations data source endpoint. This ID is appended to the API URL to target the specific location record.
  • The request body fields mirror the Create Location payload (name, code, address, latitude, longitude, contact details, and optional company information). Include only the fields that need to be updated.

  Use the Datascope List Locations source endpoint in Nexla to retrieve current location IDs before configuring this destination. The Location ID must correspond to an existing location in your Datascope account.

  Create Metadata Object

  Creates a new list element (metadata object) under a specified metadata type (list) in your Datascope account. Use this endpoint to add new items to your Datascope reference lists — such as new products, clients, or other custom list types — from data in external systems.

  • This endpoint requires the following configuration parameter:

    • Metadata Type: Enter the name of the metadata list (list type) under which the new element should be created. This corresponds to the metadata_type field in the Datascope API (e.g., products, clients).

  • The request body should include the following list_object fields for the new element:

    • name: The display name of the new list element (required).
    • code: A unique identifier code for the element.
    • description: A brief description of the element.
    • attribute1 and attribute2: Optional custom attribute values for additional metadata fields.

  Use the List Metadata Objects source endpoint to verify existing metadata types and elements in your Datascope account before creating new ones, to avoid duplicates.

  Update Metadata Object

  Updates an existing metadata list element in your Datascope account by its numeric ID. Use this endpoint to keep your Datascope reference lists in sync with an authoritative source system when list item details change.

  • This endpoint requires the following configuration parameter:

    • Metadata Object ID: Enter the numeric ID of the metadata list element to update. Element IDs can be retrieved using the List Metadata Objects data source endpoint.
  • The request body fields mirror the Create Metadata Object payload (list_object fields: name, code, description, attribute1, attribute2). Include only the fields that need to be updated.

  Create Metadata Type (List)

  Creates a new empty metadata list (metadata type) in your Datascope account. Use this endpoint to programmatically provision new reference lists in Datascope, which can then be populated with elements using the Create Metadata Object endpoint.

  • The request body should include the following fields:

    • name: The display name of the new list (required).
    • description: A brief description of the list's purpose.
    • code: A unique identifier code for the list.
    • list_type: The type classification of the list, as defined in Datascope.
  • The API response returns the created list object, including the system-generated numeric ID that can be used to reference this list in subsequent operations.

  Update Metadata Type (List)

  Updates an existing metadata list (metadata type) in your Datascope account by its numeric ID. Use this endpoint to modify list properties such as the name, description, or code of an existing reference list.

  • This endpoint requires the following configuration parameter:

    • Metadata Type ID: Enter the numeric ID of the metadata list (metadata type) to update. List IDs can be retrieved from the Datascope account or by first creating the list using the Create Metadata Type endpoint.
  • The request body fields mirror the Create Metadata Type payload (name, description, code, list_type).

  Bulk Update Metadata Objects

  Replaces or upserts multiple metadata list elements in a single API call. Use this endpoint for bulk synchronization scenarios where you need to refresh an entire reference list (such as a product catalogue or client list) from an external system in one operation.

  • The request body must include the following fields:

    • metadata_type: The name of the metadata list (list type) to update.
    • name: The display name of the list.
    • list_objects: An array of list element objects to upsert. Each element should include: code (unique identifier), name, description, attribute1, and attribute2.
  • This endpoint replaces or upserts all elements provided in the list_objects array. Use with care in production environments, as it can overwrite existing list data.

  The Bulk Update Metadata Objects endpoint is the most efficient way to synchronize large reference lists between an external system and Datascope. For adding or modifying individual elements, use the Create Metadata Object or Update Metadata Object endpoints instead.

  Assign Task

  Creates a task assignment in Datascope, assigning a specific form to a user for completion at a given location on a specified date. Use this endpoint to automate task dispatching — for example, scheduling inspections or work orders based on data from an external planning or scheduling system.

  • The request body should include the following fields:

    • form_id: The numeric ID of the Datascope form to be completed as part of this task.
    • user_id: The numeric ID of the Datascope user to whom the task is assigned.
    • date: The date on which the task should be completed, in yyyy-MM-dd format.
    • Location and contact fields: Location ID or address details for where the task should be performed.
    • task_instruction (optional): Free-text instructions for the assigned user.
    • gap (optional): Time gap or interval setting for recurring task scheduling.
    • code (optional): A custom identifier code for the task assignment.
  • Ensure that the form_id and user_id values in your Nexset correspond to valid forms and users in your Datascope account. Use the Datascope List Task Assigns source endpoint to verify existing assignments and IDs.

  Task assignments created via this endpoint appear immediately in the assigned user's Datascope mobile app task list. Ensure that task dates and form assignments are correct before activating this destination flow.

Configure Manually

Datascope destinations can be manually configured to send data to any valid Datascope External API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Datascope API after each call to a new Nexla webhook data source.

API Method

1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Datascope API from the Method pulldown menu. All Datascope External API write endpoints use:

   • POST: For creating new records or modifying existing records (used for all Datascope destination endpoints)

Data Format

3. Select the format in which the Nexset data will be sent to the Datascope API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. Datascope's External API accepts data in JSON format (application/json).

API Endpoint URL

4. Enter the URL of the Datascope External API endpoint to which you want to send the Nexset data in the URL field. All Datascope External API write endpoints begin with https://www.mydatascope.com/api/external/. For update operations, include the numeric ID of the object to be updated at the end of the URL.

For a complete list of available Datascope External API write endpoints and their required body parameters, refer to the DataScope API documentation and the DataScope API Reference.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

  You do not need to include the Authorization header here — it is automatically applied from your Datascope credential. The Datascope External API uses the Authorization header for all authentication, which Nexla handles automatically.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this Datascope destination, select the attributes from the Exclude Attributes pulldown menu.

• Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional

1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Most Datascope External API write endpoints accept a single JSON object per request (not batched arrays). Check the Datascope API documentation for the specific endpoint you are using to confirm whether batch payloads are supported. The Bulk Update Metadata Objects endpoint is designed for batch operations and accepts an array of objects in the list_objects field.

Response Webhook

Optional

Nexla can automatically send the response received from the Datascope API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

• To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the Datascope API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

• Click on a sample request payload to expand it and view the complete payload content.
• Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)

After all endpoint settings have been configured, Nexla can send a test payload to the Datascope API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Datascope API using the current settings.

Save & Activate the Destination

• Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Datascope endpoint, open the destination resource menu, and select Activate.

  The Nexset data will not be sent to Datascope until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.