Purpose: Create or Edit lookup tables by uploading excel file containing Table data

URL: https://www.commcarehq.org/a/[domain]/fixtures/fixapi/

Method: POST

Authorization: Basic Authorization

Input Parameters:

NameDescriptionExample
file-to-uploadPath to the excel file containing Table Data/home/username/fixtures.xlsx
replaceTrue if the existing tables should be deleted, otherwise Falsefalse
asyncIf true, the upload will be queued and processed in the background. A status URL will be provided to view progressfalse

Sample cURL request:

curl -v https://www.commcarehq.org/a/myproject/fixtures/fixapi/ -u user@domain.com:password
     -F "file-to-upload=@fixtures.xlsx"
     -F "replace=true"

(You may also omit the ':' and password and curl will request it. This will have the benefit of not showing your password on your screen or storing it in your history.)

Response: JSON output with following Parameters.

NameDescriptionExample
code

200: Success

402: Warning

405: Fail

402
messageWarning or Failure message"Error processing your file. Submit a valid (.xlsx) file"
status_url

URL for the progress of the lookup table upload

Only applicable when async=true


https://www.commcarehq.org/a/demo/fixtures/fixapi/status/dl-2998e6834a654ab5ba74f372246caa75/
  • No labels