Get Task Menu By Prog Id
Get a task menu using the ProgId key that was specified when it was created
NsApiSlow threshold: 5000 ms.
Authorizations
SuperOffice username:password are passed in Base64-encoded.
You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.
SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/
passing in the application id and redirect URL.
SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)
https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f
You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.
- Authorization URL
- https://online.superoffice.com/login/common/oauth/authorize
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
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
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.
Primary key
The list item
Tooltip or other description
The name of entity that this task item can be used at
Can be Task or other that can identify which menu recipe to merge the item into
The url or soprotocol
Type of task item Url, SoProtocol or CRMScript.
None, Url, CrmScript, SoProtocol The CRMScript or Macro which will be run task item is selected.
Show task list item in which clients (web, mobile)
None, Web, Mobile None, rightclick on, multiselect
None, InArchives, MultiSelectInArchives Rank order
Encoding for url
Unknown, None, ANSI, Unicode 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
True if deleted
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.