Skip to main content

Submit Work Request

Submit data for processing by the platform.

info

Available in Contextal Platform 1.0 and later.

Request

  • Path: /api/v1/submit
  • Verb: POST or PUT
  • Body: multipart/form-data
  • Body params:
    • ttl: number of seconds allowed to fully complete this work request
    • maxrec: maximum recursion level a work can reach
    • object_data: the raw data of the object
    • org: string identifying the organization (can be fully customized)
    • relation_metadata: JSON object (metadata for the entry object)
note
  1. The maximum body size MAX_SUBMIT_SIZE (compile time constant - currently = 200 MB) must not be exceeded
  2. The ttl param will be silently capped to MAX_WORK_TTL (compile time constant - currently = 1 day)
  3. The maxrec param will be silently capped to the range 1 -> MAX_WORK_DEPTH (compile time constant - currently = 24)

Reply

On success:

  • Status: 201 - Created
  • Content-Type: application/json
  • Body: A JSON object in the form of:
    {
    "object_id": "String", # the id of the submitted object
    "work_id": "String", # the work id
    "ttl": Number, # the actual TTL applied to the work
    }

On failure:

  • Status: 4xx or 5xx