Jump to

• Request
• Response

v1.0

get

/ec-library-svc/rest/v1.0/libraryHistory/{libraryId}

Retrieves the history for a specific library object.

Request

Path Parameters

• libraryId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.

  Example:

  B1B8327AFAA6412287106192AB5984EF

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LibraryHistoryDtoV1.0
  Title: LibraryHistoryDtoV1.0

  Information about the history of library modifications.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LibraryHistoryDtoV1"
    }
}

Nested Schema : LibraryHistoryDtoV1.0

Type: object

Title: LibraryHistoryDtoV1.0

Information about the history of library modifications.

Show Source

• lastModifiedDate: string (date-time)
  Title: Last modified date

  Date and time when the resource was last modified.

  Example: 2022-08-30T07:59:46.901Z
• libraryId: string
  Title: Library ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.

  Example: B1B8327AFAA6412287106192AB5984EF
• libraryVersion: string
  Title: Library version

  Version identifier of the library.

  Example: 1.0
• status: string
  Title: Status

  Status of the resource.

  Example: DRAFT
• userId: string
  Title: User ID

  Unique user identifier (UUID) representing the investigator or system user who modified or interacted with the subject record

  Example: B1B8327AFAA6412287106192AB5984EF
• userName: string
  Title: User name

  Name of the user that performed the modification.

  Example: John Doe

{
    "title":"LibraryHistoryDtoV1.0",
    "type":"object",
    "properties":{
        "libraryId":{
            "title":"Library ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "lastModifiedDate":{
            "title":"Last modified date",
            "type":"string",
            "description":"Date and time when the resource was last modified.",
            "format":"date-time",
            "example":"2022-08-30T07:59:46.901Z"
        },
        "libraryVersion":{
            "title":"Library version",
            "type":"string",
            "description":"Version identifier of the library.",
            "example":"1.0"
        },
        "status":{
            "title":"Status",
            "type":"string",
            "description":"Status of the resource.",
            "example":"DRAFT"
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"Unique user identifier (UUID) representing the investigator or system user who modified or interacted with the subject record",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "userName":{
            "title":"User name",
            "type":"string",
            "description":"Name of the user that performed the modification.",
            "example":"John Doe"
        }
    },
    "description":"Information about the history of library modifications."
}

Examples

Select an example LibraryHistoryResponseV1

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top