Jump to

• Request
• Response

[Deprecated]: v1.0

get

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

Retrieves the lab history for the given lab ID.

Request

Path Parameters

• id(required): string
  SDF ID to delete.

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

Type: object

Title: LabHistoryResponse v1.0

History entry for lab changes.

Show Source

• comment: string
  Title: Comment

  Comment attached to the history entry.

  Example: Changed site assignments
• id: string (uuid)
• name: string
  Title: Lab Name

  Lab name recorded in this history entry.

  Example: Central Lab
• operationType: string
  Title: Operation Type

  Operation performed on the lab record (CREATE, UPDATE, or DELETE).

  Example: UPDATE
• reason: string
  Title: Reason

  Reason associated with the history record.

  Example: Updated lab properties
• shortName: string
  Title: Lab Short Name

  Short name captured in the history entry.

  Example: CLAB
• userId: string (uuid)
• versionEnd: string (date-time)
  Title: Version End

  Timestamp when this history version was superseded.

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

  Timestamp when this history version became active.

  Example: 2025-01-01T08:30:00Z

{
    "title":"LabHistoryResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "title":"Lab Name",
            "type":"string",
            "description":"Lab name recorded in this history entry.",
            "example":"Central Lab"
        },
        "shortName":{
            "title":"Lab Short Name",
            "type":"string",
            "description":"Short name captured in the history entry.",
            "example":"CLAB"
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason associated with the history record.",
            "example":"Updated lab properties"
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Comment attached to the history entry.",
            "example":"Changed site assignments"
        },
        "operationType":{
            "title":"Operation Type",
            "type":"string",
            "description":"Operation performed on the lab record (CREATE, UPDATE, or DELETE).",
            "example":"UPDATE"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this history version became active.",
            "format":"date-time",
            "example":"2025-01-01T08:30:00Z"
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Timestamp when this history version was superseded.",
            "format":"date-time",
            "example":"2025-02-01T12:00:00Z"
        }
    },
    "description":"History entry for lab changes."
}

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