Body Parameters

The request body is a multipart HTTP request with one part being the document content to upload and the second part being the following JSON structure for document properties:
{
  "LookupFields": {
    "DocumentId": "DOCUMENT_GUID"
  },
  "properties": {
    "ProtocolNumber": "PROTOCOL_NUMBER",
    "property_name": "property_value"
  }
}
Tip: Either the properties or content can be specified, or both can be specified.
Name Description Type Required
lookupFields

Key/value pair of property name and values to locate the item.

NOTE: ‘DocumentId is the only supported lookup field.

Dictionary of string [key] and string [value] Required
DOCUMENT_GUID Document GUID as previously returned by the upload method String Required
properties Key/value pair of property name and values to set on the item. Dictionary of string [key] and string [value] Required
PROTOCOL_NUMBER

Study Protocol Number for the existing document.

NOTE: This cannot be changed on a document.

String Required
property_name Name of property to set on the item. String Required
property_value Value of property to set on the item. String Required