AgileApps Support Wiki Pre Release

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

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 25: Line 25:
|-
|-
| align="center"|GET  || auditLog?{[[REST_API:Dynamic_Search|search_parameters]]} || Search the [[Audit Log]]. ||  ||
| align="center"|GET  || auditLog?{[[REST_API:Dynamic_Search|search_parameters]]} || Search the [[Audit Log]]. ||  ||
|}


<!-- companyInfo -->
<!-- companyInfo -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:companyInfo Resource|companyInfo]]
|colspan="5" align="center" | <br/>[[REST API:companyInfo Resource|companyInfo]]
Line 33: Line 36:
|-
|-
| align="center"|PUT  || companyInfo || Update company information. || update || fields
| align="center"|PUT  || companyInfo || Update company information. || update || fields
|}


<!-- passwordPolicy -->
<!-- passwordPolicy -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:passwordPolicy Resource|passwordPolicy]]
|colspan="5" align="center" | <br/>[[REST API:passwordPolicy Resource|passwordPolicy]]
Line 41: Line 47:
|-
|-
| align="center"|PUT  || passwordPolicy || Update password policy settings. || update || fields
| align="center"|PUT  || passwordPolicy || Update password policy settings. || update || fields
|}


<!-- user -->
<!-- user -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:user Resource|user]]
|colspan="5" align="center" | <br/>[[REST API:user Resource|user]]
Line 57: Line 66:
|-
|-
| align="center"|GET  || user?{[[REST_API:Dynamic_Search|search_parameters]]} || Search for users. ||  ||
| align="center"|GET  || user?{[[REST_API:Dynamic_Search|search_parameters]]} || Search for users. ||  ||
|}


<!-- role -->
<!-- role -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:role Resource|role]]
|colspan="5" align="center" | <br/>[[REST API:role Resource|role]]
Line 71: Line 83:
|-
|-
| align="center"|GET  || role/{role_id}?{[[REST_API:Dynamic_Search|search_parameters]]} || Search for roles. ||  ||
| align="center"|GET  || role/{role_id}?{[[REST_API:Dynamic_Search|search_parameters]]} || Search for roles. ||  ||
|}


<!-- team -->
<!-- team -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:team Resource|team]]
|colspan="5" align="center" | <br/>[[REST API:team Resource|team]]
Line 85: Line 100:
|-
|-
| align="center"|GET ||  team?{[[REST_API:Dynamic_Search|search_parameters]]} || Search for teams. ||  ||
| align="center"|GET ||  team?{[[REST_API:Dynamic_Search|search_parameters]]} || Search for teams. ||  ||
|}


<!-- userTeam -->
<!-- userTeam -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:userTeam Resource|userTeam]]
|colspan="5" align="center" | <br/>[[REST API:userTeam Resource|userTeam]]
Line 99: Line 117:
|-
|-
| align="center"|GET  || userTeam/{record_id}?{[[REST_API:Dynamic_Search|search_parameters]]} || Search records in the user/team junction object. ||  ||
| align="center"|GET  || userTeam/{record_id}?{[[REST_API:Dynamic_Search|search_parameters]]} || Search records in the user/team junction object. ||  ||
 
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5" |<br/>'''Data Sharing Resources''' <div align="center">[[REST API:teamDataSharingPolicy Resource|teamDataSharingPolicy]]</div>
|}


<!-- teamDataSharingPolicy -->
<!-- teamDataSharingPolicy -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|-
| align="center"|GET  || teamDataSharingPolicy  || List the records that tell how and with whom a team can share data. || list ||
| align="center"|GET  || teamDataSharingPolicy  || List the records that tell how and with whom a team can share data. || list ||
Line 116: Line 139:
|-
|-
| align="center"|DELETE || teamDataSharingPolicy/{policy_id}  || Delete a data sharing record. ||  ||
| align="center"|DELETE || teamDataSharingPolicy/{policy_id}  || Delete a data sharing record. ||  ||
|}


<!-- tenantDataSharingPolicy -->
<!-- tenantDataSharingPolicy -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:tenantDataSharingPolicy Resource|tenantDataSharingPolicy]]
|colspan="5" align="center" | <br/>[[REST API:tenantDataSharingPolicy Resource|tenantDataSharingPolicy]]
Line 130: Line 156:
|-
|-
| align="center"|DELETE || tenantDataSharingPolicy/{policy_id} || Delete a tenant data sharing record. ||  ||
| align="center"|DELETE || tenantDataSharingPolicy/{policy_id} || Delete a tenant data sharing record. ||  ||
 
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5"|<br/>'''Data Management Resources''' <div align="center"> [[REST API:record Resource|record]]</div>
|}


<!-- record -->
<!-- record -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|-
| align="center"|GET  || record/{objectName}/{record_id} || Get a new object record. ||  ||
| align="center"|GET  || record/{objectName}/{record_id} || Get a new object record. ||  ||
Line 147: Line 178:
|-
|-
| align="center"|GET  || record/{objectName}?{[[REST_API:Dynamic_Search|search_parameters]]} ||  Search for object records. ||  ||
| align="center"|GET  || record/{objectName}?{[[REST_API:Dynamic_Search|search_parameters]]} ||  Search for object records. ||  ||
|}


<!-- composite -->
<!-- composite -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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]]
|colspan="5" align="center" | <br/>[[REST API:composite record Resource|composite record]]
Line 161: Line 195:
|-
|-
| align="center"|GET  || record/{objectName}?{[[REST_API:composite_Resource#Dynamic Search for composite Records|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. ||  ||
| align="center"|GET  || record/{objectName}?{[[REST_API:composite_Resource#Dynamic Search for composite Records|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. ||  ||
|}


<!-- recordLocator -->
<!-- recordLocator -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:recordLocator Resource|recordLocator]]
|colspan="5" align="center" | <br/>[[REST API:recordLocator Resource|recordLocator]]
Line 169: Line 206:
|-
|-
| align="center"|PUT  || recordLocator/{record_id} || Update the record that defines indexes for an object. || update || fields
| align="center"|PUT  || recordLocator/{record_id} || Update the record that defines indexes for an object. || update || fields
|}


<!-- bulk -->
<!-- bulk -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:bulk Resource|bulk]]
|colspan="5" align="center" | <br/>[[REST API:bulk Resource|bulk]]
Line 177: Line 217:
|-
|-
| align="center"|POST || bulk/Custom || Upload multiple records to a {{type|}} in a single transaction. || custom obj || ID+mapping<br/>(multipart w/data file)
| align="center"|POST || bulk/Custom || Upload multiple records to a {{type|}} in a single transaction. || custom obj || ID+mapping<br/>(multipart w/data file)
|}


<!-- document -->
<!-- document -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST_API:document_Resource|document]]
|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 ||
 
|}


<!-- execSQL -->
<!-- execSQL -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST_API:execSQL Resource|execSQL]]
|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 ||
 
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5"|<br/>'''Workflow Resources''' <div align="center">[[REST API:workflowAction Resource|workflowAction]]</div>
|}


<!-- workflowAction -->
<!-- workflowAction -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|-
| align="center"|GET || workflowAction/record/{objectName}/{record_id} || Get a list of available state-transition actions for a record. ||  ||
| align="center"|GET || workflowAction/record/{objectName}/{record_id} || Get a list of available state-transition actions for a record. ||  ||
|}


<!-- record -->
<!-- record -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:record Resource|record]]
|colspan="5" align="center" | <br/>[[REST API:record Resource|record]]
Line 207: Line 260:
|-
|-
| align="center"|POST || record/{objectName}/{record_id}/operation/changeWorkflowState || Execute a defined action to transition to a new record state. || transition || fields (workflowID, action, comment, owner)
| align="center"|POST || record/{objectName}/{record_id}/operation/changeWorkflowState || Execute a defined action to transition to a new record state. || transition || fields (workflowID, action, comment, owner)
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5"|<br/>'''Customization Resources''' <div align="center"> [[REST API:object Resource|object]]</div>
|}


<!-- object -->
<!-- object -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|-
| align="center"|GET  || object || List objects.  || read all ||
| align="center"|GET  || object || List objects.  || read all ||
Line 223: Line 282:
|-
|-
| align="center"|DELETE || object/{objectName} || Delete an object. ||  ||
| align="center"|DELETE || object/{objectName} || Delete an object. ||  ||
|}


<!-- field -->
<!-- field -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:field Resource|field]]
|colspan="5" align="center" | <br/>[[REST API:field Resource|field]]
Line 239: Line 301:
| align="center"|DELETE || uri || descr || delete ||
| align="center"|DELETE || uri || descr || delete ||
-->
-->
|}


<!-- index -->
<!-- index -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:index Resource|index]]
|colspan="5" align="center" | <br/>[[REST API:index Resource|index]]
Line 253: Line 318:
|-
|-
| align="center"|DELETE || index/{objectName}/{indexName} || Remove an index || delete ||
| align="center"|DELETE || index/{objectName}/{indexName} || Remove an index || delete ||
 
|}


<!-- FUTURE: form  
<!-- FUTURE: form  
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:form Resource|form]]
|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.
|}
-->
-->


<!-- package -->
<!-- package -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:package Resource|package]]
|colspan="5" align="center" | <br/>[[REST API:package Resource|package]]
Line 287: Line 357:
| align="center"|POST || package/deploy || Deploy a package to selected tenants. (The deployment is placed in the job queue for immediate execution.) || || List of tenant IDs to deploy to.
| align="center"|POST || package/deploy || Deploy a package to selected tenants. (The deployment is placed in the job queue for immediate execution.) || || List of tenant IDs to deploy to.
-->
-->
|}


<!-- translationWorkbench -->
<!-- translationWorkbench -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:translationWorkbench Resource |translationWorkbench]]
|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. || ||
 
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5"|<br/>'''Development Resources''' <div align="center">[[REST API:class Resource|class]]</div>
|}


<!-- class -->
<!-- class -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-
|-
| align="center"|GET  || class/{record_id} || Get the code that defines a class. ||  ||
| align="center"|GET  || class/{record_id} || Get the code that defines a class. ||  ||
Line 310: Line 388:
|-
|-
| align="center"|GET  || class?{[[REST_API:Dynamic_Search|search_parameters]]} || Search classes. ||  ||
| align="center"|GET  || class?{[[REST_API:Dynamic_Search|search_parameters]]} || Search classes. ||  ||
|}


<!-- exec -->
<!-- exec -->
<!-- TBD: Move this resource to the CLASS page. Yes??? -->
<!-- TBD: Move this resource to the CLASS page. Yes??? -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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/>[[REST API:exec Resource|exec]]
|-
|-
| 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
|}


<!-- customPage -->
<!-- customPage -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:customPage Resource|customPage]]
|colspan="5" align="center" | <br/>[[REST API:customPage Resource|customPage]]
Line 331: Line 415:
|-
|-
| align="center"|GET  || customPage?{[[REST_API:Dynamic_Search|search_parameters]]} || Search JSP pages. ||  ||
| align="center"|GET  || customPage?{[[REST_API:Dynamic_Search|search_parameters]]} || Search JSP pages. ||  ||
|}


<!-- function -->
<!-- function -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:function Resource|function]]
|colspan="5" align="center" | <br/>[[REST API:function Resource|function]]
Line 347: Line 434:
|-
|-
| align="center"|GET  || function?{[[REST_API:Dynamic_Search|search_parameters]]} || Search functions. ||  ||
| align="center"|GET  || function?{[[REST_API:Dynamic_Search|search_parameters]]} || Search functions. ||  ||
|}


<!-- metadata Repository-->
<!-- metadata Repository-->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:repository Resource|repository]]
|colspan="5" align="center" | <br/>[[REST API:repository Resource|repository]]
Line 359: Line 449:
|-
|-
| align="center"|POST || rest/repository/operation/writeTo || Write changes from your platform to the shared metadata repository. || write ||  
| align="center"|POST || rest/repository/operation/writeTo || Write changes from your platform to the shared metadata repository. || write ||  
|}


<!-- staticResource -->
<!-- staticResource -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:staticResource Resource|staticResource]]
|colspan="5" align="center" | <br/>[[REST API:staticResource Resource|staticResource]]
Line 373: Line 466:
|-
|-
| align="center"|DELETE || staticResource/{resource_id} || Delete a static resource. ||  ||
| align="center"|DELETE || staticResource/{resource_id} || Delete a static resource. ||  ||
|}


<!-- utility -->
<!-- utility -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:utility Resource|utility]]
|colspan="5" align="center" | <br/>[[REST API:utility Resource|utility]]
Line 381: Line 477:
|-
|-
| align="center"|GET || utility/timeZone/{zone_id} || Get a time zone code. ||  ||
| align="center"|GET || utility/timeZone/{zone_id} || Get a time zone code. ||  ||
 
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|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. ||  ||
|}


<!-- tenant -->
<!-- tenant -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:tenant Resource|tenant]]
|colspan="5" align="center" | <br/>[[REST API:tenant Resource|tenant]]
Line 402: Line 503:
|-
|-
| align="center"|GET  || tenant?{[[REST_API:Dynamic_Search|search_parameters]]} || Search tenants. ||  ||
| align="center"|GET  || tenant?{[[REST_API:Dynamic_Search|search_parameters]]} || Search tenants. ||  ||
|}


<!-- tenantCapabilities -->
<!-- tenantCapabilities -->
::{| border="1" cellpadding="5" cellspacing="1"
! Method !! align="left"|Resource !! align="left"|Description !! align="left"|Result !! align="left"|Request/Params
|-  
|-  
|colspan="5" align="center" | <br/>[[REST API:tenantCapabilities Resource|tenantCapabilities]]
|colspan="5" align="center" | <br/>[[REST API:tenantCapabilities Resource|tenantCapabilities]]
Line 410: Line 514:
|-
|-
| align="center"|PUT  || tenantCapabilities/{tenant_id} || Update tenant capabilities. || update || fields
| align="center"|PUT  || tenantCapabilities/{tenant_id} || Update tenant capabilities. || update || fields
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5"|<br/>'''Community Resource''' <div align="center">[[REST API:community Resource|community]]</div>
Line 420: Line 527:
|-
|-
| align="center"|POST || networking/community/user/operation/changePassword || Change password of currently logged in user. || || old password<br/>new password
| align="center"|POST || networking/community/user/operation/changePassword || Change password of currently logged in user. || || old password<br/>new password
|}


<!-- =================================================== -->
<!-- =================================================== -->
<!-- DEFERRED
<!-- DEFERRED
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5"|<br/>'''Application Resources''' <div align="center">[[REST API:application Resource|application]]</div>
Line 433: Line 543:
|-
|-
| align="center"|GET  || record/view/{view_id} || Returns the information displayed in a widget. || fields ||
| align="center"|GET  || record/view/{view_id} || Returns the information displayed in a widget. || fields ||
|}
-->
-->


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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>
|colspan="5"|<br/>'''Scheduled Jobs Resources''' <div align="center">[[REST API:scheduledJob Resource|scheduledJob]]</div>
Line 446: Line 559:
|-  
|-  
|colspan="5"|{{Note|Jobs can be scheduled from the GUI, or by using the class [[REST API:exec Resource|exec]] REST API to run a method that uses the Java APIs to [[Java API:Schedule a Job|Schedule a Job]].}}
|colspan="5"|{{Note|Jobs can be scheduled from the GUI, or by using the class [[REST API:exec Resource|exec]] REST API to run a method that uses the Java APIs to [[Java API:Schedule a Job|Schedule a Job]].}}
 
|}


<!-- =================================================== -->
<!-- =================================================== -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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/>'''Status Resources''' <div align="center">[[REST API:import Status Resource|import Status]]</div>
Line 455: Line 570:
|-
|-
| align="center"|GET  || status/import?{[[REST_API:Dynamic_Search|search_parameters]]} || Search import jobs. '''Ex:''' ?fileName,status&<br/>filter=objectName contains 'contact' || list  ||
| align="center"|GET  || status/import?{[[REST_API:Dynamic_Search|search_parameters]]} || Search import jobs. '''Ex:''' ?fileName,status&<br/>filter=objectName contains 'contact' || list  ||
|}


<!-- packageDeploy Status -->
<!-- packageDeploy Status -->
::{| border="1" cellpadding="5" cellspacing="1"
! 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]]
|colspan="5" align="center" | <br/>[[REST API:packageDeploy Status Resource|packageDeploy Status]]
Line 463: Line 581:
|-
|-
| align="center"|GET  || status/packageDeploy?{[[REST_API:Dynamic_Search|search_parameters]]} || Search package deployments. '''Ex:''' ?fieldList=packageName,status || list ||
| align="center"|GET  || status/packageDeploy?{[[REST_API:Dynamic_Search|search_parameters]]} || Search package deployments. '''Ex:''' ?fieldList=packageName,status || list ||
|}
|}

Revision as of 23:07, 15 February 2012

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

Method Resource Description Result Request/Params

Session Resources
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
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

companyInfo
GET companyInfo Retrieve company information.
PUT companyInfo Update company information. update fields
Method Resource Description Result Request/Params

passwordPolicy
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

user
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

role
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

team
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

userTeam
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.
Method Resource Description Result Request/Params

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

tenantDataSharingPolicy
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.
Method Resource Description Result Request/Params

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

composite record
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

recordLocator
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

bulk
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

document
GET document/{documentId} Download a stored document. download
Method Resource Description Result Request/Params

execSQL
GET execSQL?sql={query_string} Make a SQL query. Result set
Method Resource Description Result Request/Params

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

record
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)
Method Resource Description Result Request/Params

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

field
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

index
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

package
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

translationWorkbench
GET translationWorkBench/{type}/{category}.{token}[?args=param1,...] Get a translated string from the Translation Workbench, passing optional arguments for inclusion in the string.
Method Resource Description Result Request/Params

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

exec
POST class/operation/exec Execute a class method. execute class, method, params
Method Resource Description Result Request/Params

customPage
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

function
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

repository
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

staticResource
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

utility
GET utility/timeZone List available time zone codes. list
GET utility/timeZone/{zone_id} Get a time zone code.
Method Resource Description Result Request/Params

Service Provider Resources
GET license Retrieve platform license.
Method Resource Description Result Request/Params

tenant
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

tenantCapabilities
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
Method Resource Description Result Request/Params

Community Resource
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


Method Resource Description Result Request/Params

Scheduled Jobs Resources
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.

Method Resource Description Result Request/Params

Status Resources
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

packageDeploy Status
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
Retrieved from "https://agileappscloud.info/aadev-src/index.php?title=REST_API:REST_API_CheatSheet&oldid=12661"