Panels

patch

https://app.financekey.com/OData/Panels({key})

A panel defines a page or a region of a page. It can include controls, or sub-panels.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

name

string

required

length between 1 and 450

The name of the panel. Used internally to match associations etc.

description

string | null

The description of the panel.

parentId

int32 | null

The parent panel that the panel belongs to.

entityId

string | null

The table/entity for which the panel has been defined.

column

int32 | null

The column at which the panel should be positioned.

row

int32 | null

The row at which the panel should be positioned. The row is also used for sequencing the order in which panels are placed onto a parent panel.

panelTypeId

string | null

The panel type.

columnSpan

int32

The number of columns the control should span.

rowSpan

int32

The number of rows the control should span.

caption

string

required

length between 1 and 128

The caption to be displayed on the Panel when applicable.

columns

int32 | null

The Columns field in the Panel table stores integer values which represent individual columns in a panel structure. This field is used to separate data into sections, such as a spreadsheet or other tabular data format.

rows

int32 | null

The Rows of data type int in the Panel table represents the total number of rows found in the panel dataset.

backgroundColor

string | null

The BackgroundColor field within the Panel table is a nvarchar datatype with a maximum length of 32 that is used to specify the color of the background of the Panel.

showBorder

boolean

The ShowBorder field of data type bit in the Panel table determines whether a border is displayed around a panel element. When its value is set to 1 (true), a visible border will be displayed. When it is set to 0 (false), no border will be visible.

showCaption

boolean

ShowCaption is a bit field in the Panel table that specifies whether or not to display a caption for the corresponding panel. Possible values are 0 (no caption) and 1 (caption is visible).

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!