REST API for Clinical One Platform

Close or delete multiple queries for a given subject

put

/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/bulkCloseDelete

Closes or deletes all queries for given subject and visit for the itemIds provided in the request body.
The user must have both rights to close and delete queries.

Request

Path Parameters

eventId(required): string

Visit Id
mode(required): string

Study mode.
studyId(required): string

Study ID.
subjectId(required): string

Subject Id

Query Parameters

eventInstanceNum: number

Visit instance number
innerRepeat: integer

Inner repeating instance number
outerRepeat: integer

Outer repeating instance number

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

items(required): array items

list of item Unique GUIDs
queryComment: string

Minimum Length: 1

Maximum Length: 2048

Query comments

Example: Comment

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"list of item Unique GUIDs",
            "format":"uuid",
            "example":[
                "938D23FA6B7241CCA41BD627E5DB60DA",
                "699EF3745FC545589F186D2198F3C65E"
            ],
            "items":{
                "type":"string",
                "description":"list of item Unique GUIDs",
                "format":"uuid"
            }
        },
        "queryComment":{
            "maxLength":"2048",
            "minLength":"1",
            "type":"string",
            "description":"Query comments",
            "example":"Comment"
        }
    }
}

Nested Schema : items

Type: array

list of item Unique GUIDs

Show Source

Array of: string(uuid)

list of item Unique GUIDs

{
    "type":"array",
    "description":"list of item Unique GUIDs",
    "format":"uuid",
    "example":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ],
    "items":{
        "type":"string",
        "description":"list of item Unique GUIDs",
        "format":"uuid"
    }
}

Example:

[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]

Response

Supported Media Types

application/json

Default Response

default response