Jump to

• Request
• Response

V1.0

get

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/e2bmapping/all

Returns E2B mappings for all question types. Use /v20.0 endpoints for current metadata and behavior.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

E2B mappings returned successfully.

Body ()

Root Schema : E2BR3ItemAdvancedPropDto v1.0

Type: object

Title: E2BR3ItemAdvancedPropDto v1.0

E2B3 Mapping Details Information

Show Source

• id: string (uuid)
  Advanced property id
• label: string
  Advanced property label in UI, i.e. studyName

  Example: Study BT-31
• mandatory: boolean
• name: string
  Advanced property name, mapped to the ECD_EXTENDED_PROPERTIES.PROPERTY_NAME column

  Example: RolloverQuestion
• order: string
• parentObjectId: string (uuid)
• parentObjectLabel: string
• parentObjectLevel: string
• rules: array rules
• type: string
  Advanced property type, mapped to the ECD_EXTENDED_PROPERTIES.RESPONSE_MAP_JSON column 'valueType' field

  Example: Dropdown
• value: string
  Advanced property value of studyId

  Example: B1B8327AFAA6412287106192AB5984EF
• values: array values

{
    "title":"E2BR3ItemAdvancedPropDto v1.0",
    "type":"object",
    "properties":{
        "mandatory":{
            "type":"boolean"
        },
        "order":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/E2BR3ItemAdvancedPropDtov1"
            }
        },
        "id":{
            "type":"string",
            "description":"Advanced property id",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Advanced property type, mapped to the ECD_EXTENDED_PROPERTIES.RESPONSE_MAP_JSON column 'valueType' field",
            "example":"Dropdown"
        },
        "name":{
            "type":"string",
            "description":"Advanced property name, mapped to the ECD_EXTENDED_PROPERTIES.PROPERTY_NAME column",
            "example":"RolloverQuestion"
        },
        "value":{
            "type":"string",
            "description":"Advanced property value of studyId",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Advanced property label in UI, i.e. studyName",
            "example":"Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtoV7"
            }
        },
        "parentObjectId":{
            "type":"string",
            "format":"uuid"
        },
        "parentObjectLevel":{
            "type":"string"
        },
        "parentObjectLabel":{
            "type":"string"
        }
    },
    "description":"E2B3 Mapping Details Information"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v7.0
  Title: From Item Advanced Property Rule v7.0

  Form Item Advanced Property Rule

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

Nested Schema : values

Type: array

Show Source

• Array of: object E2BR3ItemAdvancedPropDto v1.0
  Title: E2BR3ItemAdvancedPropDto v1.0

  E2B3 Mapping Details Information

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

Nested Schema : From Item Advanced Property Rule v7.0

Type: object

Title: From Item Advanced Property Rule v7.0

Form Item Advanced Property Rule

Show Source

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v7.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Examples

Select an example e2bMappingAllResponseV1

500 Response

Error

Body ()

Root 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 : Object

Type: object

Title: Object

Object with error details information.

Back to Top