Views

patch

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

A view is a layout, sequence and format that should be applied to an index listing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

name

string

required

length between 1 and 256

The 'Name' field in the View table is a variable-length string data type (nvarchar) that can hold up to 256 characters, with a minimum length of 0 characters.

description

string | null

The View table contains 'Description' field of nvarchar data type with a maximum length of 512 characters. This field stores description related to the view information. Descriptions in this field can include components of the view, author's perspective, purpose of the view, or other information related to the view.

entityId

string

required

length between 1 and 450

The entity on which the view is based.

public

boolean

Public is a bit field in the View table that indicates whether or not the record is publicly visible. A value of 1 indicates that the record is publicly viewable, while a value of 0 indicates that the record is private.

ownerId

int32

OwnerId is an integer field in the View table that references the unique identifier of the user that owns the associated record. It indicates the user who has permission to make changes to the corresponding item.

comment

string | null

Miscellaneous notes and information for the entry or record.

sequence

int32

The Sequence field in the View table is an integer data type field used to store an integer value to represent the sequence in which each view needs to appear in the output. It is sometimes used in situations where the sequence is critical to being able to understand the output.

gridRows

int32 | null

The default number of rows that should be displayed in the grid. If 'null' the system will try to optimise the number based on screen resolution.

viewTypeId

string

required

length between 1 and 128

View Type. View, Subscription or Chart.

isTileGrid

boolean

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!