Create

POST

Creates a new workbook. The workbook will be associated with the provided run. If the run does not exist, a RunNotFound error will be thrown.

Request

This endpoint expects an object.

titlestringRequired

descriptionstringRequired

isDraftbooleanRequired

stateAsJsonstringRequired

layoutobjectRequired

notebookTypeenumOptional

Allowed values: WORKBOOKCOMPARISON_WORKBOOK

Optional for backcompatibility. Default is a normal workbook.

chartslist of objectsOptional

runRidstringOptional

deprecated. Use dataScope instead

dataScopeobjectOptional

Optional for back-compatibility.

contentobjectOptional

contentV2objectOptional

Optional for backcompatibility

Response

This endpoint returns an object.

ridstring

snapshotRidstring

snapshotAuthorRidstring

snapshotCreatedAtdatetime

metadataobject

stateAsJsonstring

layoutobject

contentV2object

chartslist of objectsOptional

contentobjectOptional

POST

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

200Successful

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         }
62       },
63       "charts": {
64         "charts": {
65           "type": "timeSeries",
66           "timeSeries": {
67             "type": "v1",
68             "v1": {
69               "rows": [
70                 {
71                   "plots": [],
72                   "rowFlexSize": 1.1,
73                   "title": "title"
74                 },
75                 {
76                   "plots": [],
77                   "rowFlexSize": 1.1,
78                   "title": "title"
79                 }
80               ],
81               "comparisonRunGroups": [
82                 {
83                   "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
84                   "name": "name",
85                   "offset": {
86                     "value": 1000000,
87                     "unit": "DAYS"
88                   },
89                   "offsetAnchor": {
90                     "type": "run",
91                     "run": {}
92                   },
93                   "runs": [],
94                   "color": "color"
95                 },
96                 {
97                   "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
98                   "name": "name",
99                   "offset": {
100                     "value": 1000000,
101                     "unit": "DAYS"
102                   },
103                   "offsetAnchor": {
104                     "type": "run",
105                     "run": {}
106                   },
107                   "runs": [],
108                   "color": "color"
109                 }
110               ],
111               "events": [
112                 {
113                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
114                   "isPinned": true,
115                   "displayName": "displayName"
116                 },
117                 {
118                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
119                   "isPinned": true,
120                   "displayName": "displayName"
121                 }
122               ],
123               "valueAxes": [
124                 {
125                   "id": "id",
126                   "title": "title",
127                   "displayOptions": {
128                     "showTitle": true
129                   },
130                   "range": {},
131                   "limit": {},
132                   "position": "LEFT",
133                   "domainType": "NUMERIC"
134                 },
135                 {
136                   "id": "id",
137                   "title": "title",
138                   "displayOptions": {
139                     "showTitle": true
140                   },
141                   "range": {},
142                   "limit": {},
143                   "position": "LEFT",
144                   "domainType": "NUMERIC"
145                 }
146               ],
147               "title": "title",
148               "thresholds": []
149             }
150           }
151         }
152       }
153     }
154   },
155   "charts": [
156     {
157       "rid": "rid",
158       "version": 1,
159       "overlays": {
160         "key": "value"
161       }
162     },
163     {
164       "rid": "rid",
165       "version": 1,
166       "overlays": {
167         "key": "value"
168       }
169     }
170   ],
171   "content": {
172     "channelVariables": {
173       "channelVariables": {
174         "variableName": "variableName",
175         "computeSpec": {
176           "type": "v1",
177           "v1": "computeSpec"
178         },
179         "displayName": "displayName"
180       }
181     },
182     "charts": {
183       "charts": {
184         "type": "timeSeries",
185         "timeSeries": {
186           "type": "v1",
187           "v1": {
188             "rows": [
189               {
190                 "plots": [],
191                 "rowFlexSize": 1.1,
192                 "title": "title"
193               },
194               {
195                 "plots": [],
196                 "rowFlexSize": 1.1,
197                 "title": "title"
198               }
199             ],
200             "comparisonRunGroups": [
201               {
202                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
203                 "name": "name",
204                 "offset": {
205                   "value": 1000000,
206                   "unit": "DAYS"
207                 },
208                 "offsetAnchor": {
209                   "type": "run",
210                   "run": {}
211                 },
212                 "runs": [],
213                 "color": "color"
214               },
215               {
216                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
217                 "name": "name",
218                 "offset": {
219                   "value": 1000000,
220                   "unit": "DAYS"
221                 },
222                 "offsetAnchor": {
223                   "type": "run",
224                   "run": {}
225                 },
226                 "runs": [],
227                 "color": "color"
228               }
229             ],
230             "events": [
231               {
232                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
233                 "isPinned": true,
234                 "displayName": "displayName"
235               },
236               {
237                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
238                 "isPinned": true,
239                 "displayName": "displayName"
240               }
241             ],
242             "valueAxes": [
243               {
244                 "id": "id",
245                 "title": "title",
246                 "displayOptions": {
247                   "showTitle": true
248                 },
249                 "range": {},
250                 "limit": {},
251                 "position": "LEFT",
252                 "domainType": "NUMERIC"
253               },
254               {
255                 "id": "id",
256                 "title": "title",
257                 "displayOptions": {
258                   "showTitle": true
259                 },
260                 "range": {},
261                 "limit": {},
262                 "position": "LEFT",
263                 "domainType": "NUMERIC"
264               }
265             ],
266             "title": "title",
267             "thresholds": []
268           }
269         }
270       }
271     }
272   }
273 }

Update

Up Next

Built with

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

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	}
62	},
63	"charts": {
64	"charts": {
65	"type": "timeSeries",
66	"timeSeries": {
67	"type": "v1",
68	"v1": {
69	"rows": [
70	{
71	"plots": [],
72	"rowFlexSize": 1.1,
73	"title": "title"
74	},
75	{
76	"plots": [],
77	"rowFlexSize": 1.1,
78	"title": "title"
79	}
80	],
81	"comparisonRunGroups": [
82	{
83	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
84	"name": "name",
85	"offset": {
86	"value": 1000000,
87	"unit": "DAYS"
88	},
89	"offsetAnchor": {
90	"type": "run",
91	"run": {}
92	},
93	"runs": [],
94	"color": "color"
95	},
96	{
97	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
98	"name": "name",
99	"offset": {
100	"value": 1000000,
101	"unit": "DAYS"
102	},
103	"offsetAnchor": {
104	"type": "run",
105	"run": {}
106	},
107	"runs": [],
108	"color": "color"
109	}
110	],
111	"events": [
112	{
113	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
114	"isPinned": true,
115	"displayName": "displayName"
116	},
117	{
118	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
119	"isPinned": true,
120	"displayName": "displayName"
121	}
122	],
123	"valueAxes": [
124	{
125	"id": "id",
126	"title": "title",
127	"displayOptions": {
128	"showTitle": true
129	},
130	"range": {},
131	"limit": {},
132	"position": "LEFT",
133	"domainType": "NUMERIC"
134	},
135	{
136	"id": "id",
137	"title": "title",
138	"displayOptions": {
139	"showTitle": true
140	},
141	"range": {},
142	"limit": {},
143	"position": "LEFT",
144	"domainType": "NUMERIC"
145	}
146	],
147	"title": "title",
148	"thresholds": []
149	}
150	}
151	}
152	}
153	}
154	},
155	"charts": [
156	{
157	"rid": "rid",
158	"version": 1,
159	"overlays": {
160	"key": "value"
161	}
162	},
163	{
164	"rid": "rid",
165	"version": 1,
166	"overlays": {
167	"key": "value"
168	}
169	}
170	],
171	"content": {
172	"channelVariables": {
173	"channelVariables": {
174	"variableName": "variableName",
175	"computeSpec": {
176	"type": "v1",
177	"v1": "computeSpec"
178	},
179	"displayName": "displayName"
180	}
181	},
182	"charts": {
183	"charts": {
184	"type": "timeSeries",
185	"timeSeries": {
186	"type": "v1",
187	"v1": {
188	"rows": [
189	{
190	"plots": [],
191	"rowFlexSize": 1.1,
192	"title": "title"
193	},
194	{
195	"plots": [],
196	"rowFlexSize": 1.1,
197	"title": "title"
198	}
199	],
200	"comparisonRunGroups": [
201	{
202	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
203	"name": "name",
204	"offset": {
205	"value": 1000000,
206	"unit": "DAYS"
207	},
208	"offsetAnchor": {
209	"type": "run",
210	"run": {}
211	},
212	"runs": [],
213	"color": "color"
214	},
215	{
216	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
217	"name": "name",
218	"offset": {
219	"value": 1000000,
220	"unit": "DAYS"
221	},
222	"offsetAnchor": {
223	"type": "run",
224	"run": {}
225	},
226	"runs": [],
227	"color": "color"
228	}
229	],
230	"events": [
231	{
232	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
233	"isPinned": true,
234	"displayName": "displayName"
235	},
236	{
237	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
238	"isPinned": true,
239	"displayName": "displayName"
240	}
241	],
242	"valueAxes": [
243	{
244	"id": "id",
245	"title": "title",
246	"displayOptions": {
247	"showTitle": true
248	},
249	"range": {},
250	"limit": {},
251	"position": "LEFT",
252	"domainType": "NUMERIC"
253	},
254	{
255	"id": "id",
256	"title": "title",
257	"displayOptions": {
258	"showTitle": true
259	},
260	"range": {},
261	"limit": {},
262	"position": "LEFT",
263	"domainType": "NUMERIC"
264	}
265	],
266	"title": "title",
267	"thresholds": []
268	}
269	}
270	}
271	}
272	}
273	}