Jump to

• Request
• Response

[Deprecated]: Insert code list with tag

post

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

Deprecated: Inserts a new code list with tag.

Request

Query Parameters

• mode(required): string
  Mode of the study. Allowed values are active, test and training
• studyId(required): string
  ID of the study

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• code: object CodeV2
• values: array values

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

Nested Schema : CodeV2

Type: object

Show Source

• codeLevel: string
• codeName: string
• codeType: string
• comment: string
• description: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• optlock: string (date-time)
• parCodeName: string
• reason: string
• softwareVersionNumber: number
• tag: string
• 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"
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object CodeValueV1

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

Nested Schema : CodeValueV1

Type: object

Show Source

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

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

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