REST API for Clinical One Platform

Get form item actions assigned to a visit in a study version

post

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/actionitems

Retrieves form item actions that are assigned to a visit in a study version.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

action: string

Return form items with this action.

Default Value: ALL

Allowed Values: [ "autolock", "ALL" ]
excludeItemType: string

Form Item type to exclude from response

Allowed Values: [ "instructionalText" ]
formCategory: string

Return forms with this Form Category.

Default Value: ALL

Allowed Values: [ "DCS", "NSF", "ALL" ]
items: string
mode(required): string

Study mode to filter study forms.

Allowed Values: [ "test", "training", "active" ]

Supported Media Types

Root Schema : schema

Type: array

Show Source

Array of: object StudyVersionVisitDtoV9

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

Nested Schema : StudyVersionVisitDtoV9

Type: object

Show Source

studyId: string (uuid)
studyTitle: string

Study name

Example: Study 03
version: string

version

Example: 1.3.0.6
versionPreviousStatus: string

Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

Previous study status

Example: TESTING
versionStatus: string

Study version status

Example: Active, not recruiting
visitId: string (uuid)

Visit GUID

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study name",
            "example":"Study 03"
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object StudyVisitsWithFormItemActionsDto

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

Nested Schema : StudyVisitsWithFormItemActionsDto

Type: object

Show Source

studyVersion: string
visits: array visits

{
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitsWithFormItemActionsDto"
            }
        }
    }
}

Nested Schema : visits

Type: array

Show Source

Array of: object VisitsWithFormItemActionsDto

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

Nested Schema : VisitsWithFormItemActionsDto

Type: object

Show Source

forms: array forms
id: string (uuid)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormWithItemsActionsDto"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

Array of: object FormWithItemsActionsDto

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

Nested Schema : FormWithItemsActionsDto

Type: object

Show Source

id: string (uuid)
items: array items

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemWithActionsDto"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object FormItemWithActionsDto

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

Nested Schema : FormItemWithActionsDto

Type: object

Show Source

actions: array actions
id: string (uuid)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtoV7"
            }
        }
    }
}

Nested Schema : actions

Type: array

Show Source

Array of: object From Item Advanced Property v7.0

Title: From Item Advanced Property v7.0

Form Item Advanced Property

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

Nested Schema : From Item Advanced Property v7.0

Type: object

Title: From Item Advanced Property v7.0

Form Item Advanced Property

Show Source

id: string (uuid)

Advanced property id
label: string

Advanced property label in UI, i.e. studyName

Example: Study BT-31
name: string

Advanced property name, mapped to the ECD_EXTENDED_PROPERTIES.PROPERTY_NAME column

Example: RolloverQuestion
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

{
    "title":"From Item Advanced Property v7.0",
    "type":"object",
    "properties":{
        "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":"Form Item Advanced Property"
}

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 : 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 ECD_CODELISTITEM.OBJECT_DESCRIPTION

Example: Yes
name: string

name

Example: Answer for Rollover
value: string

For RolloverQuestion property it is an ECD_CODELISTITEM.CODELISTITEM_ID

Example: B1B8327AFAA6412287106192AB5984EF

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

500 Response

Error

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

Type: object