Update Run

1 curl -X PUT https://api.gov.nominal.io/api/scout/v1/run/rid \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "assets": [ 6 "assets", 7 "assets" 8 ] 9 }'

1 { 2 "rid": "rid", 3 "runNumber": 1000000, 4 "title": "title", 5 "description": "description", 6 "startTime": { 7 "secondsSinceEpoch": 1000000, 8 "offsetNanoseconds": 1000000 9 }, 10 "properties": { 11 "properties": "properties" 12 }, 13 "labels": [ 14 "labels" 15 ], 16 "links": [ 17 { 18 "url": "url", 19 "title": "title" 20 }, 21 { 22 "url": "url", 23 "title": "title" 24 } 25 ], 26 "createdAt": "2024-01-15T09:30:00Z", 27 "updatedAt": "2024-01-15T09:30:00Z", 28 "assetDataScopes": [ 29 { 30 "dataScopeName": "dataScopeName", 31 "dataSource": { 32 "type": "dataset", 33 "dataset": "dataSource" 34 }, 35 "timestampType": "ABSOLUTE", 36 "seriesTags": { 37 "seriesTags": "seriesTags" 38 }, 39 "offset": { 40 "seconds": 1000000, 41 "nanos": 1000000, 42 "picos": 1 43 } 44 }, 45 { 46 "dataScopeName": "dataScopeName", 47 "dataSource": { 48 "type": "dataset", 49 "dataset": "dataSource" 50 }, 51 "timestampType": "ABSOLUTE", 52 "seriesTags": { 53 "seriesTags": "seriesTags" 54 }, 55 "offset": { 56 "seconds": 1000000, 57 "nanos": 1000000, 58 "picos": 1 59 } 60 } 61 ], 62 "dataSources": { 63 "dataSources": { 64 "dataSource": { 65 "type": "dataset", 66 "dataset": "dataSource" 67 }, 68 "offset": { 69 "seconds": 1000000, 70 "nanos": 1000000, 71 "picos": 1 72 }, 73 "refName": "refName", 74 "timestampType": "ABSOLUTE", 75 "seriesTags": { 76 "seriesTags": "seriesTags" 77 } 78 } 79 }, 80 "attachments": [ 81 "attachments" 82 ], 83 "assets": [ 84 "assets", 85 "assets" 86 ], 87 "isArchived": true, 88 "runPrefix": "runPrefix", 89 "authorRid": "authorRid", 90 "endTime": { 91 "secondsSinceEpoch": 1000000, 92 "offsetNanoseconds": 1000000 93 }, 94 "asset": "asset" 95 }

Updates an existing run based on its RID.

Throws if start is equal to or after end.

Path parameters

ridstringRequired

Request

This endpoint expects an object.

assetslist of stringsRequired

titlestringOptional

descriptionstringOptional

startTimeobjectOptional

endTimeobjectOptional

propertiesmap from strings to stringsOptional

labelsset of stringsOptional

linkslist of objectsOptional

runPrefixstringOptional

Pass in an empty string to remove the run prefix.

dataSourcesmap from strings to objectsOptional

attachmentsset of stringsOptional

assetstringOptional

Response

This endpoint returns an object.

ridstring

runNumberlong

titlestring

descriptionstring

startTimeobject

propertiesmap from strings to strings

labelsset of strings

linkslist of objects

createdAtdatetime

updatedAtdatetime

assetDataScopeslist of objects

returns the data scopes for the assets associated with the run.

dataSourcesmap from strings to objects

attachmentsset of strings

assetslist of strings

isArchivedboolean