REST API for Clinical One Cloud Service

V1.0

post

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

Returns visit/form action items for the requested study-version visits. The request body is an array where each object identifies a study version and visit; optional query parameters can filter form category, action type, and excluded item type. The response is an EDC envelope whose result contains visits, forms, items, and matching action metadata.

Request

Path Parameters

studyId(required): string(uuid)
Study ID (UUID, 32-character uppercase hexadecimal string).
Example:
```
F054C951EB74443C93716CA714AB686E
```

Query Parameters

action: string
Action filter. Use autolock to return only autolock action items, or ALL to return all supported actions.

Default Value: ALL

Allowed Values: [ "autolock", "ALL" ]
Example:
```
autolock
```
excludeItemType: string
Form item type to exclude from returned action item details.

Allowed Values: [ "instructionalText" ]
Example:
```
instructionalText
```
formCategory: string
Form category filter.

Default Value: ALL

Allowed Values: [ "DCS", "NSF", "ALL" ]
Example:
```
ALL
```
mode(required): string
Study mode filter.

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

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Visit action items were returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object RespStudyVisitswithFormItemActionsDto

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

Nested Schema : RespStudyVisitswithFormItemActionsDto

Type: object

Show Source

studyVersion: string

Title: String

study version.
VisitsWithFormItemActionsDto: object VisitsWithFormItemActionsDto v1.0

Title: VisitsWithFormItemActionsDto v1.0

Information about Auto lock actions on forms assigned to visits requested.

{
    "type":"object",
    "properties":{
        "studyVersion":{
            "title":"String",
            "type":"string",
            "description":"study version."
        },
        "VisitsWithFormItemActionsDto":{
            "title":"VisitsWithFormItemActionsDto v1.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Visit GUID",
                    "format":"uuid"
                },
                "FormWithItemsActionsDto":{
                    "title":"FormWithItemsActionsDto v1.0",
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"string",
                            "description":"Form GUID",
                            "format":"uuid"
                        },
                        "FormItemWithActionsDto":{
                            "title":"FormWithItemsActionsDto v1.0",
                            "type":"object",
                            "properties":{
                                "id":{
                                    "type":"string",
                                    "description":"Item GUID",
                                    "format":"uuid"
                                },
                                "FormItemAdvancedPropDto":{
                                    "title":"From Item Advanced Property v17.0",
                                    "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/FormItemAdvancedPropRuleDtov17"
                                            }
                                        }
                                    },
                                    "description":"Form Item Advanced Property"
                                }
                            },
                            "description":"Information about Auto lock actions on forms"
                        }
                    },
                    "description":"Information about Auto lock actions on forms"
                }
            },
            "description":"Information about Auto lock actions on forms assigned to visits requested."
        }
    }
}

Nested Schema : VisitsWithFormItemActionsDto v1.0

Type: object

Title: VisitsWithFormItemActionsDto v1.0

Information about Auto lock actions on forms assigned to visits requested.

Show Source

FormWithItemsActionsDto: object FormWithItemsActionsDto v1.0

Title: FormWithItemsActionsDto v1.0

Information about Auto lock actions on forms
id: string (uuid)

Visit GUID

{
    "title":"VisitsWithFormItemActionsDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "FormWithItemsActionsDto":{
            "title":"FormWithItemsActionsDto v1.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Form GUID",
                    "format":"uuid"
                },
                "FormItemWithActionsDto":{
                    "title":"FormWithItemsActionsDto v1.0",
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"string",
                            "description":"Item GUID",
                            "format":"uuid"
                        },
                        "FormItemAdvancedPropDto":{
                            "title":"From Item Advanced Property v17.0",
                            "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/FormItemAdvancedPropRuleDtov17"
                                    }
                                }
                            },
                            "description":"Form Item Advanced Property"
                        }
                    },
                    "description":"Information about Auto lock actions on forms"
                }
            },
            "description":"Information about Auto lock actions on forms"
        }
    },
    "description":"Information about Auto lock actions on forms assigned to visits requested."
}

Nested Schema : FormWithItemsActionsDto v1.0

Type: object

Title: FormWithItemsActionsDto v1.0

Information about Auto lock actions on forms

Show Source

FormItemWithActionsDto: object FormWithItemsActionsDto v1.0

Title: FormWithItemsActionsDto v1.0

Information about Auto lock actions on forms
id: string (uuid)

Form GUID

{
    "title":"FormWithItemsActionsDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "FormItemWithActionsDto":{
            "title":"FormWithItemsActionsDto v1.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Item GUID",
                    "format":"uuid"
                },
                "FormItemAdvancedPropDto":{
                    "title":"From Item Advanced Property v17.0",
                    "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/FormItemAdvancedPropRuleDtov17"
                            }
                        }
                    },
                    "description":"Form Item Advanced Property"
                }
            },
            "description":"Information about Auto lock actions on forms"
        }
    },
    "description":"Information about Auto lock actions on forms"
}

Nested Schema : FormWithItemsActionsDto v1.0

Type: object

Title: FormWithItemsActionsDto v1.0

Information about Auto lock actions on forms

Show Source

FormItemAdvancedPropDto: object From Item Advanced Property v17.0

Title: From Item Advanced Property v17.0

Form Item Advanced Property
id: string (uuid)

Item GUID

{
    "title":"FormWithItemsActionsDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Item GUID",
            "format":"uuid"
        },
        "FormItemAdvancedPropDto":{
            "title":"From Item Advanced Property v17.0",
            "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/FormItemAdvancedPropRuleDtov17"
                    }
                }
            },
            "description":"Form Item Advanced Property"
        }
    },
    "description":"Information about Auto lock actions on forms"
}

Nested Schema : From Item Advanced Property v17.0

Type: object

Title: From Item Advanced Property v17.0

Form Item Advanced Property

Show Source

id: string (uuid)

Extended Property ID
label: string

Rollover study name

Example: Rollover Study BT-31
name: string

Minimum Length: 1

Maximum Length: 255

Advanced property name

Example: RolloverQuestionStudyId
rules: array rules
value: string

Minimum Length: 1

Maximum Length: 2048

Advanced property value. For example, rollover study UUID

Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v17.0",
    "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/FormItemAdvancedPropRuleDtov17"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

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

Title: From Item Advanced Property Rule v17.0

Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v17.0

Type: object

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

400 Response

The request payload is missing studyVersion or visitId, or contains invalid values.

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples