POST Agents/ForeignSystem/GetForeignAppEntity

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/ForeignSystem/GetForeignAppEntity

Gets a ForeignAppEntity object.

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
foreignAppEntityId int32 Required The identifier of the ForeignAppEntity object
$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/GetForeignAppEntity?foreignAppEntityId=87
POST /api/v1/Agents/ForeignSystem/GetForeignAppEntity?$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
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.

Response:

OK

Response Description
200 OK

Response body: ForeignAppEntity

Property Name Type Description
ForeignAppId int32 Primary key
Name string Name of foreign application
CreatedDate date-time Registered when in UTC.
UpdatedDate date-time Last updated when in UTC.
CreatedBy Associate The person that created the foreign application.
UpdatedBy Associate The person that last updated this foreign application.
Devices array The devices that belong to this foreign app.
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/GetForeignAppEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

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

{
  "ForeignAppId": 289,
  "Name": "Fay, Abbott and Bashirian",
  "CreatedDate": "2005-01-26T02:30:47.350707+01:00",
  "UpdatedDate": "2023-05-26T02:30:47.350707+02:00",
  "CreatedBy": null,
  "UpdatedBy": null,
  "Devices": [
    {
      "ForeignDeviceId": 575,
      "Name": "Anderson-Sanford",
      "CreatedDate": "1998-09-17T02:30:47.350707+02:00",
      "UpdatedDate": "2016-01-05T02:30:47.350707+01:00",
      "AssociateFullName": "Belle Roberts",
      "CreatedBy": "et",
      "UpdatedBy": "aliquid",
      "DeviceIdentifier": "autem",
      "ForeignAppId": 260,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 681
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 99
    }
  }
}