Jump to

• Request
• Response

Get history of a library object

get

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

Retrieves the history for a specific library object.

Request

Path Parameters

• libraryId(required): string(uuid)
  Library id

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 LibraryHistoryDto
  Title: LibraryHistoryDto

  Information about the history of library modifictation

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

Nested Schema : LibraryHistoryDto

Type: object

Title: LibraryHistoryDto

Information about the history of library modifictation

Show Source

• lastModifiedDate: string (date-time)
  Last Modified Date

  Example: 2022-08-30T07:59:46.901Z
• libraryId: string (uuid)
  Library ID
• libraryVersion: string
  Library version

  Example: v1.0
• status: string
  Library status

  Example: DRAFT
• userId: string (uuid)
  Library user id
• userName: string
  User name

  Example: John Doe

{
    "title":"LibraryHistoryDto",
    "type":"object",
    "properties":{
        "libraryId":{
            "type":"string",
            "description":"Library ID",
            "format":"uuid"
        },
        "lastModifiedDate":{
            "type":"string",
            "description":"Last Modified Date",
            "format":"date-time",
            "example":"2022-08-30T07:59:46.901Z"
        },
        "libraryVersion":{
            "type":"string",
            "description":"Library version",
            "example":"v1.0"
        },
        "status":{
            "type":"string",
            "description":"Library status",
            "example":"DRAFT"
        },
        "userId":{
            "type":"string",
            "description":"Library user id",
            "format":"uuid"
        },
        "userName":{
            "type":"string",
            "description":"User name",
            "example":"John Doe"
        }
    },
    "description":"Information about the history of library modifictation"
}

500 Response

Error

Body ()

Root 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 : details

Type: object

Back to Top