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       "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
25     }
26   ],
27   "checkAlertRefs": [
28     {
29       "checkAlertRid": "checkAlertRid"
30     }
31   ]
32 }'

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               "events": [
107                 {
108                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
109                   "isPinned": true,
110                   "displayName": "displayName"
111                 },
112                 {
113                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
114                   "isPinned": true,
115                   "displayName": "displayName"
116                 }
117               ],
118               "comparisonRunGroups": [
119                 {
120                   "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
121                   "name": "name",
122                   "offset": {
123                     "value": 1000000,
124                     "unit": "DAYS"
125                   },
126                   "offsetAnchor": {
127                     "type": "run",
128                     "run": {}
129                   },
130                   "runs": [],
131                   "color": "color"
132                 },
133                 {
134                   "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
135                   "name": "name",
136                   "offset": {
137                     "value": 1000000,
138                     "unit": "DAYS"
139                   },
140                   "offsetAnchor": {
141                     "type": "run",
142                     "run": {}
143                   },
144                   "runs": [],
145                   "color": "color"
146                 }
147               ],
148               "valueAxes": [
149                 {
150                   "id": "id",
151                   "title": "title",
152                   "displayOptions": {
153                     "showTitle": true
154                   },
155                   "range": {},
156                   "limit": {},
157                   "position": "LEFT",
158                   "domainType": "NUMERIC"
159                 },
160                 {
161                   "id": "id",
162                   "title": "title",
163                   "displayOptions": {
164                     "showTitle": true
165                   },
166                   "range": {},
167                   "limit": {},
168                   "position": "LEFT",
169                   "domainType": "NUMERIC"
170                 }
171               ],
172               "title": "title"
173             }
174           }
175         }
176       }
177     }
178   },
179   "eventRefs": [
180     {
181       "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
182     }
183   ],
184   "checkAlertRefs": [
185     {
186       "checkAlertRid": "checkAlertRid"
187     }
188   ],
189   "charts": [
190     {
191       "rid": "rid",
192       "version": 1,
193       "overlays": {
194         "key": "value"
195       }
196     },
197     {
198       "rid": "rid",
199       "version": 1,
200       "overlays": {
201         "key": "value"
202       }
203     }
204   ],
205   "content": {
206     "channelVariables": {
207       "channelVariables": {
208         "variableName": "variableName",
209         "computeSpec": {
210           "type": "v1",
211           "v1": "computeSpec"
212         },
213         "displayName": "displayName",
214         "computeSpecV2": {
215           "computeNode": {
216             "type": "enum",
217             "enum": {
218               "type": "raw",
219               "raw": {
220                 "name": "name"
221               }
222             }
223           },
224           "context": {
225             "variables": {
226               "variables": {
227                 "type": "variable",
228                 "variable": "variables"
229               }
230             }
231           }
232         }
233       }
234     },
235     "charts": {
236       "charts": {
237         "type": "cartesian",
238         "cartesian": {
239           "type": "v1",
240           "v1": {
241             "plots": [
242               {
243                 "xVariableName": "xVariableName",
244                 "yVariableName": "yVariableName",
245                 "xAxisId": "xAxisId",
246                 "yAxisId": "yAxisId",
247                 "color": "color",
248                 "enabled": true
249               },
250               {
251                 "xVariableName": "xVariableName",
252                 "yVariableName": "yVariableName",
253                 "xAxisId": "xAxisId",
254                 "yAxisId": "yAxisId",
255                 "color": "color",
256                 "enabled": true
257               }
258             ],
259             "events": [
260               {
261                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
262                 "isPinned": true,
263                 "displayName": "displayName"
264               },
265               {
266                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
267                 "isPinned": true,
268                 "displayName": "displayName"
269               }
270             ],
271             "comparisonRunGroups": [
272               {
273                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
274                 "name": "name",
275                 "offset": {
276                   "value": 1000000,
277                   "unit": "DAYS"
278                 },
279                 "offsetAnchor": {
280                   "type": "run",
281                   "run": {}
282                 },
283                 "runs": [],
284                 "color": "color"
285               },
286               {
287                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
288                 "name": "name",
289                 "offset": {
290                   "value": 1000000,
291                   "unit": "DAYS"
292                 },
293                 "offsetAnchor": {
294                   "type": "run",
295                   "run": {}
296                 },
297                 "runs": [],
298                 "color": "color"
299               }
300             ],
301             "valueAxes": [
302               {
303                 "id": "id",
304                 "title": "title",
305                 "displayOptions": {
306                   "showTitle": true
307                 },
308                 "range": {},
309                 "limit": {},
310                 "position": "LEFT",
311                 "domainType": "NUMERIC"
312               },
313               {
314                 "id": "id",
315                 "title": "title",
316                 "displayOptions": {
317                   "showTitle": true
318                 },
319                 "range": {},
320                 "limit": {},
321                 "position": "LEFT",
322                 "domainType": "NUMERIC"
323               }
324             ],
325             "title": "title"
326           }
327         }
328       }
329     }
330   }
331 }

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.

checkAlertRefsset of objectsRequired

Replace existing pinned check alerts 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.

Response

This endpoint returns an object.

ridstring

snapshotRidstring

snapshotAuthorRidstring

snapshotCreatedAtdatetime

metadataobject

stateAsJsonstring

layoutobject

contentV2object

eventRefsset of objects

checkAlertRefsset of objects

chartslist of objectsOptional

contentobjectOptional

Path parameters

Headers

Request

Response