Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REST GET .../submissions should return instanceName or update API docs #590

Closed
sadiqkhoja opened this issue Aug 30, 2022 · 1 comment · Fixed by #783
Closed

REST GET .../submissions should return instanceName or update API docs #590

sadiqkhoja opened this issue Aug 30, 2022 · 1 comment · Fixed by #783
Assignees
Labels
enhancement New feature or behavior

Comments

@sadiqkhoja
Copy link
Contributor

sadiqkhoja commented Aug 30, 2022

Currently REST endpoint GET forms/id/submissions doesn't return instanceName, we need to fix that or update API docs where we say that instanceName is only supported for ODATA endpoints

curl 'https://test.getodk.cloud/v1/projects/390/forms/Simple/Submissions' -H  ...

Response:
[
    {
        "instanceId": "uuid:08349870-0941-4a7c-8843-11fdd9a70908",
        "submitterId": 17150,
        "deviceId": null,
        "createdAt": "2022-08-30T15:34:22.162Z",
        "updatedAt": null,
        "reviewState": null
    }
]

REF: https://forum.getodk.org/t/odk-central-api-not-returning-instancename-of-submission/38729/6

@matthew-white
Copy link
Member

instanceName is also available using the REST API endpoints for a submission's versions or for a particular submission version. I think this relates to #481: the API distinguishes between submissions and submission versions (the two return different data), but the API docs don't always reflect that.

@matthew-white matthew-white added needs discussion Discussion needed before work can begin and removed good first issue labels Sep 15, 2022
@matthew-white matthew-white added this to the v2023.1 milestone Nov 16, 2022
@matthew-white matthew-white moved this to 🕒 backlog in ODK Central Dec 20, 2022
@matthew-white matthew-white removed this from the v2023.1 milestone Jan 24, 2023
@matthew-white matthew-white moved this from 🕒 backlog to ✏️ in progress in ODK Central Feb 27, 2023
@matthew-white matthew-white linked a pull request Feb 27, 2023 that will close this issue
2 tasks
@matthew-white matthew-white added enhancement New feature or behavior and removed needs discussion Discussion needed before work can begin bug labels Feb 27, 2023
@github-project-automation github-project-automation bot moved this from ✏️ in progress to ✅ done in ODK Central Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or behavior
Projects
Status: ✅ done
Development

Successfully merging a pull request may close this issue.

2 participants