Sign in
OData Form Service

Service Document

The Service Document is essentially the index of all available documents. From this document, you will find links to all other available information in this OData service. In particular, you will find the Metadata Document, as well as a data document for each table defined by the Form.

You will always find a link to the /Submissions subpath, which is the data document that represents the "root" table, the data from each Submission that is not nested within any repeats.

This document is available only in JSON format.

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

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

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

Response

OK

@odata.contextstring

Example response

{
  "@odata.context": "https://your.odk.server/v1/projects/7/forms/sample.svc/$metadata",
  "value": [
    {
      "kind": "EntitySet",
      "name": "Submissions",
      "url": "Submissions"
    },
    {
      "kind": "EntitySet",
      "name": "Submissions.children.child",
      "url": "Submissions.children.child"
    }
  ]
}

Changes

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Service Document removed and replaced with serviceDocument

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id serviceDocument removed and replaced with Service Document

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog