Jump to

• Request
• Response

v5.0

post

/ec-codelist-svc/rest/v5.0/codelist/code

Create a new codelist with its values.

Request

Query Parameters

• 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/CodeValueV5"
            }
        }
    }
}

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 CodeValueV5

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

Nested Schema : CodeValueV5

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
• loinc: string
• modeSiteMappings: array modeSiteMappings
• 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"
        },
        "loinc":{
            "type":"string"
        },
        "modeSiteMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ModeSiteMappingTO"
            }
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : modeSiteMappings

Type: array

Show Source

• Array of: object ModeSiteMappingTO

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

Nested Schema : ModeSiteMappingTO

Type: object

Show Source

• mode: string
• sites: array sites

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        },
        "sites":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SiteTO"
            }
        }
    }
}

Nested Schema : sites

Type: array

Show Source

• Array of: object SiteTO

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

Nested Schema : SiteTO

Type: object

Show Source

• isAssociated: boolean
• siteId(required): string (uuid)

{
    "required":[
        "siteId"
    ],
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "isAssociated":{
            "type":"boolean"
        }
    }
}

Examples

Select an example CodeListRequestV5

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 CreateCodelistV5Response

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

  Error Response Details Information
• result: object result
• status: string

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

Nested 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 : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Body ()

Root Schema : CodeListResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
• status: string

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

Nested 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 : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top