Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Response: JSON output with following Parameters (note: These are likely to change soon . Note that a success code indicates that the upload was processed, but it may have encountered business-level problems with the import's data, such as uploading a case to an invalid location. Also note that these parameters may change to support for better error handling, so do not plan around them).

NameDescriptionExample
code

200: Success

402: Warning

500: Fail

500

message

Warning or Failure message"Error processing your file. Submit a valid (.xlsx) file"
status_urlIf an upload is successful, a URL to poll for the status of the processing.

State: 2 - Complete, 3 - Error
(Example of JSON result from hitting status url):
{
   "state": 2,
   "progress": {"percent": 0},
   "result": {
      "match_count": 0,
      "created_count": 15,
      "num_chunks": 0,
      "errors": []
   }
}
(Example of JSON result where upload succeeded but encountered business errors):
{
   "state":2,
   "progress": {"percent":0},
   "result": {
      "match_count":0,
      "created_count":0,
      "num_chunks":0,
      "errors": [{
         "title":"Invalid Owner Name",
         "description":"Owner name was used in the mapping but there were errors when uploading because of these values.",
         "column":"owner_name",
         "rows": [2,3,4]
      }]
   }
}