Skip to content
This repository was archived by the owner on Aug 13, 2020. It is now read-only.

Multipart File Upload Endpoint Generation

allanmckenzie edited this page Mar 15, 2017 · 19 revisions

As of version 1.5, the Framework now allows Multipart endpoints for file upload to be generated using RAML in a similar way to the other endpoint generation.

The Raml

/cases/{caseId}/casedocuments:
post:
  description: |
    Upload Case Documents
    ...
    (mapping):
      requestType: multipart/form-data
      name: staging.command.upload-case-documents
    ...
  body:

    multipart/form-data:
      formParameters:
        # This name is the name of the file part and, once the file is stored and 
        # we have an id for the file, will be used as the name of the field 
        # containing the file id in your JsonEnvelope
        caseId:  
          description: The id of the newly stored case document
          type: file
  responses:
    202:
      description: Request accepted
    400:
      description: Bad Request
    500:
      description: Internal Server Error

Clone this wiki locally