Request Syntax

Learn which form field to use in ProcessMaker IDP REST API requests.

Form Fields in Request Bodies

All request bodies should be sent as a multipart/form-data content type. Depending on the kind of operation to perform, a request body can contain the following form fields:

• data

• file

data form field

Attributes can be added to an entity by specifying them as key-value pairs in a JSON string and adding them to your request in the form-data field data.

This JSON string has the following format:

{
  "attributes": {
    "name": "Welcome to IDP.docx",
    "createdBy": "User"
  }
}

file form field

When uploading files, the file(s) should be contained in a form-data field named file.