Jump to

• Request
• Response

[Deprecated]: v3.0

put

/ec-codelist-svc/rest/v3.0/codelist/code/{codeId}

Update an existing codelist and/or its values.

Request

Path Parameters

• codeId(required): string(uuid)
  ID of the codelist (depending on 'type' parameter, ID can be used as UUID, code name, or tag)

  Example:

  B1B8327AFAA6412287106192AB5984EF

Query Parameters

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

• mode: string
  Mode of the study. Allowed values are active, test and training

  Example:

  DESIGN

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• code: object CodeV3
• values: array values

{
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/components/schemas/CodeV3"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeValueV3"
            }
        }
    }
}

Nested 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"
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object CodeValueV3

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

Nested Schema : CodeValueV3

Type: object

Show Source

• code: string
• codeGroupId: string (uuid)
• codeId: string (uuid)
• codeLabel: string
• codeValue: string
• comment: string
• customizationType: string
• hidden: boolean
• id: string (uuid)
• language: string
• locale: string
• objectVersionNumber: number
• operationType: string
• optLock: string (date-time)
• reason: string
• sequence: number
• softwareVersionNumber: number
• studyId: string (uuid)
• 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"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "codeValue":{
            "type":"string"
        },
        "codeLabel":{
            "type":"string"
        },
        "language":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "sequence":{
            "type":"number"
        },
        "locale":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "codeGroupId":{
            "type":"string",
            "format":"uuid"
        },
        "hidden":{
            "type":"boolean"
        },
        "customizationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Examples

Select an example CodeListRequestV3

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : BaseCodeListDto

Type: object

Show Source

• code: object code
• values: array values

{
    "type":"object",
    "properties":{
        "code":{
            "type":"object"
        },
        "values":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : code

Type: object

Nested Schema : values

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Examples

Select an example UpdateCodelistV3Response

400 Response

'Missing required code definition', 'Missing required values definition','Missing required field (codeName)','Missing required field (codeType)','Duplicate code name', 'Internal server error'

Body ()

Root Schema : CodeListResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : CodeListResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top