Purpose: get all of the data associated with a fixture. (see https://github.com/dimagi/commcare-core/wiki/fixtures for the definition of fixture)
Authentication: For more information, please review https://dimagi.atlassian.net/wiki/x/LwXKfw.
Base URLs:
(for individual fixture items): https://www.commcarehq.org/a/[domain]/api/[version]/fixture/[fixture_item_id]/
(for a specific fixture table): https://www.commcarehq.org/a/[domain]/api/[version]/fixture/?fixture_type=[name of table]
(for a list of all fixture types): https://www.commcarehq.org/a/[domain]/api/[version]/fixture/
...
Name | Description | Example |
|---|---|---|
fixture_type | Returns the fixtures of a in a given domain whose data_type | fixture_type=city |
Output values:
Name | Description | Example |
|---|---|---|
id | Fixture UUID | 1J9NF7B4FTH73435PYJJSL5SJ |
fixture_type | Name of the fixture's data_type | city |
fields | Values for the custom fields in the fixture. | {"name": "Boston", "population": 617594, "state": "Massachusetts" |
Note: A call to the Fixture List API endpoint will return a JSON list of objects with these output values.
...