API for meta-data about apps and forms?

Users
1

Hi,

Is there an API to get information about which applications, modules, and
forms exist inside a domain?

Thanks,
Jon

2

Not an official one, we are using unsupported api to get this information.

··· On Thu, Mar 21, 2013 at 8:09 AM, Jonathan Payne wrote:

Hi,

Is there an API to get information about which applications, modules, and
forms exist inside a domain?

Thanks,
Jon

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

--
skype: birdsarah
email: sbird@alum.mit.edu
web: www.sarahbird.org | www.bonvaya.com

3

Hi All -

Sarah has implemented a work around to get the information, so you if need
it soon, you might be able to get that from her if she will share :).

In general, this is something we know we need as more integrations are
taking place. The Grameen MOTECH Suite team just sent us a proposed spec
that I'll send you off thread so you can see if you have any additions or
suggestions.

Cheers,
Jonathan

··· On Thu, Mar 21, 2013 at 11:17 AM, Sarah Bird wrote:

Not an official one, we are using unsupported api to get this information.

On Thu, Mar 21, 2013 at 8:09 AM, Jonathan Payne paynejd@gmail.com wrote:

Hi,

Is there an API to get information about which applications, modules, and
forms exist inside a domain?

Thanks,
Jon

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

--
skype: birdsarah
email: sbird@alum.mit.edu
web: www.sarahbird.org | www.bonvaya.com

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

4

Yes, please send info about the unsupported API. That would be helpful as a
starting point.

Thanks,
Jon

··· -- Jonathan Payne, MS 615.579.5413 skype: jonathandavidpayne

On Thu, Mar 21, 2013 at 11:36 AM, Jonathan Jackson jjackson@dimagi.comwrote:

Hi All -

Sarah has implemented a work around to get the information, so you if need
it soon, you might be able to get that from her if she will share :).

In general, this is something we know we need as more integrations are
taking place. The Grameen MOTECH Suite team just sent us a proposed spec
that I'll send you off thread so you can see if you have any additions or
suggestions.

Cheers,
Jonathan

On Thu, Mar 21, 2013 at 11:17 AM, Sarah Bird sbird@alum.mit.edu wrote:

Not an official one, we are using unsupported api to get this
information.

On Thu, Mar 21, 2013 at 8:09 AM, Jonathan Payne paynejd@gmail.comwrote:

Hi,

Is there an API to get information about which applications, modules,
and forms exist inside a domain?

Thanks,
Jon

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

--
skype: birdsarah
email: sbird@alum.mit.edu
web: www.sarahbird.org | www.bonvaya.com

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

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

5

Jon Payne, below is the meat of a long email thread between me Cory &
Danny. We also did a lot of reading the code. We'll try and get our code
open-sourced asap.

Jon Jackson, can you share the API suggestion with the community for
feedback, given that many of us are working with this problem?

Best,

Bird

Form's xmlns: "
http://openrosa.org/formdesigner/6997a1a00e3e9e36302ce20690b77e8ae6694101"
— note that this string is only meaningful as a whole, and that we never
use the UUID at the end of it alone, and it's not the same as the form's
"unique_id".
Form's unique_id: This is what you see in the ... in the suite.xml (or in XPath: //xform/resource/@id)
The resource_url for a form's xform content: e.g. "
https://www.commcarehq.org/a/droberts/apps/download/953532b027ebf77b0d903496f40cc8ea/modules-0/forms-0.xml"—the
download url prefix plus the relative path found in the suite.xml file at
XPath //xform/resource/location[authority="remote"].
Form's definition json: the JSON you can find at
https://www.commcarehq.org/a/$domain/apps/xform/$unique_id

In response to your questions—the uuid at the end of the xmlns is not
what I've been calling the unique_id. The complicated part of my previous
email was that I was outlining how to construct the association between the
xmlns and the unique_id by cross-referencing things you can find at a
number of URLs. Relatedly, the reason that you the definition json url
failed was that you were using the uuid in the xmlns rather than the *
unique_id*.

What you want: A mapping from xmlns to definition json.
How to get there currently, as described in my previous email:
(1) unique_id to *resource_url *(contained in suite)
(2) *resource_url *to xmlns (by looking up the resource url and looking
at the data node's xmlns).
(3) *unique_id to definition json
(4) If you combine (1) and (2) you can create a mapping from unique_id to
xmlns, which you can reverse to get a map from xmlns to unique_id.
(5) Combine this mapping form (4) with (3) and you'll have a mapping from *
xmlns to definition json, which is what you wanted to begin with.

··· On Sat, Mar 23, 2013 at 11:33 AM, Jonathan Payne wrote:

Yes, please send info about the unsupported API. That would be helpful as
a starting point.

Thanks,
Jon

--
Jonathan Payne, MS
615.579.5413
skype: jonathandavidpayne

On Thu, Mar 21, 2013 at 11:36 AM, Jonathan Jackson jjackson@dimagi.comwrote:

Hi All -

Sarah has implemented a work around to get the information, so you if
need it soon, you might be able to get that from her if she will share :).

In general, this is something we know we need as more integrations are
taking place. The Grameen MOTECH Suite team just sent us a proposed spec
that I'll send you off thread so you can see if you have any additions or
suggestions.

Cheers,
Jonathan

On Thu, Mar 21, 2013 at 11:17 AM, Sarah Bird sbird@alum.mit.edu wrote:

Not an official one, we are using unsupported api to get this
information.

On Thu, Mar 21, 2013 at 8:09 AM, Jonathan Payne paynejd@gmail.comwrote:

Hi,

Is there an API to get information about which applications, modules,
and forms exist inside a domain?

Thanks,
Jon

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

--
skype: birdsarah
email: sbird@alum.mit.edu
web: www.sarahbird.org | www.bonvaya.com

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

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

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

--
skype: birdsarah
email: sbird@alum.mit.edu
web: www.sarahbird.org | www.bonvaya.com