Editing form submissions through API

Hello CommCare community,

If we have a plan that enables API access, are we permitted to update
(POST/PUT/PATCH) submission data through the forms API? The objective would
be to update data that is currently retrieved from the Forms API:

https://www.commcarehq.org/a/[domain]/api/[version]/form/

One of our projects has a use case that would make this an attractive
feature, and I might write a little JS app that authenticates with
CommCare, pulls the data, and allows editing of certain fields.

Thanks,
Joe

Hi Joe

Forms in CommCare HQ are essential read only and can’t be edited by the API
or any other method. This is intentional since they form the basis of
’transactions’ on case data. Cases on the other hand can easily be edited
by submitting updates to the submission API
https://confluence.dimagi.com/display/commcarepublic/Submission+API.

Simon

··· On 14 October 2014 22:58, Joe Contini wrote:

Hello CommCare community,

If we have a plan that enables API access, are we permitted to update
(POST/PUT/PATCH) submission data through the forms API? The objective would
be to update data that is currently retrieved from the Forms API:

https://www.commcarehq.org/a/[domain]/api/[version]/form/

One of our projects has a use case that would make this an attractive
feature, and I might write a little JS app that authenticates with
CommCare, pulls the data, and allows editing of certain fields.

Thanks,
Joe


You received this message because you are subscribed to the Google Groups
"CommCare Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to commcare-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Simon Kelly
Senior Engineer | Dimagi South Africa

Hey Joe, a few of our clients edit CommCare form submission data with
OpenFn.org. They’ve got CommCare forwarding submissions to OpenFn—which
then manipulates those submissions via a “job” and loads them into
Salesforce, DHIS2, or some other system. Standard manipulations can be done
with that “job”, but we’ve also got an interface for editing individual
submissions by hand in the event of a validation error, or some other
reason. It stores the original submission for audit purposes and allows
users to edit the data in either a webform style editor, or by working with
the raw JSON.

Hope this helps!

Taylor

··· On Tuesday, 14 October 2014 22:58:21 UTC+2, Joe Contini wrote: > > Hello CommCare community, > > If we have a plan that enables API access, are we permitted to update > (POST/PUT/PATCH) submission data through the forms API? The objective would > be to update data that is currently retrieved from the Forms API: > > https://www.commcarehq.org/a/[domain]/api/[version]/form/ > > One of our projects has a use case that would make this an attractive > feature, and I might write a little JS app that authenticates with > CommCare, pulls the data, and allows editing of certain fields. > > Thanks, > Joe >

Hey,

Just to expand on what Simon said a tiny bit - what he said is 100% true
today. However we have definitely heard that form editing is a highly
desired use case for some projects and is something we are considering
rolling into the product more formally. That said, if and when we do it
will likely continue to be XML-based and use the submission API (and not
the underlying form objects in the APIs).

Cory

··· On Wed, Oct 15, 2014 at 4:11 AM, Simon Kelly wrote:

Hi Joe

Forms in CommCare HQ are essential read only and can’t be edited by the
API or any other method. This is intentional since they form the basis of
’transactions’ on case data. Cases on the other hand can easily be edited
by submitting updates to the submission API
https://confluence.dimagi.com/display/commcarepublic/Submission+API.

Simon

On 14 October 2014 22:58, Joe Contini efisio@gmail.com wrote:

Hello CommCare community,

If we have a plan that enables API access, are we permitted to update
(POST/PUT/PATCH) submission data through the forms API? The objective would
be to update data that is currently retrieved from the Forms API:

https://www.commcarehq.org/a/[domain]/api/[version]/form/

One of our projects has a use case that would make this an attractive
feature, and I might write a little JS app that authenticates with
CommCare, pulls the data, and allows editing of certain fields.

Thanks,
Joe


You received this message because you are subscribed to the Google Groups
"CommCare Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to commcare-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Simon Kelly
Senior Engineer | Dimagi South Africa


You received this message because you are subscribed to the Google Groups
"CommCare Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to commcare-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Hi All

At this point, is there any way to edit submitted forms ? Is it possible to
return the form back to the mobile worker in case it needs correction?

Is it also possible to remove or archive forms through the API?

Hikesh

··· On Wednesday, October 15, 2014 at 2:53:25 PM UTC+2, Cory Zue wrote: > > Hey, > > Just to expand on what Simon said a tiny bit - what he said is 100% true > today. However we have definitely heard that form editing is a highly > desired use case for some projects and is something we are considering > rolling into the product more formally. That said, if and when we do it > will likely continue to be XML-based and use the submission API (and not > the underlying form objects in the APIs). > > Cory > > On Wed, Oct 15, 2014 at 4:11 AM, Simon Kelly <ske...@dimagi.com > wrote: > >> Hi Joe >> >> Forms in CommCare HQ are essential read only and can't be edited by the >> API or any other method. This is intentional since they form the basis of >> 'transactions' on case data. Cases on the other hand can easily be edited >> by submitting updates to the submission API >> . >> >> Simon >> >> On 14 October 2014 22:58, Joe Contini <efi...@gmail.com > wrote: >> >>> Hello CommCare community, >>> >>> If we have a plan that enables API access, are we permitted to update >>> (POST/PUT/PATCH) submission data through the forms API? The objective would >>> be to update data that is currently retrieved from the Forms API: >>> >>> https://www.commcarehq.org/a/[domain]/api/[version]/form/ >>> >>> One of our projects has a use case that would make this an attractive >>> feature, and I might write a little JS app that authenticates with >>> CommCare, pulls the data, and allows editing of certain fields. >>> >>> Thanks, >>> Joe >>> >>> -- >>> >>> --- >>> You received this message because you are subscribed to the Google >>> Groups "CommCare Developers" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to commcare-developers+unsubscribe@googlegroups.com >>> . >>> For more options, visit https://groups.google.com/d/optout. >>> >> >> >> >> -- >> Simon Kelly >> Senior Engineer | Dimagi South Africa >> >> -- >> >> --- >> You received this message because you are subscribed to the Google Groups >> "CommCare Developers" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to commcare-developers+unsubscribe@googlegroups.com . >> For more options, visit https://groups.google.com/d/optout. >> > >

Gah!! Didn't see the date on your post :slight_smile:

Hope you managed something in the mean time!

··· On Thu, Apr 28, 2016 at 2:35 PM Joe Contini wrote:

Thanks for the added follow-up 19 mo later! Will check out openFn, always
looking for quick & easy ETL tools.

On Thu, Apr 28, 2016, 19:19 Taylor Downs downs.taylor@gmail.com wrote:

Hey Joe, a few of our clients edit CommCare form submission data with
OpenFn.org. They've got CommCare forwarding submissions to OpenFn—which
then manipulates those submissions via a "job" and loads them into
Salesforce, DHIS2, or some other system. Standard manipulations can be done
with that "job", but we've also got an interface for editing individual
submissions by hand in the event of a validation error, or some other
reason. It stores the original submission for audit purposes and allows
users to edit the data in either a webform style editor, or by working with
the raw JSON.

Hope this helps!

Taylor

On Tuesday, 14 October 2014 22:58:21 UTC+2, Joe Contini wrote:

Hello CommCare community,

If we have a plan that enables API access, are we permitted to update
(POST/PUT/PATCH) submission data through the forms API? The objective would
be to update data that is currently retrieved from the Forms API:

https://www.commcarehq.org/a/[domain]/api/[version]/form/

One of our projects has a use case that would make this an attractive
feature, and I might write a little JS app that authenticates with
CommCare, pulls the data, and allows editing of certain fields.

Thanks,
Joe

Hey,

You can edit forms on the web using the “edit submissions” feature
https://confluence.dimagi.com/display/commcarepublic/Edit+Form+Submissions.
You can also use the submission API to submit a new form XML with the same
form ID and this will be the equivalent of editing the form.

Returning the form to the mobile device or removing/archiving through API
are not currently possible.

··· On Wed, Jan 13, 2016 at 9:24 AM, Hikesh Hasmukh wrote:

Hi All

At this point, is there any way to edit submitted forms ? Is it possible
to return the form back to the mobile worker in case it needs correction?

Is it also possible to remove or archive forms through the API?

Hikesh

On Wednesday, October 15, 2014 at 2:53:25 PM UTC+2, Cory Zue wrote:

Hey,

Just to expand on what Simon said a tiny bit - what he said is 100% true
today. However we have definitely heard that form editing is a highly
desired use case for some projects and is something we are considering
rolling into the product more formally. That said, if and when we do it
will likely continue to be XML-based and use the submission API (and not
the underlying form objects in the APIs).

Cory

On Wed, Oct 15, 2014 at 4:11 AM, Simon Kelly ske...@dimagi.com wrote:

Hi Joe

Forms in CommCare HQ are essential read only and can’t be edited by the
API or any other method. This is intentional since they form the basis of
’transactions’ on case data. Cases on the other hand can easily be edited
by submitting updates to the submission API
https://confluence.dimagi.com/display/commcarepublic/Submission+API.

Simon

On 14 October 2014 22:58, Joe Contini efi...@gmail.com wrote:

Hello CommCare community,

If we have a plan that enables API access, are we permitted to update
(POST/PUT/PATCH) submission data through the forms API? The objective would
be to update data that is currently retrieved from the Forms API:

https://www.commcarehq.org/a/[domain]/api/[version]/form/

One of our projects has a use case that would make this an attractive
feature, and I might write a little JS app that authenticates with
CommCare, pulls the data, and allows editing of certain fields.

Thanks,
Joe


You received this message because you are subscribed to the Google
Groups “CommCare Developers” group.
To unsubscribe from this group and stop receiving emails from it, send
an email to commcare-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Simon Kelly
Senior Engineer | Dimagi South Africa


You received this message because you are subscribed to the Google
Groups “CommCare Developers” group.
To unsubscribe from this group and stop receiving emails from it, send
an email to commcare-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


You received this message because you are subscribed to the Google Groups
"CommCare Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to commcare-developers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.