Report / Style

What can you do with ReportStyle?


Properties

Property Details
id
"id": 936
Type: Number
This is the unique numeric identifier for the ReportStyle
ownerId
"ownerId": 879
Type: Number
Unique identifier for the associated Owner object.
reportId
"reportId": 738
Type: Number
Unique identifier for the associated Report object.
defaultFont
"defaultFont": "Hello World"
Type: String
defaultFontSize
"defaultFontSize": "Hello World"
Type: String
titleFontSize
"titleFontSize": "Hello World"
Type: String
titleFontWeight
"titleFontWeight": 892
Type: Number
headingFontSize
"headingFontSize": "Hello World"
Type: String
headingFontWeight
"headingFontWeight": 215
Type: Number
summaryFontWeight
"summaryFontWeight": 789
Type: Number
summaryShading
"summaryShading": true
Type: Boolean
groupCaption
"groupCaption": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • reportId
  • defaultFont
  • defaultFontSize
  • titleFontSize
  • titleFontWeight
  • headingFontSize
  • headingFontWeight
  • summaryFontWeight
  • summaryShading
  • groupCaption

DataFlow PATCH objects:


End Points

DELETEapi/v1/Report/Style/{id:int}
Delete an instance of the ReportStyle object.
GETapi/v1/Report/Style
Retrieve all of the ReportStyle objects.
GETapi/v1/Report/Style/Metadata
Retrieve all of the meta data details of the ReportStyle object.
GETapi/v1/Report/Style/Metadata/{option}
Retrieve all the meta data details of the ReportStyle object based on provided options.
{option}Metadata options for the ReportStyle object.
GETapi/v1/Report/Style/Paged
Retreive all of the ReportStyle objects in a paged fashion.
GETapi/v1/Report/Style/{id:int}
Retrieve an instance of the ReportStyle object by it's ID.
{id:int}Unique identifier for the ReportStyle object.
POSTapi/v1/Report/Style
Create a new instance of the ReportStyle object.
PUTapi/v1/Report/Style/{id:int}
Update an existing instance of the ReportStyle object.