REST API for Clinical One Platform

Process visits to associate with a specific form

post

/ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}/visits

Processes visits to be associated with a specific form in a study.

Request

Path Parameters

formId(required): string(uuid)
studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E
version(required): string

Study version. Example: "1.0.0.1"

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object FormItemAdvancedPropDtoV10

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

Nested Schema : FormItemAdvancedPropDtoV10

Type: object

Show Source

id: string (uuid)

Extended Property ID
label: string

Rollover study name

Example: Rollover Study BT-31
name(required): string

Minimum Length: 1

Maximum Length: 255

Advanced property name

Example: RolloverQuestionStudyId
rules: array rules
value(required): string

Minimum Length: 1

Maximum Length: 2048

Advanced property value. For example, rollover study UUID

Example: B1B8327AFAA6412287106192AB5984EF

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov10"
            }
        }
    }
}

Nested Schema : rules

Type: array

Show Source

Array of: object From Item Advanced Property Rule v10.0

Title: From Item Advanced Property Rule v10.0

Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v10.0

Type: object

Title: From Item Advanced Property Rule v10.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 v10.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"
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

500 Response

Error

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.