Skip to main content
Save Ext App Entity

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.

Body

The ExtAppEntity that is saved

The ext app entity contains information on an external application Carrier object for ExtAppEntity. Services for the ExtAppEntity Carrier is available from the List Agent.

ExtAppId
integer<int32>

The identity of the external app

Name
string

The name of the web panel

Tooltip
string

The tooltip of the web panel

Deleted
boolean

True if the application is marked as deleted

Rank
integer<int32>

The rank of the application

Filename
string

Filename of the programfile

Parameters
string

Workdir
string

Directory set to current when loading the application, if different from application's own

ShowState
enum<string>

The application is shown in which state Minimized, Maximized or Restored

Available options:
Minimized,
Maximized,
Default,
ToolBar,
AddressBar,
StatusBar,
MenuBar
VisibleIn
enum<string>

The application is visible in

Available options:
Invisible,
ToolboxMenu,
NavigatorButton,
ViewMenu,
SelectionTaskCard,
ContactCard,
ContactArchive,
ProjectCard,
ProjectArchive,
SaleCard,
PersonCard,
ActivityDialog,
DocumentDialog,
BrowserPanel,
ContSelectionTask,
AppntSelectionTask,
SaleSelectionTask,
DocSelectionTask,
ProjSelectionTask,
CompanyMinicard,
ProjectMinicard,
DiaryMinicard,
SelectionMinicard,
ButtonPanelTask,
AppointmentDialogTask,
SaleDialogTask,
DocumentDialogTask,
PersonDialogTask,
SaleMinicard,
SaleArchive,
AppntSelectionShadowTask,
SaleSelectionShadowTask,
DocSelectionShadowTask,
ProjSelectionShadowTask,
DiaryArchive,
SelectionContactArchive,
SelectionProjectArchive,
SelectionSaleArchive,
SelectionAppointmentArchive,
SelectionDocumentArchive,
ContSelectionCustomTask,
AppntSelectionCustomTask,
SaleSelectionCustomTask,
DocSelectionCustomTask,
ProjSelectionCustomTask,
CustomArchiveMiniCard,
SelectionCard,
ReportMinicard,
QuoteDialog,
QuoteDialogTask,
QuoteDialogArchive,
QuoteLineDialogTask,
QuoteLineDialog,
QuoteLineSelectionMainTask,
QuoteLineSelectionShadowTask,
SelectionQuoteLineArchive,
QuoteLineSelectionCustomTask,
FindSystem,
MailingSelectionTask,
ContactSelectionMailingsTask,
AppointmentSelectionMailingsTask,
SaleSelectionMailingsTask,
DocumentSelectionMailingsTask,
ProjectSelectionMailingsTask,
QuoteLineSelectionMailingsTask,
TopPanelNewMenu,
Dashboard,
PersonArchive,
PersonMinicard,
CompanyCardTask,
ProjectCardTask,
TicketCard,
TicketMinicard,
CustomObjectCard,
CustomObjectArchive
OnCentral
boolean

Is the application visible when user is on central database

OnSatellite
boolean

Is the application visible when user is on a satellite

OnTravel
boolean

Is the application visible when user is on travel

OnSalesMarketingPocket
boolean

Is the webpanel visible when user is on pocket client

ShowInMenuBar
boolean

Does the application have a menu bar

ShowInToolBar
boolean

Does the webpanel have a toolbar

ShowInAddressBar
boolean

Does the webpanel have an address bar

ShowInStatusBar
boolean

Does the webpanel have a status bar

Icon
integer<int32>

The id of the icon of the external app

WaitToFinish
boolean

True if the application shall wait for fininsh event

ExecuteOnEvent
enum<string>

Events that cause automatic execution of this app

Available options:
Never,
Logon,
Logoff,
LocalUpdate,
Wait
Path
string

Path where the programfile is located; if empty, PATH is used

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.

Response

OK

The ext app entity contains information on an external application Carrier object for ExtAppEntity. Services for the ExtAppEntity Carrier is available from the List Agent.

ExtAppId
integer<int32>

The identity of the external app

Name
string

The name of the web panel

Tooltip
string

The tooltip of the web panel

Deleted
boolean

True if the application is marked as deleted

Rank
integer<int32>

The rank of the application

Filename
string

Filename of the programfile

Parameters
string

Workdir
string

Directory set to current when loading the application, if different from application's own

ShowState
enum<string>

The application is shown in which state Minimized, Maximized or Restored

Available options:
Minimized,
Maximized,
Default,
ToolBar,
AddressBar,
StatusBar,
MenuBar
VisibleIn
enum<string>

The application is visible in

Available options:
Invisible,
ToolboxMenu,
NavigatorButton,
ViewMenu,
SelectionTaskCard,
ContactCard,
ContactArchive,
ProjectCard,
ProjectArchive,
SaleCard,
PersonCard,
ActivityDialog,
DocumentDialog,
BrowserPanel,
ContSelectionTask,
AppntSelectionTask,
SaleSelectionTask,
DocSelectionTask,
ProjSelectionTask,
CompanyMinicard,
ProjectMinicard,
DiaryMinicard,
SelectionMinicard,
ButtonPanelTask,
AppointmentDialogTask,
SaleDialogTask,
DocumentDialogTask,
PersonDialogTask,
SaleMinicard,
SaleArchive,
AppntSelectionShadowTask,
SaleSelectionShadowTask,
DocSelectionShadowTask,
ProjSelectionShadowTask,
DiaryArchive,
SelectionContactArchive,
SelectionProjectArchive,
SelectionSaleArchive,
SelectionAppointmentArchive,
SelectionDocumentArchive,
ContSelectionCustomTask,
AppntSelectionCustomTask,
SaleSelectionCustomTask,
DocSelectionCustomTask,
ProjSelectionCustomTask,
CustomArchiveMiniCard,
SelectionCard,
ReportMinicard,
QuoteDialog,
QuoteDialogTask,
QuoteDialogArchive,
QuoteLineDialogTask,
QuoteLineDialog,
QuoteLineSelectionMainTask,
QuoteLineSelectionShadowTask,
SelectionQuoteLineArchive,
QuoteLineSelectionCustomTask,
FindSystem,
MailingSelectionTask,
ContactSelectionMailingsTask,
AppointmentSelectionMailingsTask,
SaleSelectionMailingsTask,
DocumentSelectionMailingsTask,
ProjectSelectionMailingsTask,
QuoteLineSelectionMailingsTask,
TopPanelNewMenu,
Dashboard,
PersonArchive,
PersonMinicard,
CompanyCardTask,
ProjectCardTask,
TicketCard,
TicketMinicard,
CustomObjectCard,
CustomObjectArchive
OnCentral
boolean

Is the application visible when user is on central database

OnSatellite
boolean

Is the application visible when user is on a satellite

OnTravel
boolean

Is the application visible when user is on travel

OnSalesMarketingPocket
boolean

Is the webpanel visible when user is on pocket client

ShowInMenuBar
boolean

Does the application have a menu bar

ShowInToolBar
boolean

Does the webpanel have a toolbar

ShowInAddressBar
boolean

Does the webpanel have an address bar

ShowInStatusBar
boolean

Does the webpanel have a status bar

Icon
integer<int32>

The id of the icon of the external app

WaitToFinish
boolean

True if the application shall wait for fininsh event

ExecuteOnEvent
enum<string>

Events that cause automatic execution of this app

Available options:
Never,
Logon,
Logoff,
LocalUpdate,
Wait
Path
string

Path where the programfile is located; if empty, PATH is used

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.