REST API:tenantDataSharingPolicy Resource

REST API:tenantDataSharingPolicy Resource

From LongJump Support Wiki

REST API:tenantDataSharingPolicy Resource
Jump to: navigation, search

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

Contents

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

File: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://na.longjump.com/networking/rest/tenantDataSharingPolicy/{recordId}
Response
<platform>
    <tenantDataSharingPolicy>
        <id>d3b663db26ce48c1975873f7fa71587e</id>
        <name>Data Sharing Test</name>
        <tenant_id>1438232572</tenant_id>
        <user_id type="USER"
          uri="https://{domain}/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://{domain}/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://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
         displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
    </tenantDataSharingPolicy>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Read All tenantDataSharingPolicy Records

Method
GET
URI
https://na.longjump.com/networking/rest/tenantDataSharingPolicy
Return all fields
URI
:https://na.longjump.com/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
<platform>
    <tenantDataSharingPolicy>
        <id>d3b663db26ce48c1975873f7fa71587e</id>
        <name>Data Sharing Test</name>
        <tenant_id>1438232572</tenant_id>
        <user_id type="USER"
          uri="https://{domain}/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://{domain}/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://{domain}/networking/rest/user/ee9583f7e9b348598523df0dd5f854"
         displayValue="John Lee">ee9583f7e9b348598523df0dd5f854</modified_id>
    </tenantDataSharingPolicy>

    <tenantDataSharingPolicy>
        ...
    </tenantDataSharingPolicy>

     ...

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Count of records returned -->
</platform>
See also: REST API:Error Codes

Create a tenantDataSharingPolicy Record

Method
POST
URI
https://na.longjump.com/networking/rest/tenantDataSharingPolicy
Request
<platform>
    <tenantDataSharingPolicy>
        <name>Data Sharing Test</name>
        <tenant_id>1438232572</tenant_id>
        <user_id>ee9583f7e9b3485985230dd5f854</user_id>
        <all_tenants>false</all_tenants>
    </tenantDataSharingPolicy>
</platform>
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>...</id>     <!-- ID of the newly created tenantDataSharingPolicy -->
    </message>
</platform>
See also: REST API:Error Codes

Update a tenantDataSharingPolicy Record

Method
PUT
URI
https://na.longjump.com/networking/rest/tenantDataSharingPolicy
Request
<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>
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Delete a tenantDataSharingPolicy Record

Method
DELETE
URI
https://na.longjump.com/networking/rest/tenantDataSharingPolicy/{recordId}
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Fields

NameTypeAttributeRequired During AddDescriptionAdditional Information
id String Read Only Record Id
name String Editable on Add/Update
unless all_tenants=true
tenant_id String Editable on Add/Update
unless all_tenants=true
user_id Lookup Editable on Add/Update User ID
all_tenants BooleanEditable on Add/Update
date_createdDateRead Only UTC Format
created_idLookupRead Only User ID
date_modifiedDateRead Only UTC Format
modified_idLookup Read Only User ID
Personal tools