Batch Get

POST

Request

This endpoint expects a set of strings.

Response

This endpoint returns a set of objects.

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/batch-get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '[
5   "string"
6 ]'

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           }
63         },
64         "charts": {
65           "charts": {
66             "type": "timeSeries",
67             "timeSeries": {
68               "type": "v1",
69               "v1": {
70                 "rows": [
71                   {
72                     "plots": [],
73                     "rowFlexSize": 1.1
74                   },
75                   {
76                     "plots": [],
77                     "rowFlexSize": 1.1
78                   }
79                 ],
80                 "comparisonRunGroups": [],
81                 "events": [
82                   {
83                     "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
84                     "isPinned": true
85                   },
86                   {
87                     "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
88                     "isPinned": true
89                   }
90                 ],
91                 "valueAxes": [],
92                 "title": "title",
93                 "thresholds": []
94               }
95             }
96           }
97         }
98       }
99     },
100     "charts": [
101       {
102         "rid": "rid",
103         "version": 1,
104         "overlays": {
105           "key": "value"
106         }
107       },
108       {
109         "rid": "rid",
110         "version": 1,
111         "overlays": {
112           "key": "value"
113         }
114       }
115     ],
116     "content": {
117       "channelVariables": {
118         "channelVariables": {
119           "variableName": "variableName",
120           "computeSpec": {
121             "type": "v1",
122             "v1": "computeSpec"
123           },
124           "displayName": "displayName"
125         }
126       },
127       "charts": {
128         "charts": {
129           "type": "timeSeries",
130           "timeSeries": {
131             "type": "v1",
132             "v1": {
133               "rows": [
134                 {
135                   "plots": [],
136                   "rowFlexSize": 1.1
137                 },
138                 {
139                   "plots": [],
140                   "rowFlexSize": 1.1
141                 }
142               ],
143               "comparisonRunGroups": [],
144               "events": [
145                 {
146                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
147                   "isPinned": true
148                 },
149                 {
150                   "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
151                   "isPinned": true
152                 }
153               ],
154               "valueAxes": [],
155               "title": "title",
156               "thresholds": []
157             }
158           }
159         }
160       }
161     }
162   }
163 ]

Update Metadata

Up Next

Built with

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	]'

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	}
63	},
64	"charts": {
65	"charts": {
66	"type": "timeSeries",
67	"timeSeries": {
68	"type": "v1",
69	"v1": {
70	"rows": [
71	{
72	"plots": [],
73	"rowFlexSize": 1.1
74	},
75	{
76	"plots": [],
77	"rowFlexSize": 1.1
78	}
79	],
80	"comparisonRunGroups": [],
81	"events": [
82	{
83	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
84	"isPinned": true
85	},
86	{
87	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
88	"isPinned": true
89	}
90	],
91	"valueAxes": [],
92	"title": "title",
93	"thresholds": []
94	}
95	}
96	}
97	}
98	}
99	},
100	"charts": [
101	{
102	"rid": "rid",
103	"version": 1,
104	"overlays": {
105	"key": "value"
106	}
107	},
108	{
109	"rid": "rid",
110	"version": 1,
111	"overlays": {
112	"key": "value"
113	}
114	}
115	],
116	"content": {
117	"channelVariables": {
118	"channelVariables": {
119	"variableName": "variableName",
120	"computeSpec": {
121	"type": "v1",
122	"v1": "computeSpec"
123	},
124	"displayName": "displayName"
125	}
126	},
127	"charts": {
128	"charts": {
129	"type": "timeSeries",
130	"timeSeries": {
131	"type": "v1",
132	"v1": {
133	"rows": [
134	{
135	"plots": [],
136	"rowFlexSize": 1.1
137	},
138	{
139	"plots": [],
140	"rowFlexSize": 1.1
141	}
142	],
143	"comparisonRunGroups": [],
144	"events": [
145	{
146	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
147	"isPinned": true
148	},
149	{
150	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
151	"isPinned": true
152	}
153	],
154	"valueAxes": [],
155	"title": "title",
156	"thresholds": []
157	}
158	}
159	}
160	}
161	}
162	}
163	]