Create Or Update Run

POST

Updates a run if it exists, otherwise it’s created from scratch.

Request

This endpoint expects an object.

createRunRequestobjectRequired

runRidstringOptional

If a run with the same rid already exists, it will be updated. Otherwise, a new run will be created.

Response

This endpoint returns an object.

ridstring

runNumberlong

titlestring

descriptionstring

startTimeobject

propertiesmap from strings to strings

labelsset of strings

linkslist of objects

createdAtdatetime

updatedAtdatetime

dataSourcesmap from strings to objects

attachmentsset of strings

assetslist of strings

runPrefixstringOptional

authorRidstringOptional

endTimeobjectOptional

assetstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/run/create-or-update \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "createRunRequest": {
6     "title": "title",
7     "description": "description",
8     "startTime": {
9       "secondsSinceEpoch": 1000000
10     },
11     "properties": {
12       "properties": "properties"
13     },
14     "labels": [
15       "labels"
16     ],
17     "links": [
18       {
19         "url": "url"
20       },
21       {
22         "url": "url"
23       }
24     ],
25     "dataSources": {
26       "dataSources": {
27         "dataSource": {
28           "type": "dataset",
29           "dataset": "dataSource"
30         },
31         "seriesTags": {
32           "seriesTags": "seriesTags"
33         }
34       }
35     },
36     "attachments": [
37       "attachments"
38     ],
39     "assets": [
40       "assets",
41       "assets"
42     ]
43   }
44 }'

200Successful

1 {
2   "rid": "rid",
3   "runNumber": 1000000,
4   "title": "title",
5   "description": "description",
6   "startTime": {
7     "secondsSinceEpoch": 1000000,
8     "offsetNanoseconds": 1000000
9   },
10   "properties": {
11     "properties": "properties"
12   },
13   "labels": [
14     "labels"
15   ],
16   "links": [
17     {
18       "url": "url",
19       "title": "title"
20     },
21     {
22       "url": "url",
23       "title": "title"
24     }
25   ],
26   "createdAt": "2024-01-15T09:30:00Z",
27   "updatedAt": "2024-01-15T09:30:00Z",
28   "dataSources": {
29     "dataSources": {
30       "dataSource": {
31         "type": "dataset",
32         "dataset": "dataSource"
33       },
34       "offset": {
35         "seconds": 1000000,
36         "nanos": 1000000,
37         "picos": 1
38       },
39       "refName": "refName",
40       "timestampType": "ABSOLUTE",
41       "seriesTags": {
42         "seriesTags": "seriesTags"
43       }
44     }
45   },
46   "attachments": [
47     "attachments"
48   ],
49   "assets": [
50     "assets",
51     "assets"
52   ],
53   "runPrefix": "runPrefix",
54   "authorRid": "authorRid",
55   "endTime": {
56     "secondsSinceEpoch": 1000000,
57     "offsetNanoseconds": 1000000
58   },
59   "asset": "asset"
60 }

Get Run

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/run/create-or-update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"createRunRequest": {
6	"title": "title",
7	"description": "description",
8	"startTime": {
9	"secondsSinceEpoch": 1000000
10	},
11	"properties": {
12	"properties": "properties"
13	},
14	"labels": [
15	"labels"
16	],
17	"links": [
18	{
19	"url": "url"
20	},
21	{
22	"url": "url"
23	}
24	],
25	"dataSources": {
26	"dataSources": {
27	"dataSource": {
28	"type": "dataset",
29	"dataset": "dataSource"
30	},
31	"seriesTags": {
32	"seriesTags": "seriesTags"
33	}
34	}
35	},
36	"attachments": [
37	"attachments"
38	],
39	"assets": [
40	"assets",
41	"assets"
42	]
43	}
44	}'

1	{
2	"rid": "rid",
3	"runNumber": 1000000,
4	"title": "title",
5	"description": "description",
6	"startTime": {
7	"secondsSinceEpoch": 1000000,
8	"offsetNanoseconds": 1000000
9	},
10	"properties": {
11	"properties": "properties"
12	},
13	"labels": [
14	"labels"
15	],
16	"links": [
17	{
18	"url": "url",
19	"title": "title"
20	},
21	{
22	"url": "url",
23	"title": "title"
24	}
25	],
26	"createdAt": "2024-01-15T09:30:00Z",
27	"updatedAt": "2024-01-15T09:30:00Z",
28	"dataSources": {
29	"dataSources": {
30	"dataSource": {
31	"type": "dataset",
32	"dataset": "dataSource"
33	},
34	"offset": {
35	"seconds": 1000000,
36	"nanos": 1000000,
37	"picos": 1
38	},
39	"refName": "refName",
40	"timestampType": "ABSOLUTE",
41	"seriesTags": {
42	"seriesTags": "seriesTags"
43	}
44	}
45	},
46	"attachments": [
47	"attachments"
48	],
49	"assets": [
50	"assets",
51	"assets"
52	],
53	"runPrefix": "runPrefix",
54	"authorRid": "authorRid",
55	"endTime": {
56	"secondsSinceEpoch": 1000000,
57	"offsetNanoseconds": 1000000
58	},
59	"asset": "asset"
60	}