Update Report

PATCH /reports/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/reports/{id}

Updates the specific Report by setting the values of the parameters passed. Any parameters not provided will be left unchanged

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
Request Body Schema
Arrow
Name
Description
app_idstring
The ID of the application, assigned by Ocamba API.
creator_idstring
The ID of the creator, assigned by Ocamba API.
descriptionstring
The detailed report description. Minimum length 5. Maximum length 1000.


Example: Displays top 10 exchanges with highest income
dsobject
Report configuration.


Example: { "fields": "exchange_name,income", "source": "adex.exchange", "limit": "10", "order": { "field" : "income", "op" : "-" } }
namestring
The widget name. Minimum length 1. Maximum length 100.


Example: Top 10
refstring
Ref field is related only with system reports.
systeminteger
Indicates whether the report is system or user defined. Note that system reports can't be deleted or modified.

Possible values: 1 | 0
Response status codes
Arrow
204 - No Content
Arrow

note
1 System report can't be modified.
tip
1 If you don't know the report id, list the reports to find it.

Request examples
Copied
Arrow
patch Arrow
  • patch
{
  "id": "132",
  "company_id": "12345678",
  "name": "Top 10",
  "description": "Displays top 10 exchanges with highest income",
  "ds": "{ \"fields\": \"exchange_name,income\", \"source\": \"adex.exchange\", \"limit\": \"10\", \"order\": { \"field\" : \"income\", \"op\" : \"-\" } }",
  "create_time": "2021-07-30 12:50:13",
  "update_time": "2021-07-30 12:50:13"
}