Difference between revisions of "REST API: applicationTabs"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 1: | Line 1: | ||
This API allows you to customize the '''Application Tabs''' settings available in '''My Settings''' on your profile page. This allows you to customize the object tabs you want to see in the screen when you log into a particular application. | This API allows you to customize the '''Application Tabs''' settings available in '''My Settings''' on your profile page. This allows you to customize the object tabs you want to see in the screen when you log into a particular application. | ||
=== | ===Update Application Tab=== | ||
Allows you to | Allows you to update the objects in the Application Tab. | ||
;Method: | ;Method:PUT | ||
;URI:<tt>https://{yourDomain}/networking/rest/ | ;URI:<tt>https://{yourDomain}/networking/rest/user/applicationtabs</tt> | ||
;Request: | ;Request: | ||
:<syntaxhighlight lang="html4strict" enclose="div"> | :<syntaxhighlight lang="html4strict" enclose="div"> | ||
<root> | |||
<platform> | |||
<user> | |||
<application>servicedesk</application> | |||
<workspacepreference> | |||
<element>cases</element> | |||
<element>reports</element> | |||
</workspacepreference> | |||
</user> | |||
</platform> | |||
</root> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
;Response: | ;Response: | ||
:<syntaxhighlight lang="html4strict" enclose="div"> | :<syntaxhighlight lang="html4strict" enclose="div"> | ||
<root> | |||
<platform> | |||
<message> | |||
<code>1</code> | |||
<description>Application tabs updated successfully</description> | |||
</message> | |||
</platform> | |||
</root> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
:See also: [[REST API:Error Codes]] | :See also: [[REST API:Error Codes]] | ||
=== | ===Get the Application Tabs=== | ||
Retrieves the list of | Retrieves the list of objects for Application Tab. | ||
;Method:GET | ;Method:GET | ||
;URI:<tt>https://{yourDomain}/networking/rest/user/applicationtabs</tt> | |||
;URI:<tt>https://{yourDomain}/networking/rest/ | |||
;Response: | ;Response: | ||
:<syntaxhighlight lang="html4strict" enclose="div"> | :<syntaxhighlight lang="html4strict" enclose="div"> | ||
<root> | |||
<platform> | |||
<message> | |||
<code>0</code> | |||
<description>Success</description> | |||
</message> | |||
<userApplicationTab> | |||
<applications> | |||
<element> | |||
<content>2dac0fe6d8614c95838ff6a5ed9d3d65</content> | |||
<displayValue>DCM DAP</displayValue> | |||
<uri>https://localhost/networking/rest/application/2dac0fe6d8614c95838ff6a5ed9d3d65</uri> | |||
</element> | |||
<element> | |||
<content>b1b845f1dc4c4c82ad161049893d7f4f</content> | |||
<displayValue>DEP01</displayValue> | |||
<uri>https://localhost/networking/rest/application/b1b845f1dc4c4c82ad161049893d7f4f</uri> | |||
</element> | |||
<element> | |||
<content>1de288ff88f54623a1c5fc2c1729b9f0</content> | |||
<displayValue>Reports test</displayValue> | |||
<uri>https://localhost/networking/rest/application/1de288ff88f54623a1c5fc2c1729b9f0</uri> | |||
</element> | |||
<element> | |||
<content>1</content> | |||
<displayValue>Service Desk</displayValue> | |||
<uri>https://localhost/networking/rest/application/1</uri> | |||
</element> | |||
<element> | |||
<content>4a51a9de7fa84a8d9114e7fdb437533d</content> | |||
<displayValue>dep test 4</displayValue> | |||
<uri>https://localhost/networking/rest/application/4a51a9de7fa84a8d9114e7fdb437533d</uri> | |||
</element> | |||
<element> | |||
<content>99621d766bf043e08ad35303050c0044</content> | |||
<displayValue>enRoute</displayValue> | |||
<uri>https://localhost/networking/rest/application/99621d766bf043e08ad35303050c0044</uri> | |||
</element> | |||
</applications> | |||
<hiddenTabs> | |||
<element> | |||
<displayValue>Tasks - tasks</displayValue> | |||
<tabid>tasks</tabid> | |||
</element> | |||
<element> | |||
<displayValue>AllFieldObject</displayValue> | |||
<tabid>5fdd703d561444239d97800a295f6f09</tabid> | |||
</element> | |||
<element> | |||
<displayValue>testobj1</displayValue> | |||
<tabid>6e7d33f131954d05aeaf277b318ed3f6</tabid> | |||
</element> | |||
</hiddenTabs> | |||
<id>1</id> | |||
<selectedTabs> | |||
<element> | |||
<displayValue>Cases - cases</displayValue> | |||
<tabid>cases</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Accounts</displayValue> | |||
<tabid>accounts</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Contacts</displayValue> | |||
<tabid>contacts</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Articles</displayValue> | |||
<tabid>articles</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Twitter</displayValue> | |||
<tabid>twitter</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Reports</displayValue> | |||
<tabid>259</tabid> | |||
</element> | |||
<element> | |||
<displayValue>TTT</displayValue> | |||
<tabid>0354f7afd6de466ba28cff81c22b526c</tabid> | |||
</element> | |||
</selectedTabs> | |||
</userApplicationTab> | |||
</platform> | |||
</root> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
:See also: [[REST API:Error Codes]] | :See also: [[REST API:Error Codes]] | ||
=== | ===Sample PUT Body=== | ||
This is a sample for the PUT body. | |||
;Method:PUT | ;Method:PUT | ||
;URI:<tt>https:// | ;URI:<tt>https://localhost/networking/rest/user/applicationTabs</tt> | ||
;Response | ;Response | ||
:<syntaxhighlight lang="html4strict" enclose="div"> | :<syntaxhighlight lang="html4strict" enclose="div"> | ||
<root> | |||
<platform> | |||
<userApplicationTab> | |||
<id>1</id> | |||
<selectedTabs> | |||
<element> | |||
<displayValue>Cases - cases</displayValue> | |||
<tabid>cases</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Accounts</displayValue> | |||
<tabid>accounts</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Contacts</displayValue> | |||
<tabid>contacts</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Articles</displayValue> | |||
<tabid>articles</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Twitter</displayValue> | |||
<tabid>twitter</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Reports</displayValue> | |||
<tabid>259</tabid> | |||
</element> | |||
<element> | |||
<displayValue>TTT</displayValue> | |||
<tabid>0354f7afd6de466ba28cff81c22b526c</tabid> | |||
</element> | |||
</selectedTabs> | |||
</userApplicationTab> | |||
</platform> | |||
</root> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
:See also: [[REST API:Error Codes]] | :See also: [[REST API:Error Codes]] | ||
=== | ===GET for a Particular Application=== | ||
Allows you to | Allows you to get the Application Tab for a particular application. | ||
;Method: | ;Method:GET | ||
;URI:<tt>https://{yourDomain}/networking/rest/delegation/<delegationId></tt> | ;URI:<tt>https://{yourDomain}/networking/rest/delegation/<delegationId></tt> | ||
;Response: | ;Response: | ||
:<syntaxhighlight lang="html4strict" enclose="div"> | :<syntaxhighlight lang="html4strict" enclose="div"> | ||
<root> | |||
<platform> | |||
<message> | |||
<code>0</code> | |||
<description>Success</description> | |||
</message> | |||
<userApplicationTab> | |||
<hiddenTabs> | |||
<element> | |||
<displayValue>Tasks - tasks</displayValue> | |||
<tabid>tasks</tabid> | |||
</element> | |||
<element> | |||
<displayValue>testobj1</displayValue> | |||
<tabid>6e7d33f131954d05aeaf277b318ed3f6</tabid> | |||
</element> | |||
</hiddenTabs> | |||
<id>1</id> | |||
<selectedTabs> | |||
<element> | |||
<displayValue>Cases - cases</displayValue> | |||
<tabid>cases</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Accounts</displayValue> | |||
<tabid>accounts</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Contacts</displayValue> | |||
<tabid>contacts</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Articles</displayValue> | |||
<tabid>articles</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Twitter</displayValue> | |||
<tabid>twitter</tabid> | |||
</element> | |||
<element> | |||
<displayValue>Reports</displayValue> | |||
<tabid>259</tabid> | |||
</element> | |||
<element> | |||
<displayValue>AllFieldObject</displayValue> | |||
<tabid>5fdd703d561444239d97800a295f6f09</tabid> | |||
</element> | |||
<element> | |||
<displayValue>TTT</displayValue> | |||
<tabid>0354f7afd6de466ba28cff81c22b526c</tabid> | |||
</element> | |||
</selectedTabs> | |||
</userApplicationTab> | |||
</platform> | |||
</root> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 08:26, 23 August 2018
This API allows you to customize the Application Tabs settings available in My Settings on your profile page. This allows you to customize the object tabs you want to see in the screen when you log into a particular application.
Update Application Tab
Allows you to update the objects in the Application Tab.
- Method
- PUT
- URI
- https://{yourDomain}/networking/rest/user/applicationtabs
- Request
<root> <platform> <user> <application>servicedesk</application> <workspacepreference> <element>cases</element> <element>reports</element> </workspacepreference> </user> </platform> </root>
- Response
<root> <platform> <message> <code>1</code> <description>Application tabs updated successfully</description> </message> </platform> </root>
- See also: REST API:Error Codes
Get the Application Tabs
Retrieves the list of objects for Application Tab.
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/user/applicationtabs
- Response
<root> <platform> <message> <code>0</code> <description>Success</description> </message> <userApplicationTab> <applications> <element> <content>2dac0fe6d8614c95838ff6a5ed9d3d65</content> <displayValue>DCM DAP</displayValue> <uri>https://localhost/networking/rest/application/2dac0fe6d8614c95838ff6a5ed9d3d65</uri> </element> <element> <content>b1b845f1dc4c4c82ad161049893d7f4f</content> <displayValue>DEP01</displayValue> <uri>https://localhost/networking/rest/application/b1b845f1dc4c4c82ad161049893d7f4f</uri> </element> <element> <content>1de288ff88f54623a1c5fc2c1729b9f0</content> <displayValue>Reports test</displayValue> <uri>https://localhost/networking/rest/application/1de288ff88f54623a1c5fc2c1729b9f0</uri> </element> <element> <content>1</content> <displayValue>Service Desk</displayValue> <uri>https://localhost/networking/rest/application/1</uri> </element> <element> <content>4a51a9de7fa84a8d9114e7fdb437533d</content> <displayValue>dep test 4</displayValue> <uri>https://localhost/networking/rest/application/4a51a9de7fa84a8d9114e7fdb437533d</uri> </element> <element> <content>99621d766bf043e08ad35303050c0044</content> <displayValue>enRoute</displayValue> <uri>https://localhost/networking/rest/application/99621d766bf043e08ad35303050c0044</uri> </element> </applications> <hiddenTabs> <element> <displayValue>Tasks - tasks</displayValue> <tabid>tasks</tabid> </element> <element> <displayValue>AllFieldObject</displayValue> <tabid>5fdd703d561444239d97800a295f6f09</tabid> </element> <element> <displayValue>testobj1</displayValue> <tabid>6e7d33f131954d05aeaf277b318ed3f6</tabid> </element> </hiddenTabs> <id>1</id> <selectedTabs> <element> <displayValue>Cases - cases</displayValue> <tabid>cases</tabid> </element> <element> <displayValue>Accounts</displayValue> <tabid>accounts</tabid> </element> <element> <displayValue>Contacts</displayValue> <tabid>contacts</tabid> </element> <element> <displayValue>Articles</displayValue> <tabid>articles</tabid> </element> <element> <displayValue>Twitter</displayValue> <tabid>twitter</tabid> </element> <element> <displayValue>Reports</displayValue> <tabid>259</tabid> </element> <element> <displayValue>TTT</displayValue> <tabid>0354f7afd6de466ba28cff81c22b526c</tabid> </element> </selectedTabs> </userApplicationTab> </platform> </root>
- See also: REST API:Error Codes
Sample PUT Body
This is a sample for the PUT body.
- Method
- PUT
- URI
- https://localhost/networking/rest/user/applicationTabs
- Response
<root> <platform> <userApplicationTab> <id>1</id> <selectedTabs> <element> <displayValue>Cases - cases</displayValue> <tabid>cases</tabid> </element> <element> <displayValue>Accounts</displayValue> <tabid>accounts</tabid> </element> <element> <displayValue>Contacts</displayValue> <tabid>contacts</tabid> </element> <element> <displayValue>Articles</displayValue> <tabid>articles</tabid> </element> <element> <displayValue>Twitter</displayValue> <tabid>twitter</tabid> </element> <element> <displayValue>Reports</displayValue> <tabid>259</tabid> </element> <element> <displayValue>TTT</displayValue> <tabid>0354f7afd6de466ba28cff81c22b526c</tabid> </element> </selectedTabs> </userApplicationTab> </platform> </root>
- See also: REST API:Error Codes
GET for a Particular Application
Allows you to get the Application Tab for a particular application.
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/delegation/<delegationId>
- Response
<root> <platform> <message> <code>0</code> <description>Success</description> </message> <userApplicationTab> <hiddenTabs> <element> <displayValue>Tasks - tasks</displayValue> <tabid>tasks</tabid> </element> <element> <displayValue>testobj1</displayValue> <tabid>6e7d33f131954d05aeaf277b318ed3f6</tabid> </element> </hiddenTabs> <id>1</id> <selectedTabs> <element> <displayValue>Cases - cases</displayValue> <tabid>cases</tabid> </element> <element> <displayValue>Accounts</displayValue> <tabid>accounts</tabid> </element> <element> <displayValue>Contacts</displayValue> <tabid>contacts</tabid> </element> <element> <displayValue>Articles</displayValue> <tabid>articles</tabid> </element> <element> <displayValue>Twitter</displayValue> <tabid>twitter</tabid> </element> <element> <displayValue>Reports</displayValue> <tabid>259</tabid> </element> <element> <displayValue>AllFieldObject</displayValue> <tabid>5fdd703d561444239d97800a295f6f09</tabid> </element> <element> <displayValue>TTT</displayValue> <tabid>0354f7afd6de466ba28cff81c22b526c</tabid> </element> </selectedTabs> </userApplicationTab> </platform> </root>
- See also: REST API:Error Codes
Fields
- Notes:
- In this object, Boolean fields accept either 1/0 or TRUE/FALSE
- Because there are so many fields, and so many of them can be empty, empty fields generally are not returned as part of user data. However, they can still be specified for an update.
- Role list appears in the API output or considered as input only when the Switch Roles permission is enabled in company information.
- Role ID value "-1" means ALL Roles.
Name Type Description Additional Information Active Boolean Indicates if a delegation is active or inactive. TRUE means a delegation is active and FALSE means the delegatee is not shown in the list of delegatees during the run time Become Delegate action. applicationId String The ID of an application createdID Lookup This is the user ID bean User ID dateCreated Date Date of delegation creation or resource creation dateModified Date Date the delegation role is applied UTC Format delegateAccessProfile Boolean Allows you to manage the delegation when set to TRUE. delegatee String User receiving the delegation from a Principal User. id String The ID for this record modifiedId Lookup The ID of the record used for updating the resource User ID principalUser String The user delegating the profile to a Delegate User roleId String The particular role of the principal user which is delegated to the delegatee