Skip to main content
Get Key

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

ApplicationName, DeviceName, KeyName, TableName, RecordId

GetKey: Returning a foreign key by its key name, that belongs to the specified device and application. A table name and record ID can also be specified.

ApplicationName
string
DeviceName
string
KeyName
string
TableName
string
RecordId
integer<int32>

Response

OK

Carrier object for ForeignKey. Services for the ForeignKey Carrier is available from the ForeignSystem Agent.

Key
string

Subkey (optional)

Value
string

Key value

RecordId
integer<int32>

Record in the referenced table

CreatedDate
string<date-time>

Registered when in UTC.

UpdatedDate
string<date-time>

Last updated when in UTC.

UpdatedBy
string

Name of the person that last updated the foreign key

CreatedBy
string

Name of the person that created the foreign key

TableName
string

Table name, transformed to and from numeric table id by the service layer

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.