answers

patch/v1/answers

Request

  • Base URL: https://api.aclaimant.com/api
  • URL: https://api.aclaimant.com/api/v1/answers
  • Auth: API key in header x-aclaimant-api-key

Request body

workflow-idstring uuid required
hashstring
allow-dangerous-operations?boolean

When true, bypasses the safety guards that reject requests which would delete a majority of an answer-bundle's existing answers, or save mostly malformed (wrong type/shape) answer values. Use with caution.

input-map-idstring uuid required
workflowstring required

string that is not empty or whitespace only

answersobject required
search-resultsobject required

search result ident to look up values by

company-identstring required
statestring required

one of the valid states for an answer bundle (e.g. "draft", "submitted", etc)

external-identstring required

The external-ident of the answer bundle

input-mapstring required

string that is not empty or whitespace only

Example request

{
  "search-results": {
    "search-name": "ident-of-a-search-result"
  },
  "company-ident": "COMPANY_IDENT",
  "state": "submitted",
  "external-ident": "YOUR_IDENT"
}

Response

Default response

Changes

No recorded changes to this operation across all 1 revision of this API.