Environments

patch

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

The environment table contains definition for different instances of a table. For example: Production, QA.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

environmentId

string

required

length between 1 and 256

The EnvironmentId field is an nvarchar data type with a maximum length of 256 characters and is a primary key of the Environment table. Its purpose is to serve as a unique identifier for each Environment record in the table.

description

string | null

The Environment table's nvarchar field, Description, contains variable-length character strings up to a maximum of approximately 4,000 characters, with no limitation on the number of bytes. The field is used to store detailed information, descriptions, or comments about the environment associated with the record. This information can be used to either describe the environment or provide details on its current state which can then be tracked over time.

comment

string | null

Miscellaneous notes and information for the entry or record.

clientId

int32

The ClientId field of data type int in the Environment table is a unique identifier for each client/organisation that the environment is related to. It will store a numeric reference to the Client and be used to link the Environment data to the Client data.

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!