Purpose: view or modify data forwarding endpoints (See documentation for data integration and forwarding)

Base URL: https://www.commcarehq.org/a/[domain]/api/[version]/data-forwarding/

Single Item URL: https://www.commcarehq.org/a/[domain]/api/[version]/data-forwarding/[id]

Input parameters:

NameDescriptionExample
FormatReturn data format (optional)
Supported: xml (default), json
format=json


Supported Operations

The following API operations are supported. See the sample output below for details on the JSON format.

APIEndpointHTTP OperationGET/POST data
List forwarding rulesBase URLGETNone
Create new forwarding ruleBase URLPOSTJSON Formatted data
Update forwarding ruleSingle Item URLPUTJSON Formatted data
Delete forwarding rule(not yet supported)  

Sample usage:

https://www.commcarehq.org/a/demo/api/v0.4/data-forwarding/

Sample output:

Sample Output
{
   "meta":{
      "limit":20,
      "next":null,
      "offset":0,
      "previous":null,
      "total_count":3
   },
   "objects":[
      {
         "domain":"demo",
         "id":"ccbadc6655b2e7692dccbbd884c14418",
         "resource_uri":"/a/demo/api/v0.4/data-forwarding/ccbadc6655b2e7692dccbbd884c14418/",
         "type":"CaseRepeater",
         "url":"http://www.example.com/case-endpoint/",
         "version":"2.0"
      },
      {
         "domain":"demo",
         "id":"ccbadc6655b2e7692dccbbd884c148b3",
         "resource_uri":"/a/demo/api/v0.4/data-forwarding/ccbadc6655b2e7692dccbbd884c148b3/",
         "type":"FormRepeater",
         "url":"http://www.example.com/form-endpoint/",
         "version":null
      },
      {
         "domain":"demo",
         "id":"ccbadc6655b2e7692dccbbd884c13d60",
         "resource_uri":"/a/demo/api/v0.4/data-forwarding/ccbadc6655b2e7692dccbbd884c13d60/",
         "type":"ShortFormRepeater",
         "url":"http://www.example.com/short-form-endpoint/",
         "version":"2.0"
      },
      {
         "domain":"demo",
         "id":"ccbadc6655b2e7692dccbbd884c13d60",
         "resource_uri":"/a/demo/api/v0.4/data-forwarding/ccbadc6655b2e7692dccbbd884c13d60/",
         "type":"AppStructureRepeater",
         "url":"http://www.example.com/app-structure-endpoint/",
         "version":"2.0"
      }
   ]
}
  • No labels