AgileApps Support Wiki

Difference between revisions of "REST API: applicationTabs"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(7 intermediate revisions by the same user not shown)
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.


===Add a User for Delegation===
===Update Application Tab===
Allows you to add users to the Delegated users list.  
Allows you to set the objects you want to view as tabs in the application.  
;Method:POST
;Method:PUT
;URI:<tt>https://{yourDomain}/networking/rest/delegation/</tt>
;URI:<tt>https://{yourDomain}/networking/rest/user/applicationTabs</tt>
;Request:
;Message Body:
:<syntaxhighlight lang="html4strict" enclose="div">
:<syntaxhighlight lang="html4strict" enclose="div">
<platform>
    <platform>
<delegation>
      <userApplicationTab>
<active>false</active>
        <id>1</id>
<applicationId>08455b174ee14b26859c44c60f2ceb7b</applicationId>
        <selectedTabs>
<createdId>
            <element>
<content>b2c6fb3b59ba4f9a9c212f20be284df5</content>
              <displayValue>Cases - cases</displayValue>
<displayValue>Fix Fix2</displayValue>
              <tabid>cases</tabid>
<type>USER</type>
            </element>
<uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri>
            <element>
</createdId>
              <displayValue>Accounts</displayValue>
<dateCreated>2018-07-26T00:46:41.000Z</dateCreated>
              <tabid>accounts</tabid>
<dateModified>2018-07-26T06:09:09.000Z</dateModified>
            </element>
<delegateAccessProfile>false</delegateAccessProfile>
            <element>
<delegatee>
              <displayValue>Contacts</displayValue>
<content>b2c6fb3b59ba4f9a9c212f20be284df5</content>
              <tabid>contacts</tabid>
<displayValue>Fix Fix2</displayValue>
            </element>
<type>USER</type>
            <element>
<uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri>
              <displayValue>Articles</displayValue>
</delegatee>
              <tabid>articles</tabid>
<id>ee35804e4c2942b999d8b5521e786fd7</id>
            </element>
<modifiedId>
            <element>
<content>b2c6fb3b59ba4f9a9c212f20be284df5</content>
              <displayValue>Reports</displayValue>
<displayValue>Fix Fix2</displayValue>
              <tabid>259</tabid>
<type>USER</type>
            </element>
<uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri>
        </selectedTabs>
</modifiedId>
      </userApplicationTab>
<prinicpalUser>
  </platform>
<content>792a8e8725104cb58e5d337ea730f59b</content>
<displayValue>Fit fit</displayValue>
<type>USER</type>
<uri>https://localhost/networking/rest/user/792a8e8725104cb58e5d337ea730f59b</uri>
</prinicpalUser>
<roleId>
<content>18d2099643e64deab4a174dc113a5174</content>
<displayValue>Agent</displayValue>
<type>ROLE</type>
<uri>https://localhost/networking/rest/role/18d2099643e64deab4a174dc113a5174</uri>
</roleId>
<roleId>
<content>c7b03526a90c44cdbbfdaa4e5564c6a9</content>
<displayValue>Manager</displayValue>
<type>ROLE</type>
<uri>https://localhost/networking/rest/role/c7b03526a90c44cdbbfdaa4e5564c6a9</uri>
</roleId>
</delegation>
</platform>
</syntaxhighlight>
</syntaxhighlight>
;Response:
;Response:
:<syntaxhighlight lang="html4strict" enclose="div">
:<syntaxhighlight lang="html4strict" enclose="div">
<platform>
  <platform>
<message>
      <message>
<code>0</code>
        <code>1</code>
<description>Success</description>
        <description>Application tabs updated successfully</description>
<id>&lt;delegationId&gt;</id>
      </message>
</message>
  </platform>
</platform>
</syntaxhighlight>
</syntaxhighlight>
:See also: [[REST API:Error Codes]]
:See also: [[REST API:Error Codes]]


===Retrieve the Delegated Users list===
===Get the Application Tabs===
Retrieves the list of delegated users.
Retrieves the list of tabs for the application you are currently logged into.
;Method:GET
;Method:GET
 
;URI:<tt>https://{yourDomain}/networking/rest/user/applicationTabs</tt>
;URI:<tt>https://{yourDomain}/networking/rest/delegation/<delegationId></tt>
;Response:
;Response:
:<syntaxhighlight lang="html4strict" enclose="div">
:<syntaxhighlight lang="html4strict" enclose="div">
<platform>
  <platform>
<delegation>
      <message>
<active>false</active>
        <code>0</code>
<applicationId>08455b174ee14b26859c44c60f2ceb7b</applicationId>
        <description>Success</description>
<createdId>
      </message>
<content>b2c6fb3b59ba4f9a9c212f20be284df5</content>
      <userApplicationTab>
<displayValue>Fix Fix2</displayValue>
        <applications>
<type>USER</type>
            <element>
<uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri>
              <content>2dac0fe6d8614c95838ff6a5ed9d3d65</content>
</createdId>
              <displayValue>DCM DAP</displayValue>
<dateCreated>2018-07-26T00:46:41.000Z</dateCreated>
              <uri>https://localhost/networking/rest/application/2dac0fe6d8614c95838ff6a5ed9d3d65</uri>
<dateModified>2018-07-26T06:09:09.000Z</dateModified>
            </element>
<delegateAccessProfile>false</delegateAccessProfile>
            <element>
<delegatee>
              <content>b1b845f1dc4c4c82ad161049893d7f4f</content>
<content>b2c6fb3b59ba4f9a9c212f20be284df5</content>
              <displayValue>DEP01</displayValue>
<displayValue>Fix Fix2</displayValue>
              <uri>https://localhost/networking/rest/application/b1b845f1dc4c4c82ad161049893d7f4f</uri>
<type>USER</type>
            </element>
<uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri>
            <element>
</delegatee>
              <content>1de288ff88f54623a1c5fc2c1729b9f0</content>
<id>ee35804e4c2942b999d8b5521e786fd7</id>
              <displayValue>Reports test</displayValue>
<modifiedId>
              <uri>https://localhost/networking/rest/application/1de288ff88f54623a1c5fc2c1729b9f0</uri>
<content>b2c6fb3b59ba4f9a9c212f20be284df5</content>
            </element>
<displayValue>Fix Fix2</displayValue>
            <element>
<type>USER</type>
              <content>1</content>
<uri>https://localhost/networking/rest/user/b2c6fb3b59ba4f9a9c212f20be284df5</uri>
              <displayValue>Service Desk</displayValue>
</modifiedId>
              <uri>https://localhost/networking/rest/application/1</uri>
<prinicpalUser>
            </element>
<content>792a8e8725104cb58e5d337ea730f59b</content>
            <element>
<displayValue>Fit fit</displayValue>
              <content>4a51a9de7fa84a8d9114e7fdb437533d</content>
<type>USER</type>
              <displayValue>dep test 4</displayValue>
<uri>https://localhost/networking/rest/user/792a8e8725104cb58e5d337ea730f59b</uri>
              <uri>https://localhost/networking/rest/application/4a51a9de7fa84a8d9114e7fdb437533d</uri>
</prinicpalUser>
            </element>
<roleId>
            <element>
<content>18d2099643e64deab4a174dc113a5174</content>
              <content>99621d766bf043e08ad35303050c0044</content>
<displayValue>Agent</displayValue>
              <displayValue>enRoute</displayValue>
<type>ROLE</type>
              <uri>https://localhost/networking/rest/application/99621d766bf043e08ad35303050c0044</uri>
<uri>https://localhost/networking/rest/role/18d2099643e64deab4a174dc113a5174</uri>
            </element>
</roleId>
        </applications>
<roleId>
        <hiddenTabs>
<content>c7b03526a90c44cdbbfdaa4e5564c6a9</content>
            <element>
<displayValue>Manager</displayValue>
              <displayValue>Tasks - tasks</displayValue>
<type>ROLE</type>
              <tabid>tasks</tabid>
<uri>https://localhost/networking/rest/role/c7b03526a90c44cdbbfdaa4e5564c6a9</uri>
            </element>
</roleId>
            <element>
</delegation>
              <displayValue>AllFieldObject</displayValue>
<message>
              <tabid>5fdd703d561444239d97800a295f6f09</tabid>
<code>0</code>
            </element>
<description>Success</description>
            <element>
</message>
              <displayValue>testobj1</displayValue>
</platform>
              <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>Reports</displayValue>
              <tabid>259</tabid>
            </element>
            <element>
              <displayValue>TTT</displayValue>
              <tabid>0354f7afd6de466ba28cff81c22b526c</tabid>
            </element>
        </selectedTabs>
      </userApplicationTab>
  </platform>
</syntaxhighlight>
</syntaxhighlight>
:See also: [[REST API:Error Codes]]
:See also: [[REST API:Error Codes]]


===Update the List of Delegated Users===
===GET for a Particular Application===
Allows you to update the list of delegated users.
Allows you to retrieve the list of tabs for an application, the ID of which you pass in the URI.
 
;Method:GET
;Method:PUT
;URI:<tt>https://localhost/networking/rest/user/applicationTab/<applicationID></tt>
;URI:<tt>https://{yourDomain}/networking/rest/delegation/<delegationId></tt>
;Response
:<syntaxhighlight lang="html4strict" enclose="div">
<platform>
<message>
<code>0</code>
<description>Success</description>
<id>&lt;delegationId&gt;</id>
</message>
</platform>
</syntaxhighlight>
:See also: [[REST API:Error Codes]]
 
 
===Delete a Delegated User===
Allows you to delete a delegated user.
;Method:DELETE
;URI:<tt>https://{yourDomain}/networking/rest/delegation/<delegationId></tt>
;Response:
;Response:
:<syntaxhighlight lang="html4strict" enclose="div">
:<syntaxhighlight lang="html4strict" enclose="div">
<platform>
  <platform>
<message>
      <message>
<code>0</code>
        <code>0</code>
<description>Success</description>
        <description>Success</description>
</message>
      </message>
</platform>
      <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>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>
</syntaxhighlight>
</syntaxhighlight>


:See also: [[REST API:Error Codes]]
: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.
:{| border="1" cellpadding="5" cellspacing="0"
! 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||
|}


<noinclude>
<noinclude>


[[Category:REST API|Session Management Resources]]
[[Category:REST API|application Resource]]
</noinclude>
</noinclude>

Latest revision as of 07:39, 16 July 2019

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
Message Body
    <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>Reports</displayValue>
               <tabid>259</tabid>
            </element>
         </selectedTabs>
      </userApplicationTab>
   </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>Reports</displayValue>
               <tabid>259</tabid>
            </element>
            <element>
               <displayValue>TTT</displayValue>
               <tabid>0354f7afd6de466ba28cff81c22b526c</tabid>
            </element>
         </selectedTabs>
      </userApplicationTab>
   </platform>
See also: REST API:Error Codes

GET for a Particular Application

Allows you to retrieve the list of tabs for an 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>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
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=REST_API:_applicationTabs&oldid=27083"