Jump to

• Request
• Response

v1.0

get

/ec-codelist-svc/rest/v1.0/history/codes

View historical changes to codelists for a given name and (optionally) study.

Request

Query Parameters

• codeId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the code

  Example:

  B1B8327AFAA6412287106192AB5984EF

• limit(required): integer(int32)
  Minimum Value: 1

  limit.

  Example:

  50

• offset(required): integer(int32)
  Minimum Value: 0

  offset.

  Example:

  0

• studyId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string)

  Example:

  B1B8327AFAA6412287106192AB5984EF

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CodeV3

Type: object

Show Source

• canAddValues: boolean
• canHideValues: boolean
• codeGroupId: string (uuid)
• codeLevel: string
• codeName: string
• codeType: string
• comment: string
• customizable: boolean
• description: string
• displayCodeName: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• optlock: string (date-time)
• parCodeName: string
• reason: string
• softwareVersionNumber: number
• studyId: string (uuid)
• tag: string
• tenantLevelOnly: boolean
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "optlock":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "codeName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "codeType":{
            "type":"string"
        },
        "codeLevel":{
            "type":"string"
        },
        "parCodeName":{
            "type":"string"
        },
        "tag":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "codeGroupId":{
            "type":"string",
            "format":"uuid"
        },
        "displayCodeName":{
            "type":"string"
        },
        "canAddValues":{
            "type":"boolean"
        },
        "canHideValues":{
            "type":"boolean"
        },
        "customizable":{
            "type":"boolean"
        },
        "tenantLevelOnly":{
            "type":"boolean"
        }
    }
}

Examples

Select an example GetCodesAuditHistoryResponse

Back to Top