Create

POST

Creates a new template.

Request

This endpoint expects an object.

titlestringRequired

descriptionstringRequired

labelsset of stringsRequired

propertiesmap from strings to stringsRequired

layoutobjectRequired

contentobjectRequired

messagestringRequired

isPublishedbooleanOptionalDefaults to false

Default is true

chartslist of objectsOptional

Response

This endpoint returns an object.

ridstring

metadataobject

commitobject

chartslist of objects

layoutobject

contentobject

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/template/ \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "title": "title",
6   "description": "description",
7   "labels": [
8     "labels"
9   ],
10   "properties": {
11     "properties": "properties"
12   },
13   "layout": {
14     "type": "v1",
15     "v1": {
16       "rootPanel": {
17         "type": "viz",
18         "viz": {
19           "type": "v1",
20           "v1": {
21             "id": "id",
22             "vizId": "vizId",
23             "hideLegend": true
24           }
25         }
26       }
27     }
28   },
29   "content": {
30     "channelVariables": {
31       "channelVariables": {
32         "variableName": "variableName",
33         "computeSpec": {
34           "type": "v1",
35           "v1": "computeSpec"
36         }
37       }
38     },
39     "charts": {
40       "charts": {
41         "type": "timeSeries",
42         "timeSeries": {
43           "type": "v1",
44           "v1": {
45             "rows": [
46               {
47                 "plots": [],
48                 "rowFlexSize": 1.1
49               },
50               {
51                 "plots": [],
52                 "rowFlexSize": 1.1
53               }
54             ],
55             "comparisonRunGroups": [
56               {
57                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
58                 "name": "name",
59                 "offset": {
60                   "value": 1000000,
61                   "unit": "DAYS"
62                 },
63                 "offsetAnchor": {
64                   "type": "run",
65                   "run": {}
66                 },
67                 "runs": [
68                   {
69                     "runRid": "runRid",
70                     "enabled": true
71                   },
72                   {
73                     "runRid": "runRid",
74                     "enabled": true
75                   }
76                 ]
77               },
78               {
79                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
80                 "name": "name",
81                 "offset": {
82                   "value": 1000000,
83                   "unit": "DAYS"
84                 },
85                 "offsetAnchor": {
86                   "type": "run",
87                   "run": {}
88                 },
89                 "runs": [
90                   {
91                     "runRid": "runRid",
92                     "enabled": true
93                   },
94                   {
95                     "runRid": "runRid",
96                     "enabled": true
97                   }
98                 ]
99               }
100             ],
101             "events": [
102               {
103                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
104                 "isPinned": true
105               },
106               {
107                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
108                 "isPinned": true
109               }
110             ],
111             "valueAxes": [
112               {
113                 "id": "id",
114                 "title": "title",
115                 "displayOptions": {
116                   "showTitle": true
117                 },
118                 "range": {},
119                 "limit": {},
120                 "position": "LEFT",
121                 "domainType": "NUMERIC"
122               },
123               {
124                 "id": "id",
125                 "title": "title",
126                 "displayOptions": {
127                   "showTitle": true
128                 },
129                 "range": {},
130                 "limit": {},
131                 "position": "LEFT",
132                 "domainType": "NUMERIC"
133               }
134             ]
135           }
136         }
137       }
138     }
139   },
140   "message": "message"
141 }'

200Successful

1 {
2   "rid": "rid",
3   "metadata": {
4     "title": "title",
5     "description": "description",
6     "labels": [
7       "labels"
8     ],
9     "properties": {
10       "properties": "properties"
11     },
12     "isArchived": true,
13     "isPublished": true,
14     "createdBy": "createdBy",
15     "createdAt": "2024-01-15T09:30:00Z",
16     "updatedAt": "2024-01-15T09:30:00Z",
17     "editedAt": "2024-01-15T09:30:00Z"
18   },
19   "commit": {
20     "id": "id",
21     "resourceRid": "resourceRid",
22     "message": "message",
23     "isWorkingState": true,
24     "committedBy": "committedBy",
25     "committedAt": "2024-01-15T09:30:00Z",
26     "parentCommit": "parentCommit",
27     "mergeParentCommit": "mergeParentCommit"
28   },
29   "charts": [
30     {
31       "rid": "rid",
32       "version": 1
33     },
34     {
35       "rid": "rid",
36       "version": 1
37     }
38   ],
39   "layout": {
40     "type": "v1",
41     "v1": {
42       "rootPanel": {
43         "type": "viz",
44         "viz": {
45           "type": "v1",
46           "v1": {
47             "id": "id",
48             "vizId": "vizId",
49             "hideLegend": true
50           }
51         }
52       }
53     }
54   },
55   "content": {
56     "channelVariables": {
57       "channelVariables": {
58         "variableName": "variableName",
59         "computeSpec": {
60           "type": "v1",
61           "v1": "computeSpec"
62         },
63         "displayName": "displayName"
64       }
65     },
66     "charts": {
67       "charts": {
68         "type": "timeSeries",
69         "timeSeries": {
70           "type": "v1",
71           "v1": {
72             "rows": [
73               {
74                 "plots": [],
75                 "rowFlexSize": 1.1,
76                 "title": "title"
77               },
78               {
79                 "plots": [],
80                 "rowFlexSize": 1.1,
81                 "title": "title"
82               }
83             ],
84             "comparisonRunGroups": [
85               {
86                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
87                 "name": "name",
88                 "offset": {
89                   "value": 1000000,
90                   "unit": "DAYS"
91                 },
92                 "offsetAnchor": {
93                   "type": "run",
94                   "run": {}
95                 },
96                 "runs": [
97                   {
98                     "runRid": "runRid",
99                     "enabled": true
100                   },
101                   {
102                     "runRid": "runRid",
103                     "enabled": true
104                   }
105                 ],
106                 "color": "color"
107               },
108               {
109                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
110                 "name": "name",
111                 "offset": {
112                   "value": 1000000,
113                   "unit": "DAYS"
114                 },
115                 "offsetAnchor": {
116                   "type": "run",
117                   "run": {}
118                 },
119                 "runs": [
120                   {
121                     "runRid": "runRid",
122                     "enabled": true
123                   },
124                   {
125                     "runRid": "runRid",
126                     "enabled": true
127                   }
128                 ],
129                 "color": "color"
130               }
131             ],
132             "events": [
133               {
134                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
135                 "isPinned": true,
136                 "displayName": "displayName"
137               },
138               {
139                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
140                 "isPinned": true,
141                 "displayName": "displayName"
142               }
143             ],
144             "valueAxes": [
145               {
146                 "id": "id",
147                 "title": "title",
148                 "displayOptions": {
149                   "showTitle": true,
150                   "axisWidth": 1.1,
151                   "scaleType": "LINEAR"
152                 },
153                 "range": {
154                   "start": 1.1,
155                   "end": 1.1
156                 },
157                 "limit": {
158                   "start": 1.1,
159                   "end": 1.1
160                 },
161                 "position": "LEFT",
162                 "domainType": "NUMERIC"
163               },
164               {
165                 "id": "id",
166                 "title": "title",
167                 "displayOptions": {
168                   "showTitle": true,
169                   "axisWidth": 1.1,
170                   "scaleType": "LINEAR"
171                 },
172                 "range": {
173                   "start": 1.1,
174                   "end": 1.1
175                 },
176                 "limit": {
177                   "start": 1.1,
178                   "end": 1.1
179                 },
180                 "position": "LEFT",
181                 "domainType": "NUMERIC"
182               }
183             ],
184             "title": "title",
185             "thresholds": []
186           }
187         }
188       }
189     }
190   }
191 }

Get

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/template/ \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"title": "title",
6	"description": "description",
7	"labels": [
8	"labels"
9	],
10	"properties": {
11	"properties": "properties"
12	},
13	"layout": {
14	"type": "v1",
15	"v1": {
16	"rootPanel": {
17	"type": "viz",
18	"viz": {
19	"type": "v1",
20	"v1": {
21	"id": "id",
22	"vizId": "vizId",
23	"hideLegend": true
24	}
25	}
26	}
27	}
28	},
29	"content": {
30	"channelVariables": {
31	"channelVariables": {
32	"variableName": "variableName",
33	"computeSpec": {
34	"type": "v1",
35	"v1": "computeSpec"
36	}
37	}
38	},
39	"charts": {
40	"charts": {
41	"type": "timeSeries",
42	"timeSeries": {
43	"type": "v1",
44	"v1": {
45	"rows": [
46	{
47	"plots": [],
48	"rowFlexSize": 1.1
49	},
50	{
51	"plots": [],
52	"rowFlexSize": 1.1
53	}
54	],
55	"comparisonRunGroups": [
56	{
57	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
58	"name": "name",
59	"offset": {
60	"value": 1000000,
61	"unit": "DAYS"
62	},
63	"offsetAnchor": {
64	"type": "run",
65	"run": {}
66	},
67	"runs": [
68	{
69	"runRid": "runRid",
70	"enabled": true
71	},
72	{
73	"runRid": "runRid",
74	"enabled": true
75	}
76	]
77	},
78	{
79	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
80	"name": "name",
81	"offset": {
82	"value": 1000000,
83	"unit": "DAYS"
84	},
85	"offsetAnchor": {
86	"type": "run",
87	"run": {}
88	},
89	"runs": [
90	{
91	"runRid": "runRid",
92	"enabled": true
93	},
94	{
95	"runRid": "runRid",
96	"enabled": true
97	}
98	]
99	}
100	],
101	"events": [
102	{
103	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
104	"isPinned": true
105	},
106	{
107	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
108	"isPinned": true
109	}
110	],
111	"valueAxes": [
112	{
113	"id": "id",
114	"title": "title",
115	"displayOptions": {
116	"showTitle": true
117	},
118	"range": {},
119	"limit": {},
120	"position": "LEFT",
121	"domainType": "NUMERIC"
122	},
123	{
124	"id": "id",
125	"title": "title",
126	"displayOptions": {
127	"showTitle": true
128	},
129	"range": {},
130	"limit": {},
131	"position": "LEFT",
132	"domainType": "NUMERIC"
133	}
134	]
135	}
136	}
137	}
138	}
139	},
140	"message": "message"
141	}'

1	{
2	"rid": "rid",
3	"metadata": {
4	"title": "title",
5	"description": "description",
6	"labels": [
7	"labels"
8	],
9	"properties": {
10	"properties": "properties"
11	},
12	"isArchived": true,
13	"isPublished": true,
14	"createdBy": "createdBy",
15	"createdAt": "2024-01-15T09:30:00Z",
16	"updatedAt": "2024-01-15T09:30:00Z",
17	"editedAt": "2024-01-15T09:30:00Z"
18	},
19	"commit": {
20	"id": "id",
21	"resourceRid": "resourceRid",
22	"message": "message",
23	"isWorkingState": true,
24	"committedBy": "committedBy",
25	"committedAt": "2024-01-15T09:30:00Z",
26	"parentCommit": "parentCommit",
27	"mergeParentCommit": "mergeParentCommit"
28	},
29	"charts": [
30	{
31	"rid": "rid",
32	"version": 1
33	},
34	{
35	"rid": "rid",
36	"version": 1
37	}
38	],
39	"layout": {
40	"type": "v1",
41	"v1": {
42	"rootPanel": {
43	"type": "viz",
44	"viz": {
45	"type": "v1",
46	"v1": {
47	"id": "id",
48	"vizId": "vizId",
49	"hideLegend": true
50	}
51	}
52	}
53	}
54	},
55	"content": {
56	"channelVariables": {
57	"channelVariables": {
58	"variableName": "variableName",
59	"computeSpec": {
60	"type": "v1",
61	"v1": "computeSpec"
62	},
63	"displayName": "displayName"
64	}
65	},
66	"charts": {
67	"charts": {
68	"type": "timeSeries",
69	"timeSeries": {
70	"type": "v1",
71	"v1": {
72	"rows": [
73	{
74	"plots": [],
75	"rowFlexSize": 1.1,
76	"title": "title"
77	},
78	{
79	"plots": [],
80	"rowFlexSize": 1.1,
81	"title": "title"
82	}
83	],
84	"comparisonRunGroups": [
85	{
86	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
87	"name": "name",
88	"offset": {
89	"value": 1000000,
90	"unit": "DAYS"
91	},
92	"offsetAnchor": {
93	"type": "run",
94	"run": {}
95	},
96	"runs": [
97	{
98	"runRid": "runRid",
99	"enabled": true
100	},
101	{
102	"runRid": "runRid",
103	"enabled": true
104	}
105	],
106	"color": "color"
107	},
108	{
109	"uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
110	"name": "name",
111	"offset": {
112	"value": 1000000,
113	"unit": "DAYS"
114	},
115	"offsetAnchor": {
116	"type": "run",
117	"run": {}
118	},
119	"runs": [
120	{
121	"runRid": "runRid",
122	"enabled": true
123	},
124	{
125	"runRid": "runRid",
126	"enabled": true
127	}
128	],
129	"color": "color"
130	}
131	],
132	"events": [
133	{
134	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
135	"isPinned": true,
136	"displayName": "displayName"
137	},
138	{
139	"eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
140	"isPinned": true,
141	"displayName": "displayName"
142	}
143	],
144	"valueAxes": [
145	{
146	"id": "id",
147	"title": "title",
148	"displayOptions": {
149	"showTitle": true,
150	"axisWidth": 1.1,
151	"scaleType": "LINEAR"
152	},
153	"range": {
154	"start": 1.1,
155	"end": 1.1
156	},
157	"limit": {
158	"start": 1.1,
159	"end": 1.1
160	},
161	"position": "LEFT",
162	"domainType": "NUMERIC"
163	},
164	{
165	"id": "id",
166	"title": "title",
167	"displayOptions": {
168	"showTitle": true,
169	"axisWidth": 1.1,
170	"scaleType": "LINEAR"
171	},
172	"range": {
173	"start": 1.1,
174	"end": 1.1
175	},
176	"limit": {
177	"start": 1.1,
178	"end": 1.1
179	},
180	"position": "LEFT",
181	"domainType": "NUMERIC"
182	}
183	],
184	"title": "title",
185	"thresholds": []
186	}
187	}
188	}
189	}
190	}
191	}