Signals Notebook: Filtering materials by library in Signals Swagger

Signals Notebook provides us with various endpoints that allow us to access information from our tenant.  One of the most versatile endpoints is the endpoint POST/entities/search, which allows us to search for entities based on a set of user-defined criteria. In this article, you'll find a step-by-step guide on how to search for materials based on their library. 

1. Access Swagger page in Signals Notebook.

2. Expand the “Entities” menu. 

3. Search for the endpoint "POST/entities/search".
   

4. Expand this endpoint and click on "Try it out".

5. For the field "Source", make sure to select the option "SN"

6. In the request body, add a query that In the request body, add a query that matches objects that are materials and also matches the desired library. Below is an example of this request body.

   {
     "query": {
       "$and": [
         {
           "$match": {
             "field": "type",
             "value": "asset",
             "mode": "keyword"
           }
         },
         {
           "$match": {
             "field": "assetTypeEid",
             "value": "assetType:YOUR_LIBRARY_EID",
             "mode": "keyword"
           }
         }
       ]
     }
   }

   Note: This is just an example and can be modified to suit the search criteria.

7. Click on "execute".
8. Once you receive a 200 (OK) response body, you'll be able to see the results of your search.

Once you have completed this process, you will have successfully searched for materials based on the library to which they belong.