POST Agents/List/GetExtAppEntity

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/List/GetExtAppEntity

Gets a ExtAppEntity object.

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
extAppEntityId int32 Required The identifier of the ExtAppEntity 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/List/GetExtAppEntity?extAppEntityId=165
POST /api/v1/Agents/List/GetExtAppEntity?$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: ExtAppEntity

Property Name Type Description
ExtAppId int32 The identity of the external app
Name string The name of the web panel
Tooltip string The tooltip of the web panel
Deleted bool True if the application is marked as deleted
Rank int32 The rank of the application
Filename string Filename of the programfile
Parameters string <template variable> <other template variable>
Workdir string Directory set to current when loading the application, if different from application's own
ShowState string The application is shown in which state Minimized, Maximized or Restored
VisibleIn string The application is visible in
OnCentral bool Is the application visible when user is on central database
OnSatellite bool Is the application visible when user is on a satellite
OnTravel bool Is the application visible when user is on travel
OnSalesMarketingPocket bool Is the webpanel visible when user is on pocket client
ShowInMenuBar bool Does the application have a menu bar
ShowInToolBar bool Does the webpanel have a toolbar
ShowInAddressBar bool Does the webpanel have an address bar
ShowInStatusBar bool Does the webpanel have a status bar
Icon int32 The id of the icon of the external app
WaitToFinish bool True if the application shall wait for fininsh event
ExecuteOnEvent string Events that cause automatic execution of this app
Path string Path where the programfile is located; if empty, PATH is used
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/List/GetExtAppEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

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

{
  "ExtAppId": 645,
  "Name": "Kshlerin, Welch and Feeney",
  "Tooltip": "sed",
  "Deleted": true,
  "Rank": 994,
  "Filename": "et",
  "Parameters": "iusto",
  "Workdir": "hic",
  "ShowState": "AddressBar",
  "VisibleIn": "ActivityDialog",
  "OnCentral": false,
  "OnSatellite": true,
  "OnTravel": true,
  "OnSalesMarketingPocket": false,
  "ShowInMenuBar": false,
  "ShowInToolBar": false,
  "ShowInAddressBar": false,
  "ShowInStatusBar": false,
  "Icon": 427,
  "WaitToFinish": false,
  "ExecuteOnEvent": "LocalUpdate",
  "Path": "ab",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 537
    }
  }
}