HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Partially update a Report

PATCH /report/{id}/ will partially update a single Report. This method is not allowed for non-virtual BI Servers.

Path Params
integer
required

ID of the containing server

integer
required

The ID of the object

Body Params
string
required

The user-friendly name of the object

string
required

The identifier of the object as generated by the BI Server. This is used as an identifier for bulk create/update operations.

date-time

Date and time of object creation on the BI Server

date-time

Most recent update time of the object on the BI Server

string
required

Path to the object on the BI Server

string
required

The type of the object, as defined by the BI Server

string
required

Object description on the BI Server

string | null
required

The type of report, whether it is a simple chart or a dashboard of reports.

string
required

Username of the report's owner

integer | null

Number of times the report has been accessed on the BI Server

number | null

Index of popularity based partially on num_accesses

string | null

external_id of the parent folder. Note that the folder must exist on Alation to properly update this

array of strings | null

external_id of the parent reports. Note that the reports must exist on Alation, or occur earlier in the POST payload, to properly update this

parent_reports
array of strings | null

external_id of the parent datasources. Note that the reports must exist on Alation, or occur earlier in the POST payload, to properly update this

parent_datasources
Responses

Language
Credentials
URL
Choose an example:
application/json