Create Asset

POST

Request

This endpoint expects an object.

titlestringRequired

propertiesmap from strings to stringsRequired

labelsset of stringsRequired

linkslist of objectsRequired

dataScopesset of objectsRequired

The data scopes associated with the asset.

attachmentsset of stringsRequired

descriptionstringOptional

typestringOptional

Response

This endpoint returns an object.

ridstring

titlestring

propertiesmap from strings to strings

labelsset of strings

Labels associated with the asset. These labels do not have a time dimension. To associate labels with a range of time, create a time range on the asset with labels.

linkslist of objects

Links associated with the asset. These links do not have a time dimension. To associate links with a range of time, create a time range on the asset with links.

dataScopeslist of objects

The data scopes associated with the asset.

createdAtdatetime

updatedAtdatetime

attachmentsset of strings

descriptionstringOptional

createdBystringOptional

typestringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/asset \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "title": "title",
6   "properties": {
7     "properties": "properties"
8   },
9   "labels": [
10     "labels"
11   ],
12   "links": [
13     {
14       "url": "url"
15     },
16     {
17       "url": "url"
18     }
19   ],
20   "dataScopes": [
21     {
22       "dataScopeName": "dataScopeName",
23       "dataSource": {
24         "type": "dataset",
25         "dataset": "dataSource"
26       },
27       "seriesTags": {
28         "seriesTags": "seriesTags"
29       }
30     }
31   ],
32   "attachments": [
33     "attachments"
34   ]
35 }'

200Successful

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

Update Asset

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/asset \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"title": "title",
6	"properties": {
7	"properties": "properties"
8	},
9	"labels": [
10	"labels"
11	],
12	"links": [
13	{
14	"url": "url"
15	},
16	{
17	"url": "url"
18	}
19	],
20	"dataScopes": [
21	{
22	"dataScopeName": "dataScopeName",
23	"dataSource": {
24	"type": "dataset",
25	"dataset": "dataSource"
26	},
27	"seriesTags": {
28	"seriesTags": "seriesTags"
29	}
30	}
31	],
32	"attachments": [
33	"attachments"
34	]
35	}'

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