Jump to

• Request
• Response

Get list of queries based on multiple parameters

post

/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/querymgmt/queryList

Retrieves a list of all queries based on any combination of the following parameters:

• study ID
• study mode (Testing, Training, or Production)
• subject ID
• site ID
• visit ID
• event ID
• form ID
• question ID
• query state

Additional Filter options can be found in request payload.

Request

Path Parameters

• mode(required): string
  Study mode.
• studyId(required): string
  Study ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assignedRoleId: string
• closedStudyRoleId: string
• creatorStudyRoleId: string
• currentRecord: string
• formIdList: array formIdList
• lastUpdated: string
• paginationParam: object PaginationParamDTO
• queryByAge: string
• queryByID: string
• queryClosedBy: string
• queryCreatedBy: string
• queryGridView: string
• queryState: array queryState
• queryType: string
• ruleTypeId: string
• searchStr: string
• siteIdList: array siteIdList
• subjectIdList: array subjectIdList

{
    "type":"object",
    "properties":{
        "paginationParam":{
            "$ref":"#/components/schemas/PaginationParamDTO"
        },
        "lastUpdated":{
            "type":"string"
        },
        "queryType":{
            "type":"string"
        },
        "assignedRoleId":{
            "type":"string"
        },
        "subjectIdList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteIdList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "searchStr":{
            "type":"string"
        },
        "queryGridView":{
            "type":"string"
        },
        "queryCreatedBy":{
            "type":"string"
        },
        "queryByID":{
            "type":"string"
        },
        "queryByAge":{
            "type":"string"
        },
        "queryClosedBy":{
            "type":"string"
        },
        "creatorStudyRoleId":{
            "type":"string"
        },
        "closedStudyRoleId":{
            "type":"string"
        },
        "formIdList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "queryState":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "currentRecord":{
            "type":"string"
        },
        "ruleTypeId":{
            "type":"string"
        }
    }
}

Nested Schema : formIdList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : PaginationParamDTO

Type: object

Show Source

• limit: integer (int32)
• offset: integer (int32)
• orderasc: boolean

{
    "type":"object",
    "properties":{
        "orderasc":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : queryState

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : siteIdList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : subjectIdList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object QueryDetailsDTOv10Resp

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

Nested Schema : QueryDetailsDTOv10Resp

Type: object

Show Source

• comments: array comments
• discrepancyId: integer
  Discrepancy Id
• eventInstanceNumber: number
  Sequence number (0, 1, 2, ...) of repeating event

  Example: 0
• formId: string (uuid)
  Form Unique GUID
• formInstanceNumber: number
  Sequence number (0, 1, 2, ...) of repeating form

  Example: 0
• formName: string
• id: string (uuid)
  Query Unique GUID
• isCycle: boolean
• isQueryCreator: boolean
• itemId: string (uuid)
  Item Unique GUID
• itemName: string
• objectVersionNumber: number
  Sequence number (0, 1, 2, ...) of object Version Number

  Example: 0
• propertyName: string
• propertyType: string
• queryAge: string
• queryModAllowedByUser: boolean
• repeatFormNumber: integer
  Repeat Form Number
• ruleId: string (uuid)
• siteId: string (uuid)
  Site Unique GUID
• studyRoles: array studyRoles
• studyVersion: string
• subjectId: string (uuid)
  Subject Unique GUID
• subjectName: string
• userCanAnswerQuery: boolean
• userCanCloseQuery: boolean
• visitId: string (uuid)
• visitName: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query Unique GUID",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "description":"Subject Unique GUID",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "formInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating form",
            "example":0
        },
        "siteId":{
            "type":"string",
            "description":"Site Unique GUID",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating event",
            "example":0
        },
        "studyRoles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryStudyRoleDTOv6"
            }
        },
        "discrepancyId":{
            "type":"integer",
            "description":"Discrepancy Id"
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Repeat Form Number"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of object Version Number",
            "example":0
        },
        "itemId":{
            "type":"string",
            "description":"Item Unique GUID",
            "format":"uuid"
        },
        "propertyName":{
            "type":"string"
        },
        "propertyType":{
            "type":"string"
        },
        "ruleId":{
            "type":"string",
            "format":"uuid"
        },
        "isQueryCreator":{
            "type":"boolean"
        },
        "subjectName":{
            "type":"string"
        },
        "visitName":{
            "type":"string"
        },
        "formName":{
            "type":"string"
        },
        "visitId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "itemName":{
            "type":"string"
        },
        "comments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CommentDetailsDTOV2"
            }
        },
        "queryModAllowedByUser":{
            "type":"boolean"
        },
        "userCanCloseQuery":{
            "type":"boolean"
        },
        "userCanAnswerQuery":{
            "type":"boolean"
        },
        "queryAge":{
            "type":"string"
        },
        "isCycle":{
            "type":"boolean"
        }
    }
}

Nested Schema : comments

Type: array

Show Source

• Array of: object CommentDetailsDTOV2

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

Nested Schema : studyRoles

Type: array

Show Source

• Array of: object QueryStudyRoleDTOv6

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

Nested Schema : CommentDetailsDTOV2

Type: object

Show Source

• queryComment: string
• state: string
  Allowed Values: [ "Candidate", "Opened", "Answered", "Deleted", "Closed" ]
• userDisplayName: string
• userInfo: object DisplayUserDto
• userStudyRoleId: string
• userStudyRoleName: string
• value: string
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "enum":[
                "Candidate",
                "Opened",
                "Answered",
                "Deleted",
                "Closed"
            ]
        },
        "queryComment":{
            "type":"string"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "value":{
            "type":"string"
        },
        "userInfo":{
            "$ref":"#/components/schemas/DisplayUserDto"
        },
        "userDisplayName":{
            "type":"string"
        },
        "userStudyRoleId":{
            "type":"string"
        },
        "userStudyRoleName":{
            "type":"string"
        }
    }
}

Nested Schema : DisplayUserDto

Type: object

Show Source

• emailAddress: string
• firstName: string
• id: string (uuid)
• lastName: string
• userName: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        }
    }
}

Nested Schema : QueryStudyRoleDTOv6

Type: object

Show Source

• studyRoleId: string (uuid)
• studyRoleName: string

{
    "type":"object",
    "properties":{
        "studyRoleId":{
            "type":"string",
            "format":"uuid"
        },
        "studyRoleName":{
            "type":"string"
        }
    }
}

400 Response

Data is invalid.

Body ()

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Response from Query APIs"
}

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Query APIs",
    "readOnly":true
}

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.

Body ()

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Response from Query APIs"
}

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Query APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object

Nested Schema : details

Type: object

Read Only: true

Error Details

Back to Top