Search

POST

Request

This endpoint expects an object.

queryobjectRequired

showDraftsbooleanRequired

Soon to be deprecated. Compose a draftState filter within SearchNotebooksQuery instead

showArchivedbooleanOptionalDefaults to false

Soon to be deprecated. Compose an archived filter within SearchNotebooksQuery instead

sortByobjectOptional

UPDATED_AT descending by default

nextPageTokenstringOptional

pageSizeintegerOptional

Defaults to 100. Will throw if larger than 1000.

Response

This endpoint returns an object.

resultslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v2/notebook/search \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "query": {
6     "type": "and",
7     "and": [
8       {
9         "type": "and",
10         "and": [
11           {
12             "type": "and",
13             "and": [
14               {
15                 "type": "and",
16                 "and": [
17                   {
18                     "type": "and",
19                     "and": []
20                   },
21                   {
22                     "type": "and",
23                     "and": []
24                   }
25                 ]
26               },
27               {
28                 "type": "and",
29                 "and": [
30                   {
31                     "type": "and",
32                     "and": []
33                   },
34                   {
35                     "type": "and",
36                     "and": []
37                   }
38                 ]
39               }
40             ]
41           },
42           {
43             "type": "and",
44             "and": [
45               {
46                 "type": "and",
47                 "and": [
48                   {
49                     "type": "and",
50                     "and": []
51                   },
52                   {
53                     "type": "and",
54                     "and": []
55                   }
56                 ]
57               },
58               {
59                 "type": "and",
60                 "and": [
61                   {
62                     "type": "and",
63                     "and": []
64                   },
65                   {
66                     "type": "and",
67                     "and": []
68                   }
69                 ]
70               }
71             ]
72           }
73         ]
74       },
75       {
76         "type": "and",
77         "and": [
78           {
79             "type": "and",
80             "and": [
81               {
82                 "type": "and",
83                 "and": [
84                   {
85                     "type": "and",
86                     "and": []
87                   },
88                   {
89                     "type": "and",
90                     "and": []
91                   }
92                 ]
93               },
94               {
95                 "type": "and",
96                 "and": [
97                   {
98                     "type": "and",
99                     "and": []
100                   },
101                   {
102                     "type": "and",
103                     "and": []
104                   }
105                 ]
106               }
107             ]
108           },
109           {
110             "type": "and",
111             "and": [
112               {
113                 "type": "and",
114                 "and": [
115                   {
116                     "type": "and",
117                     "and": []
118                   },
119                   {
120                     "type": "and",
121                     "and": []
122                   }
123                 ]
124               },
125               {
126                 "type": "and",
127                 "and": [
128                   {
129                     "type": "and",
130                     "and": []
131                   },
132                   {
133                     "type": "and",
134                     "and": []
135                   }
136                 ]
137               }
138             ]
139           }
140         ]
141       }
142     ]
143   },
144   "showDrafts": true
145 }'

200Successful

1 {
2   "results": [
3     {
4       "rid": "rid",
5       "metadata": {
6         "dataScope": {
7           "type": "runRids",
8           "runRids": [
9             "dataScope"
10           ]
11         },
12         "notebookType": "WORKBOOK",
13         "title": "title",
14         "description": "description",
15         "isDraft": true,
16         "isArchived": true,
17         "lock": {
18           "isLocked": true,
19           "updatedAt": "2024-01-15T09:30:00Z",
20           "updatedByRid": "updatedByRid"
21         },
22         "createdByRid": "createdByRid",
23         "createdAt": "2024-01-15T09:30:00Z",
24         "properties": {
25           "properties": "properties"
26         },
27         "labels": [
28           "labels"
29         ],
30         "runRid": "runRid"
31       }
32     },
33     {
34       "rid": "rid",
35       "metadata": {
36         "dataScope": {
37           "type": "runRids",
38           "runRids": [
39             "dataScope"
40           ]
41         },
42         "notebookType": "WORKBOOK",
43         "title": "title",
44         "description": "description",
45         "isDraft": true,
46         "isArchived": true,
47         "lock": {
48           "isLocked": true,
49           "updatedAt": "2024-01-15T09:30:00Z",
50           "updatedByRid": "updatedByRid"
51         },
52         "createdByRid": "createdByRid",
53         "createdAt": "2024-01-15T09:30:00Z",
54         "properties": {
55           "properties": "properties"
56         },
57         "labels": [
58           "labels"
59         ],
60         "runRid": "runRid"
61       }
62     }
63   ],
64   "nextPageToken": "nextPageToken"
65 }

Lock

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v2/notebook/search \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"query": {
6	"type": "and",
7	"and": [
8	{
9	"type": "and",
10	"and": [
11	{
12	"type": "and",
13	"and": [
14	{
15	"type": "and",
16	"and": [
17	{
18	"type": "and",
19	"and": []
20	},
21	{
22	"type": "and",
23	"and": []
24	}
25	]
26	},
27	{
28	"type": "and",
29	"and": [
30	{
31	"type": "and",
32	"and": []
33	},
34	{
35	"type": "and",
36	"and": []
37	}
38	]
39	}
40	]
41	},
42	{
43	"type": "and",
44	"and": [
45	{
46	"type": "and",
47	"and": [
48	{
49	"type": "and",
50	"and": []
51	},
52	{
53	"type": "and",
54	"and": []
55	}
56	]
57	},
58	{
59	"type": "and",
60	"and": [
61	{
62	"type": "and",
63	"and": []
64	},
65	{
66	"type": "and",
67	"and": []
68	}
69	]
70	}
71	]
72	}
73	]
74	},
75	{
76	"type": "and",
77	"and": [
78	{
79	"type": "and",
80	"and": [
81	{
82	"type": "and",
83	"and": [
84	{
85	"type": "and",
86	"and": []
87	},
88	{
89	"type": "and",
90	"and": []
91	}
92	]
93	},
94	{
95	"type": "and",
96	"and": [
97	{
98	"type": "and",
99	"and": []
100	},
101	{
102	"type": "and",
103	"and": []
104	}
105	]
106	}
107	]
108	},
109	{
110	"type": "and",
111	"and": [
112	{
113	"type": "and",
114	"and": [
115	{
116	"type": "and",
117	"and": []
118	},
119	{
120	"type": "and",
121	"and": []
122	}
123	]
124	},
125	{
126	"type": "and",
127	"and": [
128	{
129	"type": "and",
130	"and": []
131	},
132	{
133	"type": "and",
134	"and": []
135	}
136	]
137	}
138	]
139	}
140	]
141	}
142	]
143	},
144	"showDrafts": true
145	}'

1	{
2	"results": [
3	{
4	"rid": "rid",
5	"metadata": {
6	"dataScope": {
7	"type": "runRids",
8	"runRids": [
9	"dataScope"
10	]
11	},
12	"notebookType": "WORKBOOK",
13	"title": "title",
14	"description": "description",
15	"isDraft": true,
16	"isArchived": true,
17	"lock": {
18	"isLocked": true,
19	"updatedAt": "2024-01-15T09:30:00Z",
20	"updatedByRid": "updatedByRid"
21	},
22	"createdByRid": "createdByRid",
23	"createdAt": "2024-01-15T09:30:00Z",
24	"properties": {
25	"properties": "properties"
26	},
27	"labels": [
28	"labels"
29	],
30	"runRid": "runRid"
31	}
32	},
33	{
34	"rid": "rid",
35	"metadata": {
36	"dataScope": {
37	"type": "runRids",
38	"runRids": [
39	"dataScope"
40	]
41	},
42	"notebookType": "WORKBOOK",
43	"title": "title",
44	"description": "description",
45	"isDraft": true,
46	"isArchived": true,
47	"lock": {
48	"isLocked": true,
49	"updatedAt": "2024-01-15T09:30:00Z",
50	"updatedByRid": "updatedByRid"
51	},
52	"createdByRid": "createdByRid",
53	"createdAt": "2024-01-15T09:30:00Z",
54	"properties": {
55	"properties": "properties"
56	},
57	"labels": [
58	"labels"
59	],
60	"runRid": "runRid"
61	}
62	}
63	],
64	"nextPageToken": "nextPageToken"
65	}