ProgressDashboard
Update a scope
PATCH
What is sent replaces what was there; a new source drops the old one's reference. 400 when a model, view or search set is not the project's.
Who may call it: Anyone on the project whose permission profile allows object.update — or object.update-own, on their own (scopes they created, and the statuses of those scopes' elements). API keys: yes, given object.update for this project.
cookie
gamma.session_token<token>The session cookie a sign-in sets. Over HTTPS its name carries the __Secure- prefix. Browsers send it on their own; other clients keep it from the sign-in response.
projectId*stringThe project's id.
scopeId*stringapplication/json- body
name?stringLength
1 <= length <= 200source?stringValue in
"models""view""searchSet"modelIds?array<>For a models scope.
Items
items <= 50viewId?|For a view scope; required to create one.
searchSetId?|For a searchSet scope; required to create one.
charts?array<>Items
items <= 30OK.
application/json- response
scope*Example Request
curl -X PATCH 'http://localhost:3000/api/projects/string/scopes/string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "scope": { "id": "string", "name": "string", "source": "models", "viewId": "string", "searchSetId": "string", "charts": [ { "id": "string", "name": "string", "metric": "completion", "groupBy": { "column": "objectId" }, "subGroupBy": { "column": "objectId" }, "measure": { "column": "objectId" } } ], "createdById": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "modelIds": [ "string" ], "effectiveModelIds": [ "string" ], "conditions": [ { "logical": "and", "category": "string", "name": "string", "operator": "equals", "value": "string" } ] }}