Jump to

• Request
• Response

v2.0

delete

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

Compared with v1, this version removes lab-to-study-site associations by explicit siteId and labId inputs.

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

Query Parameters

• labId(required): string(uuid)
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  The ID of the lab.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• siteId(required): string(uuid)
  Minimum Length: 32

  Maximum Length: 32

  Pattern: ^[A-F0-9]{32}$

  The ID of the site.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LabSiteDto v1.0

Type: object

Title: LabSiteDto v1.0

Details of the lab-to-site association.

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)
  Title: Lab Site Association ID

  Pattern: ^[A-F0-9]{32}$

  Unique identifier for the lab-site association.
• labId: string (uuid)
  Title: Lab ID

  Pattern: ^[A-F0-9]{32}$

  Identifier of the lab in the association.
• labVersionStart: string (date-time)
  Title: Lab Version Start

  Timestamp when the lab version started.

  Example: 2025-01-01T00:00:00Z
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• siteId: string (uuid)
  Title: Site ID

  Pattern: ^[A-F0-9]{32}$

  Identifier of the site in the association.
• siteVersionStart: string (date-time)
  Title: Site Version Start

  Timestamp when the site version started.

  Example: 2025-01-01T00:00:00Z
• versionStart: string (date-time)
  Title: Version Start

  Timestamp when the association version began.

  Example: 2025-01-01T00:00:00Z

{
    "title":"LabSiteDto v1.0",
    "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":{
            "title":"Lab Site Association ID",
            "pattern":"^[A-F0-9]{32}$",
            "type":"string",
            "description":"Unique identifier for the lab-site association.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when the association version began.",
            "format":"date-time",
            "example":"2025-01-01T00:00:00Z"
        },
        "labId":{
            "title":"Lab ID",
            "pattern":"^[A-F0-9]{32}$",
            "type":"string",
            "description":"Identifier of the lab in the association.",
            "format":"uuid"
        },
        "labVersionStart":{
            "title":"Lab Version Start",
            "type":"string",
            "description":"Timestamp when the lab version started.",
            "format":"date-time",
            "example":"2025-01-01T00:00:00Z"
        },
        "siteId":{
            "title":"Site ID",
            "pattern":"^[A-F0-9]{32}$",
            "type":"string",
            "description":"Identifier of the site in the association.",
            "format":"uuid"
        },
        "siteVersionStart":{
            "title":"Site Version Start",
            "type":"string",
            "description":"Timestamp when the site version started.",
            "format":"date-time",
            "example":"2025-01-01T00:00:00Z"
        }
    },
    "description":"Details of the lab-to-site association."
}

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

404 Response

Not Found

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