Jump to

• Request
• Response

v1.0

post

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

Create a new codelist group to manage and reuse related codelists together.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : CodeListGroupRequestV1.0

Type: object

Title: CodeListGroupRequestV1.0

Request payload used to create or update a codelist group.

Show Source

• codeGroupName: string
  Name of the CodeList Group

  Example: ABC Pharma

{
    "title":"CodeListGroupRequestV1.0",
    "type":"object",
    "properties":{
        "codeGroupName":{
            "type":"string",
            "description":"Name of the CodeList Group",
            "example":"ABC Pharma"
        }
    },
    "description":"Request payload used to create or update a codelist group."
}

Examples

Select an example CodeListGroupRequest

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CodeListGroupDtoV1.0

Type: object

Title: CodeListGroupDtoV1.0

Codelist group response containing the group identifier and display name.

Show Source

• codeGroupId: string (uuid)
  Group GUID
• codeGroupName: string
  Name of the CodeList Group

  Example: ABC Pharma

{
    "title":"CodeListGroupDtoV1.0",
    "type":"object",
    "properties":{
        "codeGroupId":{
            "type":"string",
            "description":"Group GUID",
            "format":"uuid"
        },
        "codeGroupName":{
            "type":"string",
            "description":"Name of the CodeList Group",
            "example":"ABC Pharma"
        }
    },
    "description":"Codelist group response containing the group identifier and display name."
}

Examples

Select an example SuccessResponse

400 Response

Bad Request: invalid parameters or request body

Body ()

Root Schema : CodeListResponseV1.0

Type: object

Title: CodeListResponseV1.0

Standard codelist service response envelope.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

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

  Example: success

{
    "title":"CodeListResponseV1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Response result.",
            "example":{
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Standard codelist service response envelope."
}

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Response result.

Example:

{
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example BadRequestResponse

500 Response

Server error

Body ()

Root Schema : CodeListResponseV1.0

Type: object

Title: CodeListResponseV1.0

Standard codelist service response envelope.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

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

  Example: success

{
    "title":"CodeListResponseV1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Response result.",
            "example":{
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Standard codelist service response envelope."
}

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Response result.

Example:

{
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example ServerErrorResponse

Back to Top