Commit

POST

Creates a commit with a commit message. Throws if the template or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you commit to an archived template.

Path parameters

templateRidstringRequired

Query parameters

branchstringOptional

Request

This endpoint expects an object.

layoutobjectRequired

contentobjectRequired

messagestringRequired

chartslist of objectsOptional

latestCommitstringOptional

If present, will validate that the latest commit matches this id, and otherwise throw CommitConflict.

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

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 }

Update Metadata

Up Next

Built with

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

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	}