Signals Notebook: How to identify the order of all attachments when exporting experiments to PDF?

Description

As administrator for archiving purposes we need to extract and render the experiment attachments in the same order they are placed in the experiment.

Solution

Use the layout API endpoint GET/entities/{eid}/layout/pages to obtain a list of the location of the attachments by page in the experiment.

Steps

1. Log into Signals Notebook as an administrator
2. Obtain the eid of the experiment
3. Navigate to the Signals Notebook APIs Document Swagger UI page
4. Expand the ‘Entities’ section
5. Expand the ‘GET/entities/{eid}/layout/pages’ endpoint and click ‘Try it Out’
6. In the eid box introduce the experiment's eid
7. Click ‘Execute’
8. Look for the attributes section of each page in the response:
"attributes": {
       "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
       "type": "layoutPage",
       "name": "Page",
       "index": 0,
       "entities": [
         {
           "entityEid": "excel:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
           "entityName": "One",
           "index": 0
         },
         {
           "entityEid": "presentation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
           "entityName": "Two",
           "index": 1
         },
         {
           "entityEid": "viewonly:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
           "entityName": "Three",
           "index": 2
         }
       ]
     }

NOTE

The index value starts at 0 so the first entity will have an index value of 0, the second a value of 1 and so on.