Skip to main content
Get Task Menu By Prog Id

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

ProgId

GetTaskMenuByProgId: Get a task menu using the ProgId key that was specified when it was created

ProgId
string

Response

OK

Configurable Menu Items are items that will be merged into menus in given area and entity Carrier object for TaskMenu. Services for the TaskMenu Carrier is available from the List Agent.

TaskMenuId
integer<int32>

Primary key

Name
string

The list item

Tooltip
string

Tooltip or other description

TableName
string

The name of entity that this task item can be used at

Area
string

Can be Task or other that can identify which menu recipe to merge the item into

UrlOrSoprotocol
string

The url or soprotocol

TaskType
enum<string>

Type of task item Url, SoProtocol or CRMScript.

Available options:
None,
Url,
CrmScript,
SoProtocol
CrmScriptId
integer<int32>

The CRMScript or Macro which will be run task item is selected.

ShowInClient
enum<string>

Show task list item in which clients (web, mobile)

Available options:
None,
Web,
Mobile
ArchiveBehaviour
enum<string>

None, rightclick on, multiselect

Available options:
None,
InArchives,
MultiSelectInArchives
Rank
integer<int32>

Rank order

Encoding
enum<string>

Encoding for url

Available options:
Unknown,
None,
ANSI,
Unicode
ProgId
string

String key that can be used to uniquely retrieve the task menu; particularly useful for partners and others who do not wish to store database ID's

Deleted
boolean

True if deleted

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.