POST Agents/List/GetAppTaskMenus

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/List/GetAppTaskMenus

Get all task menus owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken

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/List/GetAppTaskMenus?$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:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
TaskMenuId 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 string Type of task item Url, SoProtocol or CRMScript.
CrmScriptId int32 The CRMScript or Macro which will be run task item is selected.
ShowInClient string Show task list item in which clients (web, mobile)
ArchiveBehaviour string None, rightclick on, multiselect
Rank int32 Rank order
Encoding string Encoding for url
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 bool True if deleted
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/GetAppTaskMenus
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

[
  {
    "TaskMenuId": 243,
    "Name": "Marquardt-Ortiz",
    "Tooltip": "dolores",
    "TableName": "Von, Morissette and Leffler",
    "Area": "est",
    "UrlOrSoprotocol": "http://www.example.com/",
    "TaskType": "CrmScript",
    "CrmScriptId": 26,
    "ShowInClient": "Mobile",
    "ArchiveBehaviour": "InArchives",
    "Rank": 283,
    "Encoding": "ANSI",
    "ProgId": "eum",
    "Deleted": true,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 647
      }
    }
  }
]