Jump to

• Request
• Response

v1.0

put

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

Updates a code list with tag values for association or disassociation as well as tag names.

Request

Query Parameters

• allFields(required): boolean
  Indicates whether hidden fields need to be retrieved. Allowed values are true or false.

  Example:

  true

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

  Example:

  DESIGN

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string)

  Example:

  B1B8327AFAA6412287106192AB5984EF

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object CodeListTagV1

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

Nested Schema : CodeListTagV1

Type: object

Show Source

• codeId: string
• tagName: string

{
    "type":"object",
    "properties":{
        "codeId":{
            "type":"string"
        },
        "tagName":{
            "type":"string"
        }
    }
}

Examples

Select an example UpdateCodesByTagRequest

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 UpdateCodesByTagResponse

400 Response

Invalid request URL.

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