Body Parameters

The request body requires following JSON structure.

{
  "lookupFields": {
    "ProtocolNumber": "protocol_number",
    "LOOKUP_PROPERTY": "LOOKUP_VALUE",
  },
  "properties": {
    "property_name": "property_value",
    "property_name": "property_value"
  }
}

The description for the above syntax is as follows.

Table 1. Syntax Description
Name Description Type Required
lookupFields

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

NOTE: ‘ProtocolNumber’ is the only supported lookup property for the study.

 Dictionary of string [key] and string [value] Required
protocol_number Study protocol number. String Required
LOOKUP_PROPERTY Property used to locate the facility to update String Required
LOOKUP_VALUE Property value used to locate the facility to update String Required
properties Key/value pair of property name and values to set on the item. Dictionary of string [key] and string [value] 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