Commit

POST

https://api.gov.nominal.io/api/scout/v1/template/:templateRid/commit

POST

/api/scout/v1/template/:templateRid/commit

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": "cartesian",
34         "cartesian": {
35           "type": "v1",
36           "v1": {
37             "plots": [
38               {
39                 "xVariableName": "xVariableName",
40                 "yVariableName": "yVariableName",
41                 "xAxisId": "xAxisId",
42                 "yAxisId": "yAxisId",
43                 "color": "color"
44               },
45               {
46                 "xVariableName": "xVariableName",
47                 "yVariableName": "yVariableName",
48                 "xAxisId": "xAxisId",
49                 "yAxisId": "yAxisId",
50                 "color": "color"
51               }
52             ],
53             "events": [
54               {
55                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
56                 "isPinned": true
57               },
58               {
59                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
60                 "isPinned": true
61               }
62             ],
63             "comparisonRunGroups": [
64               {
65                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
66                 "name": "name",
67                 "offset": {
68                   "value": 1000000,
69                   "unit": "DAYS"
70                 },
71                 "offsetAnchor": {
72                   "type": "run",
73                   "run": {}
74                 },
75                 "runs": [
76                   {
77                     "runRid": "runRid",
78                     "enabled": true
79                   },
80                   {
81                     "runRid": "runRid",
82                     "enabled": true
83                   }
84                 ]
85               },
86               {
87                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
88                 "name": "name",
89                 "offset": {
90                   "value": 1000000,
91                   "unit": "DAYS"
92                 },
93                 "offsetAnchor": {
94                   "type": "run",
95                   "run": {}
96                 },
97                 "runs": [
98                   {
99                     "runRid": "runRid",
100                     "enabled": true
101                   },
102                   {
103                     "runRid": "runRid",
104                     "enabled": true
105                   }
106                 ]
107               }
108             ],
109             "valueAxes": [
110               {
111                 "id": "id",
112                 "title": "title",
113                 "displayOptions": {
114                   "showTitle": true
115                 },
116                 "range": {},
117                 "limit": {},
118                 "position": "LEFT",
119                 "domainType": "NUMERIC"
120               },
121               {
122                 "id": "id",
123                 "title": "title",
124                 "displayOptions": {
125                   "showTitle": true
126                 },
127                 "range": {},
128                 "limit": {},
129                 "position": "LEFT",
130                 "domainType": "NUMERIC"
131               }
132             ]
133           }
134         }
135       }
136     }
137   },
138   "message": "message"
139 }'

Try it

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         "computeSpecV2": {
65           "computeNode": {
66             "type": "enum",
67             "enum": {
68               "type": "function",
69               "function": {
70                 "functionReference": "functionReference",
71                 "functionIdentifier": {
72                   "type": "variable",
73                   "variable": "functionIdentifier"
74                 }
75               }
76             }
77           },
78           "context": {
79             "variables": {
80               "variables": {
81                 "type": "variable",
82                 "variable": "variables"
83               }
84             }
85           }
86         }
87       }
88     },
89     "charts": {
90       "charts": {
91         "type": "cartesian",
92         "cartesian": {
93           "type": "v1",
94           "v1": {
95             "plots": [
96               {
97                 "xVariableName": "xVariableName",
98                 "yVariableName": "yVariableName",
99                 "xAxisId": "xAxisId",
100                 "yAxisId": "yAxisId",
101                 "color": "color",
102                 "enabled": true
103               },
104               {
105                 "xVariableName": "xVariableName",
106                 "yVariableName": "yVariableName",
107                 "xAxisId": "xAxisId",
108                 "yAxisId": "yAxisId",
109                 "color": "color",
110                 "enabled": true
111               }
112             ],
113             "events": [
114               {
115                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
116                 "isPinned": true,
117                 "displayName": "displayName"
118               },
119               {
120                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
121                 "isPinned": true,
122                 "displayName": "displayName"
123               }
124             ],
125             "comparisonRunGroups": [
126               {
127                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
128                 "name": "name",
129                 "offset": {
130                   "value": 1000000,
131                   "unit": "DAYS"
132                 },
133                 "offsetAnchor": {
134                   "type": "run",
135                   "run": {}
136                 },
137                 "runs": [
138                   {
139                     "runRid": "runRid",
140                     "enabled": true
141                   },
142                   {
143                     "runRid": "runRid",
144                     "enabled": true
145                   }
146                 ],
147                 "color": "color"
148               },
149               {
150                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
151                 "name": "name",
152                 "offset": {
153                   "value": 1000000,
154                   "unit": "DAYS"
155                 },
156                 "offsetAnchor": {
157                   "type": "run",
158                   "run": {}
159                 },
160                 "runs": [
161                   {
162                     "runRid": "runRid",
163                     "enabled": true
164                   },
165                   {
166                     "runRid": "runRid",
167                     "enabled": true
168                   }
169                 ],
170                 "color": "color"
171               }
172             ],
173             "valueAxes": [
174               {
175                 "id": "id",
176                 "title": "title",
177                 "displayOptions": {
178                   "showTitle": true,
179                   "axisWidth": 1.1,
180                   "scaleType": "LINEAR"
181                 },
182                 "range": {
183                   "start": 1.1,
184                   "end": 1.1
185                 },
186                 "limit": {
187                   "start": 1.1,
188                   "end": 1.1
189                 },
190                 "position": "LEFT",
191                 "domainType": "NUMERIC"
192               },
193               {
194                 "id": "id",
195                 "title": "title",
196                 "displayOptions": {
197                   "showTitle": true,
198                   "axisWidth": 1.1,
199                   "scaleType": "LINEAR"
200                 },
201                 "range": {
202                   "start": 1.1,
203                   "end": 1.1
204                 },
205                 "limit": {
206                   "start": 1.1,
207                   "end": 1.1
208                 },
209                 "position": "LEFT",
210                 "domainType": "NUMERIC"
211               }
212             ],
213             "title": "title"
214           }
215         }
216       }
217     }
218   }
219 }

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

Path parameters

Headers

Query parameters

Request

Response