Jump to

• Request
• Response

v2.0

post

/ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs

Compared with v1, this version creates study-lab data with structured addresses and properties payload sections.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).

  Example:

  test

• studyId(required): string(uuid)
  Study identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : LabCreateUpdateRequest v2.0

Type: object

Title: LabCreateUpdateRequest v2.0

Request payload containing lab details, addresses, and properties.

Show Source

• lab: object Lab
  Title: Lab

  Lab details being created or updated.
• labAddresses: array Lab Addresses
  Title: Lab Addresses

  Address associations for the lab.
• labProperties: array Lab Properties
  Title: Lab Properties

  Properties associated with the lab.

{
    "title":"LabCreateUpdateRequest v2.0",
    "type":"object",
    "properties":{
        "lab":{
            "$ref":"#/components/schemas/lab"
        },
        "labAddresses":{
            "title":"Lab Addresses",
            "type":"array",
            "description":"Address associations for the lab.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDto"
            }
        },
        "labProperties":{
            "title":"Lab Properties",
            "type":"array",
            "description":"Properties associated with the lab.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        }
    },
    "description":"Request payload containing lab details, addresses, and properties."
}

Nested Schema : Lab

Type: object

Title: Lab

Lab details being created or updated.

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• labIdName(required): string
  Example: Central Lab
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• studyLabId: string (uuid)
• studySiteId(required): string (uuid)
• vendorId(required): string (uuid)
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "title":"Lab",
    "required":[
        "labIdName",
        "studySiteId",
        "vendorId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "studyLabId":{
            "type":"string",
            "format":"uuid"
        },
        "vendorId":{
            "type":"string",
            "format":"uuid"
        },
        "studySiteId":{
            "type":"string",
            "format":"uuid"
        },
        "labIdName":{
            "type":"string",
            "example":"Central Lab"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        }
    },
    "description":"Lab details being created or updated.",
    "example":{
        "studyLabId":"B1B8327AFAA6412287106192AB5984EF",
        "vendorId":"B1B8327AFAA6412287106192AB5984EF",
        "studySiteId":"B1B8327AFAA6412287106192AB5984EF",
        "labIdName":"Central Lab",
        "versionStart":"2026-01-15T10:30:00Z"
    }
}

Example:

{
    "studyLabId":"B1B8327AFAA6412287106192AB5984EF",
    "vendorId":"B1B8327AFAA6412287106192AB5984EF",
    "studySiteId":"B1B8327AFAA6412287106192AB5984EF",
    "labIdName":"Central Lab",
    "versionStart":"2026-01-15T10:30:00Z"
}

Nested Schema : Lab Addresses

Type: array

Title: Lab Addresses

Address associations for the lab.

Show Source

• Array of: object SDFAddressAssociationDto

{
    "title":"Lab Addresses",
    "type":"array",
    "description":"Address associations for the lab.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFAddressAssociationDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : Lab Properties

Type: array

Title: Lab Properties

Properties associated with the lab.

Show Source

• Array of: object SDFsPropertyDto

{
    "title":"Lab Properties",
    "type":"array",
    "description":"Properties associated with the lab.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFAddressAssociationDto

Type: object

Show Source

• addressTypeId: string (uuid)
• addressTypeIdCodeValue: string
  Minimum Length: 0

  Maximum Length: 50

  Example: C36A3197FDEE433FB5547EE83DE99E4B
• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• entityAddressAssociationId(required): string (uuid)
• id: string (uuid)
• mainPrimary: boolean
  Example: true
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfAddressProperties: array sdfAddressProperties
• sdfId: string (uuid)
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "required":[
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "example":"C36A3197FDEE433FB5547EE83DE99E4B"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfAddressProperties":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        },
        "mainPrimary":{
            "type":"boolean",
            "example":true
        }
    }
}

Nested Schema : sdfAddressProperties

Type: array

Show Source

• Array of: object SDFsPropertyDto

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFsPropertyDto

Type: object

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
  Unique identifier for this record.
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Name of the property.

  Example: timezone
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 2048

  Value of the property.

  Example: UTC
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfId: string (uuid)
  Identifier of the related SDF record.
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier for this record.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "description":"Identifier of the related SDF record.",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Name of the property.",
            "example":"timezone"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Value of the property.",
            "example":"UTC"
        }
    }
}

Examples

Select an example Request Example

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LabCreateUpdateResponse v2.0

Type: object

Title: LabCreateUpdateResponse v2.0

Response containing the lab, addresses, and properties after persistence.

Show Source

• lab: object Lab
  Title: Lab

  Lab details being created or updated.
• labAddresses: array Lab Addresses
  Title: Lab Addresses

  Address associations returned for the lab.
• labProperties: array Lab Properties
  Title: Lab Properties

  Properties returned for the lab.

{
    "title":"LabCreateUpdateResponse v2.0",
    "type":"object",
    "properties":{
        "lab":{
            "$ref":"#/components/schemas/lab"
        },
        "labAddresses":{
            "title":"Lab Addresses",
            "type":"array",
            "description":"Address associations returned for the lab.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDto"
            }
        },
        "labProperties":{
            "title":"Lab Properties",
            "type":"array",
            "description":"Properties returned for the lab.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        }
    },
    "description":"Response containing the lab, addresses, and properties after persistence."
}

Nested Schema : Lab

Type: object

Title: Lab

Lab details being created or updated.

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• labIdName(required): string
  Example: Central Lab
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• studyLabId: string (uuid)
• studySiteId(required): string (uuid)
• vendorId(required): string (uuid)
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "title":"Lab",
    "required":[
        "labIdName",
        "studySiteId",
        "vendorId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "studyLabId":{
            "type":"string",
            "format":"uuid"
        },
        "vendorId":{
            "type":"string",
            "format":"uuid"
        },
        "studySiteId":{
            "type":"string",
            "format":"uuid"
        },
        "labIdName":{
            "type":"string",
            "example":"Central Lab"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        }
    },
    "description":"Lab details being created or updated.",
    "example":{
        "studyLabId":"B1B8327AFAA6412287106192AB5984EF",
        "vendorId":"B1B8327AFAA6412287106192AB5984EF",
        "studySiteId":"B1B8327AFAA6412287106192AB5984EF",
        "labIdName":"Central Lab",
        "versionStart":"2026-01-15T10:30:00Z"
    }
}

Example:

{
    "studyLabId":"B1B8327AFAA6412287106192AB5984EF",
    "vendorId":"B1B8327AFAA6412287106192AB5984EF",
    "studySiteId":"B1B8327AFAA6412287106192AB5984EF",
    "labIdName":"Central Lab",
    "versionStart":"2026-01-15T10:30:00Z"
}

Nested Schema : Lab Addresses

Type: array

Title: Lab Addresses

Address associations returned for the lab.

Show Source

• Array of: object SDFAddressAssociationDto

{
    "title":"Lab Addresses",
    "type":"array",
    "description":"Address associations returned for the lab.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFAddressAssociationDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : Lab Properties

Type: array

Title: Lab Properties

Properties returned for the lab.

Show Source

• Array of: object SDFsPropertyDto

{
    "title":"Lab Properties",
    "type":"array",
    "description":"Properties returned for the lab.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFAddressAssociationDto

Type: object

Show Source

• addressTypeId: string (uuid)
• addressTypeIdCodeValue: string
  Minimum Length: 0

  Maximum Length: 50

  Example: C36A3197FDEE433FB5547EE83DE99E4B
• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• entityAddressAssociationId(required): string (uuid)
• id: string (uuid)
• mainPrimary: boolean
  Example: true
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfAddressProperties: array sdfAddressProperties
• sdfId: string (uuid)
• versionStart: string (date-time)
  Example: 2026-01-15T10:30:00Z

{
    "required":[
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time",
            "example":"2026-01-15T10:30:00Z"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "example":"C36A3197FDEE433FB5547EE83DE99E4B"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfAddressProperties":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/SDFsPropertyDto"
            }
        },
        "mainPrimary":{
            "type":"boolean",
            "example":true
        }
    }
}

Nested Schema : sdfAddressProperties

Type: array

Show Source

• Array of: object SDFsPropertyDto

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/SDFsPropertyDto"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : SDFsPropertyDto

Type: object

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
  Unique identifier for this record.
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Name of the property.

  Example: timezone
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 2048

  Value of the property.

  Example: UTC
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfId: string (uuid)
  Identifier of the related SDF record.
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier for this record.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "description":"Identifier of the related SDF record.",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Name of the property.",
            "example":"timezone"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Value of the property.",
            "example":"UTC"
        }
    }
}

Examples

Select an example Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Error Response

Back to Top