Difference between revisions of "REST API:REST API CheatSheet"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 1: Line 1:
'''Resource URI:''' <tt>https://{domain}/networking/rest/{resource}
'''Resource URI:''' <tt>https://{domain}/networking/rest/{resource}


===Session Resources===
====Session Resources====
<div align="center"> [[REST API:login Resource|login]], [[REST API:logout Resource|logout]], [[REST API:user Resource|user]]</div>
<div align="center"> [[REST API:login Resource|login]], [[REST API:logout Resource|logout]], [[REST API:user Resource|user]]</div>


Line 18: Line 18:
|}
|}


===Administration Resources===  
====Administration Resources====  
<!-- auditLog -->
<!-- auditLog -->
<div align="center">[[REST API:auditLog Resource|auditLog]]</div>
<div align="center">[[REST API:auditLog Resource|auditLog]]</div>
Line 40: Line 40:


<!-- passwordPolicy -->
<!-- passwordPolicy -->
<div align="center">[[REST API:passwordPolicy Resource|passwordPolicy]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:passwordPolicy Resource|passwordPolicy]]
|-
|-
| align="center"|GET  || passwordPolicy || Retrieve record that specifies restrictions on passwords that users can choose. ||  ||
| align="center"|GET  || passwordPolicy || Retrieve record that specifies restrictions on passwords that users can choose. ||  ||
Line 51: Line 50:


<!-- user -->
<!-- user -->
<div align="center">[[REST API:user Resource|user]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:user Resource|user]]
|-
|-
| align="center"|GET  || user/{user_id} || Get a user record. ||  ||  
| align="center"|GET  || user/{user_id} || Get a user record. ||  ||  
Line 70: Line 68:


<!-- role -->
<!-- role -->
<div align="center">[[REST API:role Resource|role]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:role Resource|role]]
|-
|-
| align="center"|GET  || role/{role_id} || Get a role definition. ||  ||
| align="center"|GET  || role/{role_id} || Get a role definition. ||  ||
Line 87: Line 84:


<!-- team -->
<!-- team -->
<div align="center">[[REST API:team Resource|team]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:team Resource|team]]
|-
|-
| align="center"|GET  || team/{team_id} || Get a team record. ||  ||
| align="center"|GET  || team/{team_id} || Get a team record. ||  ||
Line 104: Line 100:


<!-- userTeam -->
<!-- userTeam -->
<div align="center">[[REST API:userTeam Resource|userTeam]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:userTeam Resource|userTeam]]
|-
|-
| align="center"|GET  || userTeam/{record_id} || Get a user/team junction record. ||  ||
| align="center"|GET  || userTeam/{record_id} || Get a user/team junction record. ||  ||
Line 120: Line 115:
|}
|}


<!-- =================================================== -->
==== Data Sharing Resources ====
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" |<br/>'''Data Sharing Resources''' <div align="center">[[REST API:teamDataSharingPolicy Resource|teamDataSharingPolicy]]</div>
|}
 
<!-- teamDataSharingPolicy -->
<!-- teamDataSharingPolicy -->
<div align="center">[[REST API:teamDataSharingPolicy Resource|teamDataSharingPolicy]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
Line 143: Line 133:


<!-- tenantDataSharingPolicy -->
<!-- tenantDataSharingPolicy -->
<div align="center">[[REST API:tenantDataSharingPolicy Resource|tenantDataSharingPolicy]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:tenantDataSharingPolicy Resource|tenantDataSharingPolicy]]
|-
|-
| align="center"|GET  || tenantDataSharingPolicy || List policies for sharing data between tenants. || read all ||
| align="center"|GET  || tenantDataSharingPolicy || List policies for sharing data between tenants. || read all ||
Line 159: Line 148:
|}
|}


<!-- =================================================== -->
==== Data Management Resources ====
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Data Management Resources''' <div align="center"> [[REST API:record Resource|record]]</div>
|}
 
<!-- record -->
<!-- record -->
<div align="center">[[REST API:record Resource|record]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
Line 182: Line 166:


<!-- composite -->
<!-- composite -->
<div align="center">[[REST API:composite record Resource|composite record]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:composite record Resource|composite record]]
|-
|-
| align="center"|GET  || record/{objectName}/{record_id} || Retrieve an object record, along with records from related objects. ||  ||
| align="center"|GET  || record/{objectName}/{record_id} || Retrieve an object record, along with records from related objects. ||  ||
Line 199: Line 182:


<!-- recordLocator -->
<!-- recordLocator -->
<div align="center">[[REST API:recordLocator Resource|recordLocator]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:recordLocator Resource|recordLocator]]
|-
|-
| align="center"|GET  || recordLocator/{record_id} || Get the record that defines indexes for an object. ||  ||
| align="center"|GET  || recordLocator/{record_id} || Get the record that defines indexes for an object. ||  ||
Line 210: Line 192:


<!-- bulk -->
<!-- bulk -->
<div align="center">[[REST API:bulk Resource|bulk]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:bulk Resource|bulk]]
|-
|-
| align="center"|POST || bulk/{objectName} || Upload multiple records to a {{type}} in a single transaction. || system obj || mapping+special<br/>(multipart w/data file)
| align="center"|POST || bulk/{objectName} || Upload multiple records to a {{type}} in a single transaction. || system obj || mapping+special<br/>(multipart w/data file)
Line 221: Line 202:


<!-- document -->
<!-- document -->
<div align="center">[[REST_API:document_Resource|document]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST_API:document_Resource|document]]
|-
|-
| align="center"|GET  || document/{documentId} || Download a stored document. || download ||
| align="center"|GET  || document/{documentId} || Download a stored document. || download ||
Line 230: Line 210:


<!-- execSQL -->
<!-- execSQL -->
<div align="center">[[REST_API:execSQL Resource|execSQL]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST_API:execSQL Resource|execSQL]]
|-
|-
| align="center"|GET  || execSQL?sql={query_string} || Make a SQL query. || Result set ||
| align="center"|GET  || execSQL?sql={query_string} || Make a SQL query. || Result set ||
|}
|}


<!-- =================================================== -->
==== Workflow Resources ====
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Workflow Resources''' <div align="center">[[REST API:workflowAction Resource|workflowAction]]</div>
|}
 
<!-- workflowAction -->
<!-- workflowAction -->
<div align="center">[[REST API:workflowAction Resource|workflowAction]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
Line 253: Line 227:


<!-- record -->
<!-- record -->
<div align="center">[[REST API:record Resource|record]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:record Resource|record]]
|-
|-
| align="center"|GET  || record/{objectName}/{record_id}/workflowOwners || List workflow owners || list ||
| align="center"|GET  || record/{objectName}/{record_id}/workflowOwners || List workflow owners || list ||
Line 263: Line 236:
|}
|}


<!-- =================================================== -->
==== Customization Resources ====
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Customization Resources''' <div align="center"> [[REST API:object Resource|object]]</div>
|}
 
<!-- object -->
<!-- object -->
<div align="center">[[REST API:object Resource|object]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
Line 286: Line 254:


<!-- field -->
<!-- field -->
<div align="center">[[REST API:field Resource|field]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:field Resource|field]]
|-
|-
| align="center"|GET  || field/{objectName} || List fields defined for an object. || read all ||
| align="center"|GET  || field/{objectName} || List fields defined for an object. || read all ||
|-
|-
| align="center"|GET  || field/{objectName}/{fieldName} || Get a field definition. ||  ||
| align="center"|GET  || field/{objectName}/{fieldName} || Get a field definition. ||  ||
<!--
|-
| align="center"|POST || uri || descr || add || fields
|-
| align="center"|PUT  || uri || descr || update || fields
|-
| align="center"|DELETE || uri || descr || delete ||
-->
|}
|}


<!-- index -->
<!-- index -->
<div align="center">[[REST API:index Resource|index]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:index Resource|index]]
|-
|-
| align="center"|GET  || index/{objectName} || List indexes defined for an object. || read all ||
| align="center"|GET  || index/{objectName} || List indexes defined for an object. || read all ||
Line 322: Line 280:


<!-- FUTURE: form  
<!-- FUTURE: form  
<div align="center">[[REST API:form Resource|form]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:form Resource|form]]
|-
|-
| align="center"|GET  || form/object/{objectName}/{record_id}[?mode=add/edit/view] || Retrieve the form displayed when a user is adding, editing, or viewing a record. ||  || Specify mode.
| align="center"|GET  || form/object/{objectName}/{record_id}[?mode=add/edit/view] || Retrieve the form displayed when a user is adding, editing, or viewing a record. ||  || Specify mode.
Line 332: Line 289:


<!-- package -->
<!-- package -->
<div align="center">[[REST API:package Resource|package]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:package Resource|package]]
|-
|-
| align="center"|POST || package/operation/download/{package_id}[?lastPublishedVersion=true] || Download a published package. If it hasn't been published yet, publish it first. || multipart response ||  
| align="center"|POST || package/operation/download/{package_id}[?lastPublishedVersion=true] || Download a published package. If it hasn't been published yet, publish it first. || multipart response ||  
Line 361: Line 317:


<!-- translationWorkbench -->
<!-- translationWorkbench -->
<div align="center">[[REST API:translationWorkbench Resource |translationWorkbench]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:translationWorkbench Resource |translationWorkbench]]
|-
|-
| align="center"|GET|| translationWorkBench/{type}/{category}.{token}[?args=param1,...] || Get a translated string from the [[Translation Workbench]], passing optional arguments for inclusion in the string. || ||
| align="center"|GET|| translationWorkBench/{type}/{category}.{token}[?args=param1,...] || Get a translated string from the [[Translation Workbench]], passing optional arguments for inclusion in the string. || ||
|}
|}


<!-- =================================================== -->
==== Development Resources ====
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Development Resources''' <div align="center">[[REST API:class Resource|class]]</div>
|}
 
<!-- class -->
<!-- class -->
<div align="center">[[REST API:class Resource|class]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
Line 392: Line 342:


<!-- exec -->
<!-- exec -->
<!-- TBD: Move this resource to the CLASS page. Yes??? -->
<!-- ToDO: Reference this resource in the CLASS page. Yes??? -->
<div align="center">[[REST API:exec Resource|exec]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:exec Resource|exec]]
|colspan="5" align="center" | <br/>
|-
|-
| align="center"|POST || class/operation/exec || Execute a class method. || execute || class, method, params
| align="center"|POST || class/operation/exec || Execute a class method. || execute || class, method, params
Line 402: Line 353:


<!-- customPage -->
<!-- customPage -->
<div align="center">[[REST API:customPage Resource|customPage]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:customPage Resource|customPage]]
|-
|-
| align="center"|GET  || customPage/{record_id} || Get a JSP page. ||  ||
| align="center"|GET  || customPage/{record_id} || Get a JSP page. ||  ||
Line 419: Line 369:


<!-- function -->
<!-- function -->
<div align="center">[[REST API:function Resource|function]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:function Resource|function]]
|-
|-
| align="center"|GET  || function || List available functions. || list ||
| align="center"|GET  || function || List available functions. || list ||
Line 438: Line 387:


<!-- metadata Repository-->
<!-- metadata Repository-->
<div align="center">[[REST API:repository Resource|repository]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:repository Resource|repository]]
|-
|-
| align="center"|GET  || repository || Read the settings for the ''metadata repository''--an external location in the file system (typically managed by a version control system) where object-defining metadata is stored, along with the metadata for other platform elements. || read settings ||  
| align="center"|GET  || repository || Read the settings for the ''metadata repository''--an external location in the file system (typically managed by a version control system) where object-defining metadata is stored, along with the metadata for other platform elements. || read settings ||  
Line 453: Line 401:


<!-- staticResource -->
<!-- staticResource -->
<div align="center">[[REST API:staticResource Resource|staticResource]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:staticResource Resource|staticResource]]
|-
|-
| align="center"|GET  || staticResource || List available static resources (files and images, for example).  || list ||
| align="center"|GET  || staticResource || List available static resources (files and images, for example).  || list ||
Line 470: Line 417:


<!-- utility -->
<!-- utility -->
<div align="center">[[REST API:utility Resource|utility]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:utility Resource|utility]]
|-
|-
| align="center"|GET  || utility/timeZone || List available time zone codes. || list ||
| align="center"|GET  || utility/timeZone || List available time zone codes. || list ||
Line 480: Line 426:
|}
|}


<!-- =================================================== -->
==== Service Provider Resources ====
<!-- license -->
<div align="center">[[REST API:license Resource|license]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Service Provider Resources''' <div align="center">[[REST API:license Resource|license]]</div>
|-
|-
| align="center"|GET  || license || Retrieve platform license. ||  ||
| align="center"|GET  || license || Retrieve platform license. ||  ||
Line 490: Line 436:


<!-- tenant -->
<!-- tenant -->
<div align="center">[[REST API:tenant Resource|tenant]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:tenant Resource|tenant]]
|-
|-
| align="center"|GET  || tenant/{tenant_id} || Get a tenant record. ||  ||
| align="center"|GET  || tenant/{tenant_id} || Get a tenant record. ||  ||
Line 507: Line 452:


<!-- tenantCapabilities -->
<!-- tenantCapabilities -->
<div align="center">[[REST API:tenantCapabilities Resource|tenantCapabilities]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:tenantCapabilities Resource|tenantCapabilities]]
|-
|-
| align="center"|GET  || tenantCapabilities/{tenant_id} || Get the record that defines the platform features a tenant can access. ||  ||
| align="center"|GET  || tenantCapabilities/{tenant_id} || Get the record that defines the platform features a tenant can access. ||  ||
Line 517: Line 461:
|}
|}


<!-- =================================================== -->
==== Community Resource ====
<!-- community -->
<div align="center">[[REST API:community Resource|community]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Community Resource''' <div align="center">[[REST API:community Resource|community]]</div>
|-
|-
| align="center"|POST || networking/community/user/operation/linkToCommunity ||  Join a community. || join || username<br/>password
| align="center"|POST || networking/community/user/operation/linkToCommunity ||  Join a community. || join || username<br/>password
Line 530: Line 474:
|}
|}


<!-- =================================================== -->
<!-- DEFERRED
<!-- DEFERRED
==== Application Resources ====
<!-- application ....>
<div align="center">[[REST API:application Resource|application]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Application Resources''' <div align="center">[[REST API:application Resource|application]]</div>
|-
|-
| align="center"|GET  || networking/application || Returns a list of applications, with a link for each. || list ||
| align="center"|GET  || networking/application || Returns a list of applications, with a link for each. || list ||
Line 547: Line 491:
-->
-->


<!-- =================================================== -->
==== Scheduled Jobs Resources ====
<!-- scheduledJob -->
<div align="center">[[REST API:scheduledJob Resource|scheduledJob]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5"|<br/>'''Scheduled Jobs Resources''' <div align="center">[[REST API:scheduledJob Resource|scheduledJob]]</div>
|-
|-
| align="center"|GET  || scheduledJob/{job_id} || Get details on a job. ||  ||
| align="center"|GET  || scheduledJob/{job_id} || Get details on a job. ||  ||
Line 562: Line 506:
|}
|}


<!-- =================================================== -->
==== Status Resources ====
<!-- import Status -->
<div align="center">[[REST API:import Status Resource|import Status]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5"|<br/>'''Status Resources''' <div align="center">[[REST API:import Status Resource|import Status]]</div>
|colspan="5"|<br/>'''''' <div align="center"></div>
|-
|-
| align="center"|GET  || status/import/{job_id} || Get status of an import job. (Imports run in the background, as scheduled jobs.) || Record counts, reason for rejections ||
| align="center"|GET  || status/import/{job_id} || Get status of an import job. (Imports run in the background, as scheduled jobs.) || Record counts, reason for rejections ||
Line 574: Line 520:


<!-- packageDeploy Status -->
<!-- packageDeploy Status -->
<div align="center">[[REST API:packageDeploy Status Resource|packageDeploy Status]]</div>
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
::{| border="1" cellpadding="5" cellspacing="1" width="100%"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|colspan="5" align="center" | <br/>[[REST API:packageDeploy Status Resource|packageDeploy Status]]
|-
|-
| align="center"|GET  || status/packageDeploy/{job_id} || Get status for a package deployment job. (Deployments run in the background, as scheduled jobs.) || Deployment counts, reasons for failures ||
| align="center"|GET  || status/packageDeploy/{job_id} || Get status for a package deployment job. (Deployments run in the background, as scheduled jobs.) || Deployment counts, reasons for failures ||

Revision as of 23:49, 15 February 2012

Resource URI: https://{domain}/networking/rest/{resource}

Session Resources

Method Resource Description Result Request/Params
POST login Start a session.
GET logout End a session.
GET user/isSessionValid See if a session is in progress.
GET user/info Get ID of logged-in user.
POST user/operation/changePassword Change password for the currently logged in user. old password
new password

Administration Resources

Method Resource Description Result Request/Params
GET auditLog/{record_id} Get details of an Audit Log record.
GET auditLog?{search_parameters} Search the Audit Log.
Method Resource Description Result Request/Params
GET companyInfo Retrieve company information.
PUT companyInfo Update company information. update fields
Method Resource Description Result Request/Params
GET passwordPolicy Retrieve record that specifies restrictions on passwords that users can choose.
PUT passwordPolicy Update password policy settings. update fields
Method Resource Description Result Request/Params
GET user/{user_id} Get a user record.
POST user Create a new user. new fields
PUT user/{user_id} Update a user record. update fields
POST user/updatePassword Reset a user's password. userID, password, reset, email
DELETE user/{user_id} Delete a user.
GET user?{search_parameters} Search for users.
Method Resource Description Result Request/Params
GET role/{role_id} Get a role definition.
POST role Create a new role. new fields
PUT role/{role_id} Update a role record. update fields
DELETE role/{role_id} Delete a role record.
GET role/{role_id}?{search_parameters} Search for roles.
Method Resource Description Result Request/Params
GET team/{team_id} Get a team record.
POST team Create a new team. new fields
PUT team/{team_id} Update team information. update fields
DELETE team/{team_id} Delete a team.
GET team?{search_parameters} Search for teams.
Method Resource Description Result Request/Params
GET userTeam/{record_id} Get a user/team junction record.
POST userTeam/ Create a new user/team junction record. new fields
PUT userTeam/{record_id} Update a user/team junction record. update fields
DELETE userTeam/{record_id} Delete a user/team junction record.
GET userTeam/{record_id}?{search_parameters} Search records in the user/team junction object.

Data Sharing Resources

Method Resource Description Result Request/Params
GET teamDataSharingPolicy List the records that tell how and with whom a team can share data. list
GET teamDataSharingPolicy/{policy_id} Get a record that defines sharing policies with a specific recipient.
POST teamDataSharingPolicy Create a new data sharing record. new fields
PUT teamDataSharingPolicy/{policy_id} Update a data sharing record. update fields
DELETE teamDataSharingPolicy/{policy_id} Delete a data sharing record.
Method Resource Description Result Request/Params
GET tenantDataSharingPolicy List policies for sharing data between tenants. read all
GET tenantDataSharingPolicy/{policy_id} Get a tenant data sharing record.
POST tenantDataSharingPolicy Create a new tenant data sharing record. new fields
PUT tenantDataSharingPolicy Update a tenant data sharing record. update fields
DELETE tenantDataSharingPolicy/{policy_id} Delete a tenant data sharing record.

Data Management Resources

Method Resource Description Result Request/Params
GET record/{objectName}/{record_id} Get a new object record.
POST record/{objectName}[?retrieve_record=true] Create a new object record. Optionally retrieve the updated record. new fields
(multipart supported)
PUT record/{objectName}/{record_id}[?retrieveRecord=true] Update an object record. Optionally retrieve the created record. update fields
(multipart supported)
DELETE record/{objectName}/{record_id} Delete an object record.
GET record/{objectName}?{search_parameters} Search for object records.
Method Resource Description Result Request/Params
GET record/{objectName}/{record_id} Retrieve an object record, along with records from related objects.
POST record/{objectName} Create a new object record, optionally adding or updating records in Related Objects, depending on cascade rules. new fields
(multipart supported)
PUT record/{objectName}/{record_id} Update an object record, optionally adding or updating records in related objects, depending on cascade rules. update fields
(multipart supported)
DELETE record/{objectName}/{record_id} Delete an object record, optionally deleting records in related objects, depending on cascade rules.
GET record/{objectName}?{composite_search_params} Search for object records. Both the search criteria and information returned can be defined in terms of Related Objects, as well as the initial object.
Method Resource Description Result Request/Params
GET recordLocator/{record_id} Get the record that defines indexes for an object.
PUT recordLocator/{record_id} Update the record that defines indexes for an object. update fields
Method Resource Description Result Request/Params
POST bulk/{objectName} Upload multiple records to a System Object in a single transaction. system obj mapping+special
(multipart w/data file)
POST bulk/Custom Upload multiple records to a Custom Object in a single transaction. custom obj ID+mapping
(multipart w/data file)
Method Resource Description Result Request/Params
GET document/{documentId} Download a stored document. download
Method Resource Description Result Request/Params
GET execSQL?sql={query_string} Make a SQL query. Result set

Workflow Resources

Method Resource Description Result Request/Params
GET workflowAction/record/{objectName}/{record_id} Get a list of available state-transition actions for a record.
Method Resource Description Result Request/Params
GET record/{objectName}/{record_id}/workflowOwners List workflow owners list
POST record/{objectName}/{record_id}/operation/changeWorkflowState Execute a defined action to transition to a new record state. transition fields (workflowID, action, comment, owner)

Customization Resources

Method Resource Description Result Request/Params
GET object List objects. read all
GET object/{objectName} Get an object definition.
POST object Create a new object. new fields
PUT object/{objectName} Update an object definition. update fields
DELETE object/{objectName} Delete an object.
Method Resource Description Result Request/Params
GET field/{objectName} List fields defined for an object. read all
GET field/{objectName}/{fieldName} Get a field definition.
Method Resource Description Result Request/Params
GET index/{objectName} List indexes defined for an object. read all
GET index/{objectName}/{indexName} Get an index definition.
POST index/{objectName}/{indexName} Add an index add fields
PUT index/{objectName}/{indexName} Modify an index update fields
DELETE index/{objectName}/{indexName} Remove an index delete


Method Resource Description Result Request/Params
POST package/operation/download/{package_id}[?lastPublishedVersion=true] Download a published package. If it hasn't been published yet, publish it first. multipart response
POST package/subscribe?packageId={id}[&version={version#}] Subscribe to a package in the platform repository.
POST package/subscribe?fileName={zipfile_path} Subscribe to a package file. Do a multipart post.
Method Resource Description Result Request/Params
GET translationWorkBench/{type}/{category}.{token}[?args=param1,...] Get a translated string from the Translation Workbench, passing optional arguments for inclusion in the string.

Development Resources

Method Resource Description Result Request/Params
GET class/{record_id} Get the code that defines a class.
PUT class/{record_id} Replace the code that defines a class. update Code for the class.
POST class Create a new class. new Code for the class
DELETE class/{record_id} Delete a class.
GET class?{search_parameters} Search classes.
Method Resource Description Result Request/Params

POST class/operation/exec Execute a class method. execute class, method, params
Method Resource Description Result Request/Params
GET customPage/{record_id} Get a JSP page.
POST customPage Create a JSP page. new fields
PUT customPage/{record_Id} Update a JSP page. update fields
DELETE customPage/{record_id} Delete a JSP page.
GET customPage?{search_parameters} Search JSP pages.
Method Resource Description Result Request/Params
GET function List available functions. list
GET function/{record_id} Get the code that defines a function.
POST function Create a function. new function code
PUT function/{record_id} Update a function. update function code
DELETE function/{record_id} Delete a function.
GET function?{search_parameters} Search functions.
Method Resource Description Result Request/Params
GET repository Read the settings for the metadata repository--an external location in the file system (typically managed by a version control system) where object-defining metadata is stored, along with the metadata for other platform elements. read settings
PUT repository Update settings for the metadata repository. update enable or disable, path to repository
POST rest/repository/operation/readFrom Update platform with the latest metadata stored in the repository. read
POST rest/repository/operation/writeTo Write changes from your platform to the shared metadata repository. write
Method Resource Description Result Request/Params
GET staticResource List available static resources (files and images, for example). list
GET staticResource/{resource_id}[?getfile=true] Get a static resource.
POST staticResource Create a new static resource. new fields
PUT staticResource/{resource_id} Update a static resource. update fields
DELETE staticResource/{resource_id} Delete a static resource.
Method Resource Description Result Request/Params
GET utility/timeZone List available time zone codes. list
GET utility/timeZone/{zone_id} Get a time zone code.

Service Provider Resources

Method Resource Description Result Request/Params
GET license Retrieve platform license.
Method Resource Description Result Request/Params
GET tenant/{tenant_id} Get a tenant record.
POST tenant Create a new tenant. new fields
PUT tenant/{tenant_id} Update a tenant record. update fields
DELETE tenant/{tenant_id} Delete a tenant.
GET tenant?{search_parameters} Search tenants.
Method Resource Description Result Request/Params
GET tenantCapabilities/{tenant_id} Get the record that defines the platform features a tenant can access.
PUT tenantCapabilities/{tenant_id} Update tenant capabilities. update fields

Community Resource

Method Resource Description Result Request/Params
POST networking/community/user/operation/linkToCommunity Join a community. join username
password
GET networking/community/login/site?userName=...&password=... Login to a community. login
POST networking/community/user/operation/changePassword Change password of currently logged in user. old password
new password


Scheduled Jobs Resources

Method Resource Description Result Request/Params
GET scheduledJob/{job_id} Get details on a job.
DELETE scheduledJob/{job_id} Delete a job.
GET scheduledJob?{search_parameters} Search job history. Ex: ?fieldList=jobId,jobName&filter="jobName contains 'Update'"

Notepad.png

Note: Jobs can be scheduled from the GUI, or by using the class exec REST API to run a method that uses the Java APIs to Schedule a Job.

Status Resources

Method Resource Description Result Request/Params

'
GET status/import/{job_id} Get status of an import job. (Imports run in the background, as scheduled jobs.) Record counts, reason for rejections
GET status/import?{search_parameters} Search import jobs. Ex: ?fileName,status&
filter=objectName contains 'contact'
list
Method Resource Description Result Request/Params
GET status/packageDeploy/{job_id} Get status for a package deployment job. (Deployments run in the background, as scheduled jobs.) Deployment counts, reasons for failures
GET status/packageDeploy?{search_parameters} Search package deployments. Ex: ?fieldList=packageName,status list