Signals Notebook: Retrieving Entities that are created from a specific System Template via API

Since Signals Notebook v24.4, you can search entities (Experiments, Tables etc.) that are created from a specific System Template by using the filter “Origin Template” on the Signals Notebook GUI.

This article shows how to do the same search by Signals Notebook API.

API and Search Parameter

You can use the following API and the request body to retrieve a list of Entities that are derived from the System Template identified by "<Template EID>"

• Method and Path: POST /api/rest/v1.0/entities/search
• Request Body: (please replace "<Template EID>" with a real template EID in the sample JSON below.)

{
  "query": {
    "$match": {
      "field": "system.Origin Template",
      "in": "tags",
      "value": "<Template EID>",
      "mode": "keyword"
    }
  }
}

Sample Call

For example, if you want to search Experiments that were derived from the Experiment Template "experiment:e647f6e1-98c1-487a-b0a0-41df1b039b1e", you can call the API below. Note that it uses an option and parameters to sort the list in "modifiedAt" descending order and limit the maximum number of returned Entities to 100.

POST /api/rest/v1.0/entities/search?source=SN&page[offset]=0&page[limit]=100

{
  "query": {
    "$match": {
      "field": "system.Origin Template",
      "in": "tags",
      "value": "experiment:e647f6e1-98c1-487a-b0a0-41df1b039b1e",
      "mode": "keyword"
    }
  },
  "options": {
    "sort": {
      "modifiedAt": "desc"
    }
  }
}

For More Information

API Document

Please visit our Open External API Document page for details by navigating your browser as follows. You can also try out the API on this page.

1. Open "Signals Configuration" app in your tenant.
2. Click on "System Settings" smart folder icon.
3. In the left-side navigation column, click on "API Key" -> "External API".
4. In the content area of the page, click on the "Open External API Document" link.
5. You will see "Signals Notebook APIs Document". Find the following API information under "Entities" section.

More about Query Language

Our Admin Guide explains the grammar of the query language by providing examples. Please open "Signals Configuration" app, and find the section "Query Operators in Search APIs". You will find detailed information about operators, fields and options that can be used in queries.