Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The doForms REST API provides integration with the doForms system.

...

ResponseNotes
[
{
"key": "rst123",
"id": "acme$$12345$$Published&&1"
},
{
"key": "rst124",
"id": "acme$$12345$$Published&&2"
}
]
Returns dispatch identifiers that match a query.
See /submissions? for more details.

DELETE /dispatches/{key or id}

...

ResponseNotes
[
{
"key": "fgh123",
"id": "acme$$12345$$Published",
"name": "First Form v1",
"displayName": "First Form",
"createTime": "2019-08-20T16:55:20.130Z",
"createUser": "me@me.com",
"updateTime": "2019-08-20T17:55:21.799Z",
"updateUser": "me@me.com",
"version": 1.01
},
{
"key": "fgh234",
"id": "acme$$23456$$Published",
"name": "Second Form",
"displayName": "Second Form",
"createTime": "2019-07-20T16:55:20.130Z",
"createUser": "me@me.com",
"updateTime": "2019-07-20T17:55:21.799Z",
"updateUser": "me@me.com",
"version": 1.0
}
]

Returns all forms assigned to the requested project.

  • See the /forms endpoint for more detail.
  • Set optional query parameter @abandoned=true to include forms that have data for the project but are not assigned to the project. Ignored if the authenticated user does not have rights to view to view abandoned data.

GET /reports

ResponseNotes
[
{
"key": "rst123",
"name": "Report 1"
},
{
"key": "rst124",
"name": "Report 2"
},
{
"key": "rst125",
"name": "Report 3"
}
]

Returns all published reports.

  • Requires report manager rights.

...