Merge To Main

POST

https://api.gov.nominal.io/api/scout/v1/template/:templateRid/merge-to-main

POST

/api/scout/v1/template/:templateRid/merge-to-main

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/template/templateRid/merge-to-main \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "branchName": "branchName",
6   "message": "message"
7 }'

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 }

Merges the given branch to the “main” branch. Throws if the template or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you merge on an archived template.

Path parameters

templateRidstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

branchNamestringRequired

If “main”, the request will throw.

messagestringRequired

latestCommitOnMainstringOptional

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