Jump to

• Request
• Response

[Deprecated]: V1.0

post

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

Deprecated in v1.0. Returns visit/form action items by study version and mode. Use /v20.0 visit forms APIs for current supported behavior.

Request

Path Parameters

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

Query Parameters

• action: string
  Action filter (optional). Allowed values: autolock, ALL.

  Default Value: ALL

  Allowed Values: [ "autolock", "ALL" ]
• excludeItemType: string
  Form item type to exclude (optional). Allowed value: instructionalText.

  Allowed Values: [ "instructionalText" ]
• formCategory: string
  Form category filter (optional). Allowed values: DCS, NSF, ALL.

  Default Value: ALL

  Allowed Values: [ "DCS", "NSF", "ALL" ]
• mode(required): string
  Study mode filter. Required. Allowed values: test, training, active.

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object StudyVersionVisitDto v9.0
  Title: StudyVersionVisitDto v9.0

  Information about a visit in a study version.

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

Nested Schema : StudyVersionVisitDto v9.0

Type: object

Title: StudyVersionVisitDto v9.0

Information about a visit in a study version.

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

{
    "title":"StudyVersionVisitDto v9.0",
    "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"
        }
    },
    "description":"Information about a visit in a study version."
}

Examples

Select an example visitsActionItemsRequestV1

Back to Top

Response

Supported Media Types

• application/json

200 Response

Visit action items returned successfully.

Body ()

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)
  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

{
    "title":"From Item Advanced Property v7.0",
    "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/FormItemAdvancedPropRuleDtoV7"
            }
        }
    },
    "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 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 visitsActionItemsResponseV1

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