[Deprecated]: Close an existing query
put
/ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/{queryId}/close
Deprecated: Use latest version instead. Closes an existing query. The query must be in an appropriate state for the user to update it.
Request
Path Parameters
-
mode(required): string
Study mode.
-
queryId(required): string
ID of the query to close.
-
studyId(required): string
Study ID.
Supported Media Types
- application/json
Root Schema : QueryDTO Version 7
Type:
object
Title:
QueryDTO Version 7
Information for creating/editing query
Show Source
-
dataElementId: string
(uuid)
Data element Unique GUID
-
discrepancyId: integer
Discrepancy Id
-
eventId(required): string
(uuid)
Event Unique GUID
-
eventInstanceNumber: number
Sequence number (0, 1, 2, ...) of repeating eventExample:
0
-
formId(required): string
(uuid)
Form Unique GUID
-
formInstanceNumber: number
Sequence number (0, 1, 2, ...) of repeating formExample:
0
-
id: string
(uuid)
Query Unique GUID
-
itemId: string
(uuid)
Item Unique GUID
-
objectVersionNumber: number
Sequence number (0, 1, 2, ...) of object Version NumberExample:
0
-
queryComment(required): string
Minimum Length:
1
Maximum Length:2048
Query commentsExample:Comment
-
siteId: string
(uuid)
Site Unique GUID
-
state: string
Query stateExample:
Opened
-
studyRoles: array
studyRoles
List of study roles ids
-
studyVersionStart: string
(date-time)
Data element Version Start
-
subjectId(required): string
(uuid)
Subject Unique GUID
Nested Schema : studyRoles
Type:
array
List of study roles ids
Show Source
-
Array of:
string(uuid)
List of study roles ids
Example:
[
"6AF54DB79B764662B685D68C52AB0B84",
"6AF54DB79B764662B685D68C52AB0B84"
]
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : QueryDTO Version 7
Type:
object
Title:
QueryDTO Version 7
Information for creating/editing query
Show Source
-
dataElementId: string
(uuid)
Data element Unique GUID
-
discrepancyId: integer
Discrepancy Id
-
eventId(required): string
(uuid)
Event Unique GUID
-
eventInstanceNumber: number
Sequence number (0, 1, 2, ...) of repeating eventExample:
0
-
formId(required): string
(uuid)
Form Unique GUID
-
formInstanceNumber: number
Sequence number (0, 1, 2, ...) of repeating formExample:
0
-
id: string
(uuid)
Query Unique GUID
-
itemId: string
(uuid)
Item Unique GUID
-
objectVersionNumber: number
Sequence number (0, 1, 2, ...) of object Version NumberExample:
0
-
queryComment(required): string
Minimum Length:
1
Maximum Length:2048
Query commentsExample:Comment
-
siteId: string
(uuid)
Site Unique GUID
-
state: string
Query stateExample:
Opened
-
studyRoles: array
studyRoles
List of study roles ids
-
studyVersionStart: string
(date-time)
Data element Version Start
-
subjectId(required): string
(uuid)
Subject Unique GUID
Nested Schema : studyRoles
Type:
array
List of study roles ids
Show Source
-
Array of:
string(uuid)
List of study roles ids
Example:
[
"6AF54DB79B764662B685D68C52AB0B84",
"6AF54DB79B764662B685D68C52AB0B84"
]
400 Response
Data is invalid.
Root Schema : Response DTO
Type:
object
Response from Query APIs
Show Source
-
errorData: object
Error details DTO
Read Only:
true
Error details from Query APIs -
result: object
result
Read Only:
true
Result Object -
status: string
Read Only:
true
Allowed Values:[ "success, failed" ]
Status -
version: string
Read Only:
true
Response version
Nested Schema : Error details DTO
Type:
object
Read Only:
true
Error details from Query APIs
Show Source
-
details: object
details
Read Only:
true
Error Details -
errorCode: string
Read Only:
true
Error Code -
errorMessage: string
Read Only:
true
Error Message
Nested Schema : result
Type:
object
Read Only:
true
Result Object
Nested Schema : details
Type:
object
Read Only:
true
Error Details
404 Response
The query could not be found.
Root Schema : Response DTO
Type:
object
Response from Query APIs
Show Source
-
errorData: object
Error details DTO
Read Only:
true
Error details from Query APIs -
result: object
result
Read Only:
true
Result Object -
status: string
Read Only:
true
Allowed Values:[ "success, failed" ]
Status -
version: string
Read Only:
true
Response version
Nested Schema : Error details DTO
Type:
object
Read Only:
true
Error details from Query APIs
Show Source
-
details: object
details
Read Only:
true
Error Details -
errorCode: string
Read Only:
true
Error Code -
errorMessage: string
Read Only:
true
Error Message
Nested Schema : result
Type:
object
Read Only:
true
Result Object
Nested Schema : details
Type:
object
Read Only:
true
Error Details