How can we help?

Searching:

0 results found

Dashboards/Patch or Dashboards/Put

PATCH api/dashboards/[dashboardId]

–OR–

PUT api/dashboards/[dashboardId]

Description

Updates an existing Dashboard.

See the following for request and response details ‒

See Also

Request ‒ Dashboards/Patch or Put

In the request, specify the ID of the Dashboard whose definition to change and the name of the property(s) to change. These properties are described in Dashboards/Post.

Property Type Description Mandatory
id String This is the unique identifier automatically assigned by Axonize when a Dashboard is created. This id is returned in the response of the Dashboards/Post. Y

Example JSON Dashboards/Patch or Put Request

curl -X PATCH \

  http://api.dev.axonize.com/api/dashboards/5ba360eb19ec0c17543b681b \

  -H ‘Accept: application/json, text/plain, */*’ \

  -H ‘Cache-Control: no-cache’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 1aaf017c-b987-4f53-94d6-ad9afb8e4767’ \

  -d ‘{

  “name”: “NewName”,

  “updateUser”: null

}’

–OR–

curl -X PUT \

  http://api.dev.axonize.com/api/dashboards/5ba360eb19ec0c17543b681b \

  -H ‘Accept: application/json, text/plain, */*’ \

  -H ‘Cache-Control: no-cache’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 1aaf017c-b987-4f53-94d6-ad9afb8e4767’ \

  -d ‘{

  “name”: “Shu”,

  “appId”: “1aaf017c-b987-4f53-94d6-ad9afb8e4767”,

  “createDate”: “2018-08-20T07:15:37.41Z”,

  “createUser”: “5883b7cd922dd1139c1d15d0”,

  “updateUser”: null

}’

Response ‒ Dashboards/Patch or Put

Property Type Description
createDate, createUser, updateDate, updateUser See Common Response Properties.

Example JSON Dashboards/Patch or Put Response

Status 204 ‒ No Content