REST API: applicationTabs

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 set the objects you want to view as tabs in the application.

Method

PUT

URI

https://{yourDomain}/networking/rest/user/applicationTabs

Request

   <platform>
      <user>
         <application>servicedesk</application>
         <workspacepreference>
            <element>cases</element>
            <element>reports</element>
         </workspacepreference>
      </user>
   </platform>

Response

   <platform>
      <message>
         <code>1</code>
         <description>Application tabs updated successfully</description>
      </message>
   </platform>

See also: REST API:Error Codes

Get the Application Tabs

Retrieves the list of tabs for the application you are currently logged into.

Method

GET

URI

https://{yourDomain}/networking/rest/user/applicationTabs

Response

   <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>

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 retrieve the list of tabs for a the application, the ID of which you pass in the URI.

Method

GET

URI

https://localhost/networking/rest/user/applicationTab/<applicationID>

Response

   <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>

See also: REST API:Error Codes