Batch Get

POST

https://api.gov.nominal.io/api/scout/v2/notebook/batch-get

POST

/api/scout/v2/notebook/batch-get

1 curl -X POST https://api.gov.nominal.io/api/scout/v2/notebook/batch-get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '[
5   "string"
6 ]'

Try it

200Successful

1 [
2   {
3     "rid": "rid",
4     "snapshotRid": "snapshotRid",
5     "snapshotAuthorRid": "snapshotAuthorRid",
6     "snapshotCreatedAt": "2024-01-15T09:30:00Z",
7     "metadata": {
8       "dataScope": {
9         "type": "runRids",
10         "runRids": [
11           "dataScope"
12         ]
13       },
14       "notebookType": "WORKBOOK",
15       "title": "title",
16       "description": "description",
17       "isDraft": true,
18       "isArchived": true,
19       "lock": {
20         "isLocked": true,
21         "updatedAt": "2024-01-15T09:30:00Z",
22         "updatedByRid": "updatedByRid"
23       },
24       "createdByRid": "createdByRid",
25       "createdAt": "2024-01-15T09:30:00Z",
26       "properties": {
27         "properties": "properties"
28       },
29       "labels": [
30         "labels"
31       ],
32       "runRid": "runRid"
33     },
34     "stateAsJson": "stateAsJson",
35     "layout": {
36       "type": "v1",
37       "v1": {
38         "rootPanel": {
39           "type": "viz",
40           "viz": {
41             "type": "v1",
42             "v1": {
43               "id": "id",
44               "vizId": "vizId",
45               "hideLegend": true
46             }
47           }
48         }
49       }
50     },
51     "contentV2": {
52       "type": "workbook",
53       "workbook": {
54         "channelVariables": {
55           "channelVariables": {
56             "variableName": "variableName",
57             "computeSpec": {
58               "type": "v1",
59               "v1": "computeSpec"
60             },
61             "displayName": "displayName",
62             "computeSpecV2": {
63               "computeNode": {
64                 "type": "raw",
65                 "raw": {
66                   "name": "name"
67                 }
68               },
69               "context": {
70                 "variables": {}
71               }
72             }
73           }
74         },
75         "charts": {
76           "charts": {
77             "type": "cartesian",
78             "cartesian": {
79               "type": "v1",
80               "v1": {
81                 "plots": [
82                   {
83                     "xVariableName": "xVariableName",
84                     "yVariableName": "yVariableName",
85                     "xAxisId": "xAxisId",
86                     "yAxisId": "yAxisId",
87                     "color": "color"
88                   },
89                   {
90                     "xVariableName": "xVariableName",
91                     "yVariableName": "yVariableName",
92                     "xAxisId": "xAxisId",
93                     "yAxisId": "yAxisId",
94                     "color": "color"
95                   }
96                 ],
97                 "events": [
98                   {
99                     "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
100                     "isPinned": true
101                   },
102                   {
103                     "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
104                     "isPinned": true
105                   }
106                 ],
107                 "comparisonRunGroups": [],
108                 "valueAxes": [],
109                 "title": "title"
110               }
111             }
112           }
113         }
114       }
115     },
116     "eventRefs": [
117       {
118         "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
119       }
120     ],
121     "checkAlertRefs": [
122       {
123         "checkAlertRid": "checkAlertRid"
124       }
125     ],
126     "charts": [
127       {
128         "rid": "rid",
129         "version": 1,
130         "overlays": {
131           "key": "value"
132         }
133       },
134       {
135         "rid": "rid",
136         "version": 1,
137         "overlays": {
138           "key": "value"
139         }
140       }
141     ],
142     "content": {
143       "channelVariables": {
144         "channelVariables": {
145           "variableName": "variableName",
146           "computeSpec": {
147             "type": "v1",
148             "v1": "computeSpec"
149           },
150           "displayName": "displayName",
151           "computeSpecV2": {
152             "computeNode": {
153               "type": "raw",
154               "raw": {
155                 "name": "name"
156               }
157             },
158             "context": {
159               "variables": {}
160             }
161           }
162         }
163       },
164       "charts": {
165         "charts": {
166           "type": "cartesian",
167           "cartesian": {
168             "type": "v1",
169             "v1": {
170               "plots": [
171                 {
172                   "xVariableName": "xVariableName",
173                   "yVariableName": "yVariableName",
174                   "xAxisId": "xAxisId",
175                   "yAxisId": "yAxisId",
176                   "color": "color"
177                 },
178                 {
179                   "xVariableName": "xVariableName",
180                   "yVariableName": "yVariableName",
181                   "xAxisId": "xAxisId",
182                   "yAxisId": "yAxisId",
183                   "color": "color"
184                 }
185               ],
186               "events": [
187                 {
188                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
189                   "isPinned": true
190                 },
191                 {
192                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
193                   "isPinned": true
194                 }
195               ],
196               "comparisonRunGroups": [],
197               "valueAxes": [],
198               "title": "title"
199             }
200           }
201         }
202       }
203     }
204   }
205 ]

Request

This endpoint expects a set of strings.

Response

This endpoint returns a set of objects.

ridstring

snapshotRidstring

snapshotAuthorRidstring

snapshotCreatedAtdatetime

metadataobject

stateAsJsonstring

layoutobject

contentV2object

eventRefsset of objects

checkAlertRefsset of objects

chartslist of objectsOptional

contentobjectOptional

Headers

Request

Response