AgileApps Support Wiki Pre Release

Difference between revisions of "REST API:tenantCapabilities Resource"

From AgileApps Support Wiki
imported>Alice
(removed Manage Snapshot)
 
imported>Aeric
 
(6 intermediate revisions by the same user not shown)
Line 6: Line 6:
===Get Tenant Capabilities===
===Get Tenant Capabilities===


;URI:<tt><nowiki>https://{domain}/networking/rest/tenantCapabilities/{tenant_id}</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/tenantCapabilities/{tenant_id}</tt>


;Response:
;Response:
Line 31: Line 31:
         <rollup_field_count>11</rollup_field_count>
         <rollup_field_count>11</rollup_field_count>
         <active>true</active>
         <active>true</active>
        <external_lib_path/>
        <subquery_filter>false</subquery_filter>
        <apply_governors>false</apply_governors>
        <schedule_jobs>25</schedule_jobs>
        <governance_tenant_level_on>false</governance_tenant_level_on>
        <governance_tenant_level_string_size/>
        <governance_tenant_level_statement_count/>
        <governance_tenant_level_cpu_time/>
        <SSO>false</SSO>
        <can_access_mobile>true</can_access_mobile>
        <restApiBulkOperationMaxLimit>25</restApiBulkOperationMaxLimit>
     </tenantCapabilities>
     </tenantCapabilities>


Line 46: Line 57:
;Method:PUT
;Method:PUT


;URI:<tt><nowiki>https://{domain}/networking/rest/tenantCapabilities/{tenant_id}</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/tenantCapabilities/{tenant_id}</tt>
;Request
;Request
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">
Line 69: Line 80:
         <rollup_field_count>11</rollup_field_count>
         <rollup_field_count>11</rollup_field_count>
         <active>true</active>
         <active>true</active>
        <external_lib_path/>
        <subquery_filter>false</subquery_filter>
        <apply_governors>false</apply_governors>
        <schedule_jobs>25</schedule_jobs>
        <governance_tenant_level_on>false</governance_tenant_level_on>
        <governance_tenant_level_string_size/>
        <governance_tenant_level_statement_count/>
        <governance_tenant_level_cpu_time/>
        <SSO>false</SSO>
        <can_access_mobile>true</can_access_mobile>
        <restApiBulkOperationMaxLimit>25</restApiBulkOperationMaxLimit>
     </tenantCapabilities>     
     </tenantCapabilities>     
</platform>
</platform>
Line 85: Line 107:


:See also: [[REST API:Error Codes]]
:See also: [[REST API:Error Codes]]
<noinclude>


[[Category:REST API|tenantCapabilities Resource]]
[[Category:REST API|tenantCapabilities Resource]]
</noinclude>

Latest revision as of 02:52, 6 December 2014

Access Permissions

Lock-tiny.gif

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

Get Tenant Capabilities

URI
https://{yourDomain}/networking/rest/tenantCapabilities/{tenant_id}
Response
<syntaxhighlight lang="xml" enclose="div">

<platform>

   <tenantCapabilities>
       <id>1325580066</id>
       <create_objects>true</create_objects>
       <create_application>true</create_application>
       <custom_access_criteria>true</custom_access_criteria>
       <developer_tools>true</developer_tools>
       <digital_signature>true</digital_signature>
       <manage_sites>true</manage_sites>
       <mass_deployment_of_packages>true</mass_deployment_of_packages>
       <multiple_languages>true</multiple_languages>
       <multiple_record_owner>true</multiple_record_owner>
       <object_inheritance>true</object_inheritance>
       <overwrite_previous_package>true</overwrite_previous_package>
       <package_system_generated_objects>true</package_system_generated_objects>
       <publish_package>true</publish_package>
       <install_package_from_file>true</install_package_from_file>
       <synchronous_rollup_summary_fields>true</synchronous_rollup_summary_fields>
       <field_encryption>true</field_encryption>
       <rollup_field_count>11</rollup_field_count>
       <active>true</active>
       <external_lib_path/>
       <subquery_filter>false</subquery_filter>
       <apply_governors>false</apply_governors>
       <schedule_jobs>25</schedule_jobs>
       <governance_tenant_level_on>false</governance_tenant_level_on>
       <governance_tenant_level_string_size/>
       <governance_tenant_level_statement_count/>
       <governance_tenant_level_cpu_time/>
       <SSO>false</SSO>
       <can_access_mobile>true</can_access_mobile>
       <restApiBulkOperationMaxLimit>25</restApiBulkOperationMaxLimit>
   </tenantCapabilities>
   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Update Tenant Capabilities

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

<platform>

   <tenantCapabilities>
       <create_objects>true</create_objects>
       <create_application>true</create_application>
       <custom_access_criteria>true</custom_access_criteria>
       <developer_tools>true</developer_tools>
       <digital_signature>true</digital_signature>
       <manage_sites>true</manage_sites>
       <mass_deployment_of_packages>true</mass_deployment_of_packages>
       <multiple_languages>true</multiple_languages>
       <multiple_record_owner>true</multiple_record_owner>
       <object_inheritance>true</object_inheritance>
       <overwrite_previous_package>true</overwrite_previous_package>
       <package_system_generated_objects>true</package_system_generated_objects>
       <publish_package>true</publish_package>
       <install_package_from_file>true</install_package_from_file>
       <synchronous_rollup_summary_fields>true</synchronous_rollup_summary_fields>
       <field_encryption>true</field_encryption>
       <rollup_field_count>11</rollup_field_count>
       <active>true</active>
       <external_lib_path/>
       <subquery_filter>false</subquery_filter>
       <apply_governors>false</apply_governors>
       <schedule_jobs>25</schedule_jobs>
       <governance_tenant_level_on>false</governance_tenant_level_on>
       <governance_tenant_level_string_size/>
       <governance_tenant_level_statement_count/>
       <governance_tenant_level_cpu_time/>
       <SSO>false</SSO>
       <can_access_mobile>true</can_access_mobile>
       <restApiBulkOperationMaxLimit>25</restApiBulkOperationMaxLimit>
   </tenantCapabilities>    

</platform> </syntaxhighlight>

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

<platform>

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

</platform> </syntaxhighlight>


See also: REST API:Error Codes