Jump to

• Request
• Response

[Deprecated]: Insert a new code list

post

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

Deprecated: This method is no longer used to insert a new system-level code list based on the given payload. The API used to insert code lists at a user-level will be provided in the future.
Right: CodeListPost.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• code: object Code
• values: array values

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

Nested Schema : Code

Type: object

Show Source

• canAddValues: boolean
• canHideValues: boolean
• codeGroupId: string (uuid)
• codeLevel: string
  Minimum Length: 1

  Maximum Length: 32
• codeName: string
  Minimum Length: 1

  Maximum Length: 255
• codeType: string
  Minimum Length: 1

  Maximum Length: 255
• comment: string
• customizable: boolean
• description: string
  Minimum Length: 1

  Maximum Length: 4000
• displayCodeName: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• optlock: string (date-time)
• parCodeName: string
  Minimum Length: 1

  Maximum Length: 255
• reason: string
• softwareVersionNumber: number
• tag: string
  Minimum Length: 1

  Maximum Length: 32767
• 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":{
            "maxLength":16,
            "minLength":1,
            "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":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "codeType":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "codeLevel":{
            "maxLength":32,
            "minLength":1,
            "type":"string"
        },
        "parCodeName":{
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "description":{
            "maxLength":4000,
            "minLength":1,
            "type":"string"
        },
        "tag":{
            "maxLength":32767,
            "minLength":1,
            "type":"string"
        },
        "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 CodeValue
  Represents a coded value applied to a source value. Includes coding information, item and target identifiers and the coded result.

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

Nested Schema : CodeValue

Type: object

Represents a coded value applied to a source value. Includes coding information, item and target identifiers and the coded result.

Show Source

• code_value(required): string
  Minimum Length: 0

  Maximum Length: 4000

  The actual code value derived from the coding process.

  Example: R79.0
• coding_info_id: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding info used to derive the code.

  Example: 3A1A5E8B0F894A9CA9F324D04B162F23
• item_id: string
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: 5B3B7E0ED4F24E30B5A3A44C5A896C90
• target_id: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding result target.

  Example: F843B5478028498882E3AF11FEBA3F2A

{
    "required":[
        "code_value"
    ],
    "type":"object",
    "properties":{
        "coding_info_id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding info used to derive the code.",
            "example":"3A1A5E8B0F894A9CA9F324D04B162F23"
        },
        "item_id":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"5B3B7E0ED4F24E30B5A3A44C5A896C90"
        },
        "target_id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) for the coding result target.",
            "example":"F843B5478028498882E3AF11FEBA3F2A"
        },
        "code_value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"The actual code value derived from the coding process.",
            "example":"R79.0"
        }
    },
    "description":"Represents a coded value applied to a source value. Includes coding information, item and target identifiers and the coded result."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CodeListDto

Type: object

Show Source

• codeName: string
• codeType: string
• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• optLock: string (date-time)
• reason: string
• softwareVersionNumber: number
• userId: string (uuid)
• values: array values
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeName":{
            "type":"string"
        },
        "codeType":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object CodeValueDto

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

Nested Schema : CodeValueDto

Type: object

Show Source

• codeId: string (uuid)
• codeLabel: string
• codeValue: string
• comment: string
• id: string (uuid)
• locale: string
• objectVersionNumber: number
• operationType: string
• optLock: string (date-time)
• reason: string
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "codeLabel":{
            "type":"string"
        },
        "codeValue":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

400 Response

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

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