Update

PUT

https://api.gov.nominal.io/api/scout/v2/notebook/:rid

PUT

/api/scout/v2/notebook/:rid

1 curl -X PUT https://api.gov.nominal.io/api/scout/v2/notebook/rid \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "stateAsJson": "stateAsJson",
6   "layout": {
7     "type": "v1",
8     "v1": {
9       "rootPanel": {
10         "type": "viz",
11         "viz": {
12           "type": "v1",
13           "v1": {
14             "id": "id",
15             "vizId": "vizId",
16             "hideLegend": true
17           }
18         }
19       }
20     }
21   },
22   "eventRefs": [
23     {}
24   ]
25 }'

Try it

200Updated

1 {
2   "rid": "rid",
3   "snapshotRid": "snapshotRid",
4   "snapshotAuthorRid": "snapshotAuthorRid",
5   "snapshotCreatedAt": "2024-01-15T09:30:00Z",
6   "metadata": {
7     "dataScope": {
8       "type": "runRids",
9       "runRids": [
10         "dataScope"
11       ]
12     },
13     "notebookType": "WORKBOOK",
14     "title": "title",
15     "description": "description",
16     "isDraft": true,
17     "isArchived": true,
18     "lock": {
19       "isLocked": true,
20       "updatedAt": "2024-01-15T09:30:00Z",
21       "updatedByRid": "updatedByRid"
22     },
23     "createdByRid": "createdByRid",
24     "createdAt": "2024-01-15T09:30:00Z",
25     "properties": {
26       "properties": "properties"
27     },
28     "labels": [
29       "labels"
30     ],
31     "runRid": "runRid"
32   },
33   "stateAsJson": "stateAsJson",
34   "layout": {
35     "type": "v1",
36     "v1": {
37       "rootPanel": {
38         "type": "viz",
39         "viz": {
40           "type": "v1",
41           "v1": {
42             "id": "id",
43             "vizId": "vizId",
44             "hideLegend": true
45           }
46         }
47       }
48     }
49   },
50   "contentV2": {
51     "type": "workbook",
52     "workbook": {
53       "channelVariables": {
54         "channelVariables": {
55           "variableName": "variableName",
56           "computeSpec": {
57             "type": "v1",
58             "v1": "computeSpec"
59           },
60           "displayName": "displayName",
61           "computeSpecV2": {
62             "computeNode": {
63               "type": "enum",
64               "enum": {
65                 "type": "raw",
66                 "raw": {
67                   "name": "name"
68                 }
69               }
70             },
71             "context": {
72               "variables": {
73                 "variables": {
74                   "type": "variable",
75                   "variable": "variables"
76                 }
77               }
78             }
79           }
80         }
81       },
82       "charts": {
83         "charts": {
84           "type": "cartesian",
85           "cartesian": {
86             "type": "v1",
87             "v1": {
88               "plots": [
89                 {
90                   "xVariableName": "xVariableName",
91                   "yVariableName": "yVariableName",
92                   "xAxisId": "xAxisId",
93                   "yAxisId": "yAxisId",
94                   "color": "color",
95                   "enabled": true
96                 },
97                 {
98                   "xVariableName": "xVariableName",
99                   "yVariableName": "yVariableName",
100                   "xAxisId": "xAxisId",
101                   "yAxisId": "yAxisId",
102                   "color": "color",
103                   "enabled": true
104                 }
105               ],
106               "comparisonRunGroups": [
107                 {
108                   "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
109                   "name": "name",
110                   "offset": {
111                     "value": 1000000,
112                     "unit": "DAYS"
113                   },
114                   "offsetAnchor": {
115                     "type": "run",
116                     "run": {}
117                   },
118                   "runs": [],
119                   "color": "color"
120                 },
121                 {
122                   "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
123                   "name": "name",
124                   "offset": {
125                     "value": 1000000,
126                     "unit": "DAYS"
127                   },
128                   "offsetAnchor": {
129                     "type": "run",
130                     "run": {}
131                   },
132                   "runs": [],
133                   "color": "color"
134                 }
135               ],
136               "valueAxes": [
137                 {
138                   "id": "id",
139                   "title": "title",
140                   "displayOptions": {
141                     "showTitle": true
142                   },
143                   "range": {},
144                   "limit": {},
145                   "position": "LEFT",
146                   "domainType": "NUMERIC"
147                 },
148                 {
149                   "id": "id",
150                   "title": "title",
151                   "displayOptions": {
152                     "showTitle": true
153                   },
154                   "range": {},
155                   "limit": {},
156                   "position": "LEFT",
157                   "domainType": "NUMERIC"
158                 }
159               ],
160               "events": [
161                 {
162                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
163                   "isPinned": true
164                 },
165                 {
166                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
167                   "isPinned": true
168                 }
169               ],
170               "title": "title"
171             }
172           }
173         }
174       }
175     }
176   },
177   "eventRefs": [
178     {
179       "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
180       "rid": "rid"
181     }
182   ],
183   "charts": [
184     {
185       "rid": "rid",
186       "version": 1,
187       "overlays": {
188         "key": "value"
189       }
190     },
191     {
192       "rid": "rid",
193       "version": 1,
194       "overlays": {
195         "key": "value"
196       }
197     }
198   ],
199   "content": {
200     "channelVariables": {
201       "channelVariables": {
202         "variableName": "variableName",
203         "computeSpec": {
204           "type": "v1",
205           "v1": "computeSpec"
206         },
207         "displayName": "displayName",
208         "computeSpecV2": {
209           "computeNode": {
210             "type": "enum",
211             "enum": {
212               "type": "raw",
213               "raw": {
214                 "name": "name"
215               }
216             }
217           },
218           "context": {
219             "variables": {
220               "variables": {
221                 "type": "variable",
222                 "variable": "variables"
223               }
224             }
225           }
226         }
227       }
228     },
229     "charts": {
230       "charts": {
231         "type": "cartesian",
232         "cartesian": {
233           "type": "v1",
234           "v1": {
235             "plots": [
236               {
237                 "xVariableName": "xVariableName",
238                 "yVariableName": "yVariableName",
239                 "xAxisId": "xAxisId",
240                 "yAxisId": "yAxisId",
241                 "color": "color",
242                 "enabled": true
243               },
244               {
245                 "xVariableName": "xVariableName",
246                 "yVariableName": "yVariableName",
247                 "xAxisId": "xAxisId",
248                 "yAxisId": "yAxisId",
249                 "color": "color",
250                 "enabled": true
251               }
252             ],
253             "comparisonRunGroups": [
254               {
255                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
256                 "name": "name",
257                 "offset": {
258                   "value": 1000000,
259                   "unit": "DAYS"
260                 },
261                 "offsetAnchor": {
262                   "type": "run",
263                   "run": {}
264                 },
265                 "runs": [],
266                 "color": "color"
267               },
268               {
269                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
270                 "name": "name",
271                 "offset": {
272                   "value": 1000000,
273                   "unit": "DAYS"
274                 },
275                 "offsetAnchor": {
276                   "type": "run",
277                   "run": {}
278                 },
279                 "runs": [],
280                 "color": "color"
281               }
282             ],
283             "valueAxes": [
284               {
285                 "id": "id",
286                 "title": "title",
287                 "displayOptions": {
288                   "showTitle": true
289                 },
290                 "range": {},
291                 "limit": {},
292                 "position": "LEFT",
293                 "domainType": "NUMERIC"
294               },
295               {
296                 "id": "id",
297                 "title": "title",
298                 "displayOptions": {
299                   "showTitle": true
300                 },
301                 "range": {},
302                 "limit": {},
303                 "position": "LEFT",
304                 "domainType": "NUMERIC"
305               }
306             ],
307             "events": [
308               {
309                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
310                 "isPinned": true
311               },
312               {
313                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
314                 "isPinned": true
315               }
316             ],
317             "title": "title"
318           }
319         }
320       }
321     }
322   },
323   "checkAlertRefs": [
324     {
325       "checkAlertRid": "checkAlertRid"
326     }
327   ]
328 }

Updates the contents of a workbook.

Path parameters

ridstringRequired

Request

This endpoint expects an object.

stateAsJsonstringRequired

layoutobjectRequired

eventRefsset of objectsRequired

Replace existing pinned events on the workbook.

chartslist of objectsOptional

contentobjectOptional

contentV2objectOptional

Optional for backcompatibility

latestSnapshotRidstringOptional

If provided, will only update the notebook if the latest snapshot matches the provided snapshot rid, and throws SaveNotebookConflict otherwise.

checkAlertRefsset of objectsOptional

Field to pin check alerts to a workbook on creation. If not provided, will keep the set of check alerts on the workbook unchanged. Providing an empty set will remove all check alerts from the workbook. Any specified CheckAlertReference will be added to the workbook along with it’s corresponding EventReference.

Response

This endpoint returns an object.

ridstring

snapshotRidstring

snapshotAuthorRidstring

snapshotCreatedAtdatetime

metadataobject

stateAsJsonstring

layoutobject

contentV2object

eventRefsset of objects