Jump to

• Request
• Response

v1.0

post

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

Creates a lab and also associates it with the site, if a site ID is provided.

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 : LabDto v1.0

Type: object

Title: LabDto v1.0

Payload used to create or update a lab.

Show Source

• associatedSite: string (uuid)
  Title: Associated Site

  Identifier of the site to associate with the lab.
• id: string (uuid)
  Title: Lab ID

  Unique identifier for the lab (UUID, uppercase hexadecimal).
• name(required): string
  Title: Lab Name

  Minimum Length: 0

  Maximum Length: 200

  Name of the lab.

  Example: Central Lab
• shortName: string
  Title: Lab Short Name

  Minimum Length: 0

  Maximum Length: 50

  Short name of the lab.

  Example: CLAB

{
    "title":"LabDto v1.0",
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Lab ID",
            "type":"string",
            "description":"Unique identifier for the lab (UUID, uppercase hexadecimal).",
            "format":"uuid"
        },
        "name":{
            "title":"Lab Name",
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"Name of the lab.",
            "example":"Central Lab"
        },
        "shortName":{
            "title":"Lab Short Name",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Short name of the lab.",
            "example":"CLAB"
        },
        "associatedSite":{
            "title":"Associated Site",
            "type":"string",
            "description":"Identifier of the site to associate with the lab.",
            "format":"uuid"
        }
    },
    "description":"Payload used to create or update a lab."
}

Examples

Select an example Create Lab Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LabDto v1.0

Type: object

Title: LabDto v1.0

Payload used to create or update a lab.

Show Source

• associatedSite: string (uuid)
  Title: Associated Site

  Identifier of the site to associate with the lab.
• id: string (uuid)
  Title: Lab ID

  Unique identifier for the lab (UUID, uppercase hexadecimal).
• name(required): string
  Title: Lab Name

  Minimum Length: 0

  Maximum Length: 200

  Name of the lab.

  Example: Central Lab
• shortName: string
  Title: Lab Short Name

  Minimum Length: 0

  Maximum Length: 50

  Short name of the lab.

  Example: CLAB

{
    "title":"LabDto v1.0",
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Lab ID",
            "type":"string",
            "description":"Unique identifier for the lab (UUID, uppercase hexadecimal).",
            "format":"uuid"
        },
        "name":{
            "title":"Lab Name",
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"Name of the lab.",
            "example":"Central Lab"
        },
        "shortName":{
            "title":"Lab Short Name",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Short name of the lab.",
            "example":"CLAB"
        },
        "associatedSite":{
            "title":"Associated Site",
            "type":"string",
            "description":"Identifier of the site to associate with the lab.",
            "format":"uuid"
        }
    },
    "description":"Payload used to create or update a lab."
}

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