POST Agents/ForeignSystem/GetKey

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/ForeignSystem/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.

Query String Parameters

Parameter Name Type Description
$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. 
POST /api/v1/Agents/ForeignSystem/GetKey?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ApplicationName, DeviceName, KeyName, TableName, RecordId

Property Name Type Description
ApplicationName String
DeviceName String
KeyName String
TableName String
RecordId Integer

Response:

OK

Response Description
200 OK

Response body: ForeignKey

Property Name Type Description
Key string Subkey (optional)
Value string Key value
RecordId int32 Record in the referenced table
CreatedDate date-time Registered when in UTC.
UpdatedDate 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 TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/ForeignSystem/GetKey
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ApplicationName": "Schmidt-Raynor",
  "DeviceName": "Baumbach, Kuhic and Osinski",
  "KeyName": "Bins, Dooley and Emard",
  "TableName": "Hermann LLC",
  "RecordId": 769
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Key": "est",
  "Value": "similique",
  "RecordId": 207,
  "CreatedDate": "2011-09-21T16:32:39.1645096+02:00",
  "UpdatedDate": "2000-03-01T16:32:39.1645096+01:00",
  "UpdatedBy": "ut",
  "CreatedBy": "et",
  "TableName": "Kuhic, Walsh and Flatley",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 725
    }
  }
}