Update Ref Names

POST

https://api.gov.nominal.io/api/scout/v1/template/:templateRid/update-ref-names

POST

/api/scout/v1/template/:templateRid/update-ref-names

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/template/templateRid/update-ref-names \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "refNameUpdates": {
6     "refNameUpdates": "refNameUpdates"
7   }
8 }'

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             "comparisonRunGroups": [
114               {
115                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
116                 "name": "name",
117                 "offset": {
118                   "value": 1000000,
119                   "unit": "DAYS"
120                 },
121                 "offsetAnchor": {
122                   "type": "run",
123                   "run": {}
124                 },
125                 "runs": [
126                   {
127                     "runRid": "runRid",
128                     "enabled": true
129                   },
130                   {
131                     "runRid": "runRid",
132                     "enabled": true
133                   }
134                 ],
135                 "color": "color"
136               },
137               {
138                 "uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
139                 "name": "name",
140                 "offset": {
141                   "value": 1000000,
142                   "unit": "DAYS"
143                 },
144                 "offsetAnchor": {
145                   "type": "run",
146                   "run": {}
147                 },
148                 "runs": [
149                   {
150                     "runRid": "runRid",
151                     "enabled": true
152                   },
153                   {
154                     "runRid": "runRid",
155                     "enabled": true
156                   }
157                 ],
158                 "color": "color"
159               }
160             ],
161             "valueAxes": [
162               {
163                 "id": "id",
164                 "title": "title",
165                 "displayOptions": {
166                   "showTitle": true,
167                   "axisWidth": 1.1,
168                   "scaleType": "LINEAR"
169                 },
170                 "range": {
171                   "start": 1.1,
172                   "end": 1.1
173                 },
174                 "limit": {
175                   "start": 1.1,
176                   "end": 1.1
177                 },
178                 "position": "LEFT",
179                 "domainType": "NUMERIC"
180               },
181               {
182                 "id": "id",
183                 "title": "title",
184                 "displayOptions": {
185                   "showTitle": true,
186                   "axisWidth": 1.1,
187                   "scaleType": "LINEAR"
188                 },
189                 "range": {
190                   "start": 1.1,
191                   "end": 1.1
192                 },
193                 "limit": {
194                   "start": 1.1,
195                   "end": 1.1
196                 },
197                 "position": "LEFT",
198                 "domainType": "NUMERIC"
199               }
200             ],
201             "events": [
202               {
203                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
204                 "isPinned": true,
205                 "displayName": "displayName"
206               },
207               {
208                 "eventUuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
209                 "isPinned": true,
210                 "displayName": "displayName"
211               }
212             ],
213             "title": "title"
214           }
215         }
216       }
217     }
218   }
219 }

Updates the data source ref names for all variables used in the template.

Path parameters

templateRidstringRequired

Query parameters

branchstringOptional

Request

This endpoint expects an object.

refNameUpdatesmap from strings to stringsRequired

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