OData service: Difference between revisions

Jump to navigation Jump to search
(Created page with "{{Integration TOC}} Resco [https://www.odata.org/ OData v4] service is a web API that can be used to exchange data between Resco Cloud and other servers. Resco offers many...")
 
Line 19: Line 19:
* <code>https://[organization].[baseURI]/odata/v4/</code>
* <code>https://[organization].[baseURI]/odata/v4/</code>


==== Examples ====
==== URI examples ====


* Resco Cloud:      <code><nowiki>https://my_org.rescocrm.com/odata/v4/        </nowiki></code>
* Resco Cloud:      <code><nowiki>https://my_org.rescocrm.com/odata/v4/        </nowiki></code>
* Resco Cloud US:    <code><nowiki>https://my_org.us1.rescocrm.com/odata/v4/    </nowiki></code>
* Resco Cloud US:    <code><nowiki>https://my_org.us1.rescocrm.com/odata/v4/    </nowiki></code>
* Resco Inspections: <code><nowiki>https://inspections.resco.net/odata/v4/my_org/</nowiki></code>
* Resco Inspections: <code><nowiki>https://inspections.resco.net/odata/v4/my_org/</nowiki></code>
=== Example ===
Request: <nowiki>https://inspections.resco.net/odata/questionnaires/v4/[organization]/ </nowiki>
<small>(If you're trying this from a web browser, append <code>/?$format=json</code> to display the answer in the correct format.)</small>
Response (shortened):
<syntaxhighlight lang="json">{
  "@odata.context": "https://inspections.resco.net/odata/v4/spectra/$metadata",
  "value": [
    {
      "kind": "EntitySet",
      "title": "Account",
      "name": "account",
      "url": "account"
    },
    {
      "kind": "EntitySet",
      "title": "E-Mail Attachment",
      "name": "activitymimeattachment",
      "url": "activitymimeattachment"
    },
    {
      "kind": "EntitySet",
      "title": "Activity Party",
      "name": "activityparty",
      "url": "activityparty"
    },
...
</syntaxhighlight>


== Metadata document ==
== Metadata document ==

Navigation menu