Jump to

• Request
• Response

v1.0

put

/ec-codelist-svc/rest/v1.0/codelist/groups/{groupId}

Rename or update an existing codelist group.

Request

Path Parameters

• groupId(required): string(uuid)
  ID of a CodeList group. When specified, returns codelists of the group (including non-customized SYSTEM default codelists)

  Example:

  B1B8327AFAA6412287106192AB5984EF

Supported Media Types

• */*

Request Body - */* ()

Root Schema : CodeListGroupRequest

Type: object

Title: CodeListGroupRequest

Representation of CodeList Group

Show Source

• codeGroupName: string
  Name of the CodeList Group

  Example: ABC Pharma

{
    "title":"CodeListGroupRequest",
    "type":"object",
    "properties":{
        "codeGroupName":{
            "type":"string",
            "description":"Name of the CodeList Group",
            "example":"ABC Pharma"
        }
    },
    "description":"Representation of CodeList Group"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : CodeListGroupDto

Type: object

Title: CodeListGroupDto

Representation of CodeList Group

Show Source

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

  Example: ABC Pharma

{
    "title":"CodeListGroupDto",
    "type":"object",
    "properties":{
        "codeGroupId":{
            "type":"string",
            "description":"Group GUID",
            "format":"uuid"
        },
        "codeGroupName":{
            "type":"string",
            "description":"Name of the CodeList Group",
            "example":"ABC Pharma"
        }
    },
    "description":"Representation of CodeList Group"
}

Examples

Select an example SuccessResponse

400 Response

Bad Request: invalid parameters or request body

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

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