Draft Testing

Data Document

Changed on

Identical to the non-Draft version of this endpoint.

get/v1/projects/{projectId}/forms/{xmlFormId}/draft.svc/{table}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}/draft.svc/{table}
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form whose OData service you wish to access.

tablestring required

The name of the table to be returned. These names can be found in the output of the Service Document.

Query parameters

$skipnumber

If supplied, the first $skip rows will be omitted from the results.

$topnumber

If supplied, only up to $top rows will be returned in the results.

$countboolean

If set to true, an @odata.count property will be added to the result indicating the total number of rows, ignoring the above paging parameters.

$wktboolean

If set to true, geospatial data will be returned as Well-Known Text (WKT) strings rather than GeoJSON structures.

$filterstring

If provided, will filter responses to those matching the query. Only certain fields are available to reference. The operators lt, le, eq, neq, ge, gt, not, and, and or are supported, and the built-in functions now, year, month, day, hour, minute, second.

$expandstring

Repetitions, which should get expanded. Currently, only * is implemented, which expands all repetitions.

$selectstring

If provided, will return only the selected fields.

Response

OK

@odata.contextstring

Example response

{
  "@odata.context": "https://your.odk.server/v1/projects/7/forms/simple.svc/$metadata#Submissions",
  "value": [
    {
      "__id": "uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44",
      "age": 25,
      "meta": {
        "instanceID": "uuid:85cb9aff-005e-4edd-9739-dc9c1a829c44"
      },
      "name": "Bob"
    },
    {
      "__id": "uuid:297000fd-8eb2-4232-8863-d25f82521b87",
      "age": 30,
      "meta": {
        "instanceID": "uuid:297000fd-8eb2-4232-8863-d25f82521b87"
      },
      "name": "Alice"
    }
  ]
}

Changes