Resco CRM Connector: Difference between revisions

Jump to navigation Jump to search

Resco CRM Connector (view source)

Revision as of 18:07, 5 September 2022

23 bytes added ,  5 September 2022
no edit summary
No edit summary
Line 62: Line 62:


;Examples
;Examples
* Resco Cloud server uses the following domain organization selection: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data</nowiki></code>
* Resco Cloud server uses the following domain organization selection: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data</nowiki></code>
* Resco Inspections cloud server uses the following domain organization selection: <code><nowiki>https://inspections.resco.net/rest/v1/data/{organization}</nowiki></code>
* Resco Inspections cloud server uses the following domain organization selection: <code><nowiki>https://inspections.resco.net/rest/v1/data/{organization}</nowiki></code>
* Resco Routes cloud server uses the following domain organization selection: <code><nowiki>https://routes.resco.net/rest/v1/data/{organization}</nowiki></code>
* Resco Routes cloud server uses the following domain organization selection: <code><nowiki>https://routes.resco.net/rest/v1/data/{organization}</nowiki></code>
Line 117: Line 117:
No parameters.
No parameters.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/WhoAmI</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/WhoAmI</nowiki></code>


Response:
Response:
Line 135: Line 135:
No parameters.
No parameters.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/GetMaxRowVersion</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/GetMaxRowVersion</nowiki></code>


Response:
Response:
Line 205: Line 205:
|}
|}


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/account?$select=name,address1_city,emailaddress1&$filter=name%20LIKE%20’C%’&$orderby=address1_city&$skip=2&$top=5</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/account?$select=name,address1_city,emailaddress1&$filter=name%20LIKE%20’C%’&$orderby=address1_city&$skip=2&$top=5</nowiki></code>


Response:
Response:
Line 259: Line 259:
Fetch query. Return list of entities defined by fetch.
Fetch query. Return list of entities defined by fetch.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data</nowiki></code>


Request:
Request:
Line 320: Line 320:
Default PrimaryKey is “id”.
Default PrimaryKey is “id”.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/Create</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/Create</nowiki></code>


Request:
Request:
Line 342: Line 342:
Create multiple entities. The entity is defined same as for Create method.
Create multiple entities. The entity is defined same as for Create method.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/CreateMultiple</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/CreateMultiple</nowiki></code>


Request:
Request:
Line 370: Line 370:
{create} (optional) — Determine whether the entity should be created if it does not exist.
{create} (optional) — Determine whether the entity should be created if it does not exist.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/Update</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/Update</nowiki></code>


Optional URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/Update?$create=true</nowiki></code>
Optional URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/Update?$create=true</nowiki></code>




Line 393: Line 393:
{create} (optional) — Determine whether the entity should be created if it does not exist.
{create} (optional) — Determine whether the entity should be created if it does not exist.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/UpdateMultiple</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/UpdateMultiple</nowiki></code>


Optional URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/UpdateMultiple?$create=true</nowiki></code>
Optional URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/UpdateMultiple?$create=true</nowiki></code>


Request:
Request:
Line 418: Line 418:
Delete entity. Optional, the primary key can be specified by “PrimaryKey” attribute. Default PrimaryKey is “id”.
Delete entity. Optional, the primary key can be specified by “PrimaryKey” attribute. Default PrimaryKey is “id”.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/Delete</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/Delete</nowiki></code>


Request:
Request:
Line 437: Line 437:
Delete multiple entities. The entity is defined the same way as for Delete method.
Delete multiple entities. The entity is defined the same way as for Delete method.


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/DeleteMultiple</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/DeleteMultiple</nowiki></code>


Request:
Request:
Line 459: Line 459:
* Delete – Delete entity
* Delete – Delete entity


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/Execute</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/Execute</nowiki></code>


Request:
Request:
Line 491: Line 491:
* Delete – Delete entity
* Delete – Delete entity


Sample URL: <code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/ExecuteMultiple</nowiki></code>
Sample URL: <code><nowiki>https://{organization}.app.resco.net/rest/v1/data/ExecuteMultiple</nowiki></code>


Request:
Request:
Line 544: Line 544:
Sample URL:
Sample URL:


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/{organization}/Export</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/{organization}/Export</nowiki></code>


Example of a body request:
Example of a body request:
Line 570: Line 570:
Sample URL:
Sample URL:


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/{organization}/Import?mode={mode}&publish={publish}</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/{organization}/Import?mode={mode}&publish={publish}</nowiki></code>
   
   
Mode:
Mode:
Line 588: Line 588:
Sample URL:
Sample URL:


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/ExportProject?$id={id}</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/ExportProject?$id={id}</nowiki></code>


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/ExportProject?$name={name}</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/ExportProject?$name={name}</nowiki></code>


Response: Binary project data.
Response: Binary project data.
Line 600: Line 600:
Sample URL:
Sample URL:


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/ImportProject?$id={id}&$publish={publish}</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/ImportProject?$id={id}&$publish={publish}</nowiki></code>


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/ImportProject?$name={name}&$publish={publish}</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/ImportProject?$name={name}&$publish={publish}</nowiki></code>


BODY:
BODY:
Line 614: Line 614:
Sample URL:  
Sample URL:  


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/GenerateReport</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/GenerateReport</nowiki></code>


Examples of body requests:
Examples of body requests:
Line 685: Line 685:
Sample URL:  
Sample URL:  


<code><nowiki>https://{organization}.rescocrm.com/rest/v1/data/ExecuteWorkflow</nowiki></code>
<code><nowiki>https://{organization}.app.resco.net/rest/v1/data/ExecuteWorkflow</nowiki></code>


Request:
Request:
Retrieved from "https://docs.resco.net/wiki/Special:MobileDiff/7220"

Navigation menu