AgileApps Support Wiki

Difference between revisions of "REST API:tenantDataSharingPolicy Resource"

From AgileApps Support Wiki
imported>Aeric
 
imported>Aeric
m (Text replace - '{domain}' to '{{domain}}')
 
(3 intermediate revisions by the same user not shown)
Line 13: Line 13:
;Method:GET
;Method:GET
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/tenantDataSharingPolicy/{recordId}</nowiki></tt>  
;URI:<tt>{{platformURL}}/rest/tenantDataSharingPolicy/{recordId}</tt>  


;Response:
;Response:
Line 23: Line 23:
         <tenant_id>1438232572</tenant_id>
         <tenant_id>1438232572</tenant_id>
         <user_id type="USER"  
         <user_id type="USER"  
           uri="https://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           uri="https://{{domain}}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</user_id>
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</user_id>
         <all_tenants>false</all_tenants>
         <all_tenants>false</all_tenants>
         <date_created>2010-11-12T13:14:15Z</date_created>
         <date_created>2010-11-12T13:14:15Z</date_created>
         <created_id type="USER"  
         <created_id type="USER"  
           uri="https://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           uri="https://{{domain}}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</created_id>
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</created_id>
         <date_modified>2010-11-12T13:14:15Z</date_modified>
         <date_modified>2010-11-12T13:14:15Z</date_modified>
         <modified_id type="USER"  
         <modified_id type="USER"  
           uri="https://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
           uri="https://{{domain}}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
     </tenantDataSharingPolicy>
     </tenantDataSharingPolicy>
Line 49: Line 49:
;Method:GET
;Method:GET
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/tenantDataSharingPolicy</nowiki></tt>  
;URI:<tt>{{platformURL}}/rest/tenantDataSharingPolicy</tt>  
:Return all fields
:Return all fields
;URI::<tt><nowiki>https://{domain}/networking/rest/tenantDataSharingPolicy?{query_parameters}</nowiki></tt>  
;URI::<tt>{{platformURL}}/rest/tenantDataSharingPolicy?{query_parameters}</tt>  
{{Query Parameters|
{{Query Parameters|
::*<tt>fieldList</tt> - A comma-separated list of fields to retrieve.}}
::*<tt>fieldList</tt> - A comma-separated list of fields to retrieve.}}
Line 63: Line 63:
         <tenant_id>1438232572</tenant_id>
         <tenant_id>1438232572</tenant_id>
         <user_id type="USER"  
         <user_id type="USER"  
           uri="https://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           uri="https://{{domain}}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</user_id>
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</user_id>
         <all_tenants>false</all_tenants>
         <all_tenants>false</all_tenants>
         <date_created>2010-11-12T13:14:15Z</date_created>
         <date_created>2010-11-12T13:14:15Z</date_created>
         <created_id type="USER"  
         <created_id type="USER"  
           uri="https://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           uri="https://{{domain}}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"  
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</created_id>
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</created_id>
         <date_modified>2010-11-12T13:14:15Z</date_modified>
         <date_modified>2010-11-12T13:14:15Z</date_modified>
         <modified_id type="USER"  
         <modified_id type="USER"  
           uri="https://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
           uri="https://{{domain}}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
           displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
     </tenantDataSharingPolicy>
     </tenantDataSharingPolicy>
Line 96: Line 96:
;Method:POST
;Method:POST
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/tenantDataSharingPolicy</nowiki></tt>  
;URI:<tt>{{platformURL}}/rest/tenantDataSharingPolicy</tt>  


;Request:
;Request:
Line 127: Line 127:
;Method:PUT
;Method:PUT
   
   
;URI:<tt><nowiki>https://{domain}/networking/rest/tenantDataSharingPolicy</nowiki></tt>  
;URI:<tt>{{platformURL}}/rest/tenantDataSharingPolicy</tt>  


;Request:
;Request:
Line 158: Line 158:
;Method:DELETE
;Method:DELETE


;URI:<tt><nowiki>https://{domain}/networking/rest/tenantDataSharingPolicy/{recordId}</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/tenantDataSharingPolicy/{recordId}</tt>


;Response:
;Response:
Line 176: Line 176:
! Name!!Type!!Attribute!!Required During Add!!Description!!Additional Information
! Name!!Type!!Attribute!!Required During Add!!Description!!Additional Information
|-
|-
| id || String || align="center"|Read Only || || || [[Record Identifier]]
| id || String || align="center"|Read Only || || || [[Record Id]]
|-
|-
| name || String || align="center"|Editable on Add/Update || align="center"|[[File:Checkmark.gif|link=]]<br/>unless all_tenants=true || ||  
| name || String || align="center"|Editable on Add/Update || align="center"|[[File:Checkmark.gif|link=]]<br/>unless all_tenants=true || ||  

Latest revision as of 19:20, 25 April 2014

Allow another tenant's user to login as a local user to access and modify data.

Requirements

The following data is needed to create a tenantDataSharingPolicy:

  • ID of the remote tenant (companyInfo).
  • A local username with which the remote user will log in.

Access Permissions

Lock-tiny.gif

Users that have the Manage Tenants and Company Capabilities permission can use this REST API resource. 

Read a tenantDataSharingPolicy Record

Method
GET
URI
https://{yourDomain}/networking/rest/tenantDataSharingPolicy/{recordId}
Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <tenantDataSharingPolicy>
       <id>d3b663db26ce48c1975873f7fa71587e</id>
       <name>Data Sharing Test</name>
       <tenant_id>1438232572</tenant_id>
       <user_id type="USER" 
          uri="https://{yourDomain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854" 
          displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</user_id>
       <all_tenants>false</all_tenants>
       <date_created>2010-11-12T13:14:15Z</date_created>
       <created_id type="USER" 
         uri="https://{yourDomain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854" 
         displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</created_id>
       <date_modified>2010-11-12T13:14:15Z</date_modified>
       <modified_id type="USER" 
         uri="https://{yourDomain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
         displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
   </tenantDataSharingPolicy>

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Read All tenantDataSharingPolicy Records

Method
GET
URI
https://{yourDomain}/networking/rest/tenantDataSharingPolicy
Return all fields
URI
:https://{yourDomain}/networking/rest/tenantDataSharingPolicy?{query_parameters}
Query Parameters
  • fieldList - A comma-separated list of fields to retrieve.
For more information, see: Specifying Query Parameters in REST APIs
Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <tenantDataSharingPolicy>
       <id>d3b663db26ce48c1975873f7fa71587e</id>
       <name>Data Sharing Test</name>
       <tenant_id>1438232572</tenant_id>
       <user_id type="USER" 
          uri="https://{yourDomain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854" 
          displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</user_id>
       <all_tenants>false</all_tenants>
       <date_created>2010-11-12T13:14:15Z</date_created>
       <created_id type="USER" 
         uri="https://{yourDomain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854" 
         displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</created_id>
       <date_modified>2010-11-12T13:14:15Z</date_modified>
       <modified_id type="USER" 
         uri="https://{yourDomain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
         displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
   </tenantDataSharingPolicy>

   <tenantDataSharingPolicy>
       ...
   </tenantDataSharingPolicy>

    ...

   <message>
       0
       <description>Success</description>
   </message>
   <recordCount>N</recordCount>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Create a tenantDataSharingPolicy Record

Method
POST
URI
https://{yourDomain}/networking/rest/tenantDataSharingPolicy
Request
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <tenantDataSharingPolicy>
       <name>Data Sharing Test</name>
       <tenant_id>1438232572</tenant_id>
       <user_id>ee9583f7e9b3485985230dd5f854</user_id>
       <all_tenants>false</all_tenants>
   </tenantDataSharingPolicy>

</platform> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>
       <id>...</id>     
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Update a tenantDataSharingPolicy Record

Method
PUT
URI
https://{yourDomain}/networking/rest/tenantDataSharingPolicy
Request
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <tenantDataSharingPolicy>
       <id>d3b663db26ce48c1975873f7fa71587e</id>
       <name>Data Sharing Test</name>
       <tenant_id>1438232572</tenant_id>
       <user_id>ee9583f7e9b3485985230dd5f854</user_id>
       <all_tenants>false</all_tenants>
   </tenantDataSharingPolicy>

</platform> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Delete a tenantDataSharingPolicy Record

Method
DELETE
URI
https://{yourDomain}/networking/rest/tenantDataSharingPolicy/{recordId}
Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Fields

Name Type Attribute Required During Add Description Additional Information
id String Read Only Record Id
name String Editable on Add/Update Checkmark.gif
unless all_tenants=true
tenant_id String Editable on Add/Update Checkmark.gif
unless all_tenants=true
user_id Lookup Editable on Add/Update Checkmark.gif User ID
all_tenants Boolean Editable on Add/Update
date_created Date Read Only UTC Format
created_id Lookup Read Only User ID
date_modified Date Read Only UTC Format
modified_id Lookup Read Only User ID
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=REST_API:tenantDataSharingPolicy_Resource&oldid=12350"