Jump to

• Request
• Response

v1.0

get

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

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

Request

Query Parameters

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

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

  limit.

  Example:

  50

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

  offset.

  Example:

  0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CodeGroup

Type: object

Show Source

• comment: string
  Comment.

  Example: Renamed group
• groupName: string
  Minimum Length: 1

  Maximum Length: 255

  Codelist group name.

  Example: Default Group
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string)

  Example: B1B8327AFAA6412287106192AB5984EF
• objectVersionNumber: number
  Object version number.

  Example: 1
• operationType: string
  Minimum Length: 1

  Maximum Length: 16

  Operation type.

  Example: CREATED
• optlock: string (date-time)
  Optimistic lock timestamp.
• reason: string
  Reason for change.

  Example: Updating code groups
• softwareVersionNumber: number
  Software version number.

  Example: 1
• userId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the user.

  Example: B1B8327AFAA6412287106192AB5984EF
• versionEnd: string (date-time)
  Version end timestamp.
• versionStart: string (date-time)
  Version start timestamp.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string)",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp.",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "example":1
        },
        "optlock":{
            "type":"string",
            "description":"Optimistic lock timestamp.",
            "format":"date-time"
        },
        "userId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the user.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "reason":{
            "type":"string",
            "description":"Reason for change.",
            "example":"Updating code groups"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Renamed group"
        },
        "groupName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Codelist group name.",
            "example":"Default Group"
        }
    }
}

Examples

Select an example GetGroupsAuditHistoryResponse

Back to Top