Jump to

• Request
• Response

Get details of an opened query

get

/ec-query-svc/rest/v11.0/studies/{studyId}/{mode}/openQueryDetails

Retrieves data related to opened non-candidate 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

• currentRecord(required): string
  Get the current record of each query. (1 - Yes, 2 -No)

  Example:

  1

• dataElementId(required): string
  Get query data for a specific data element.

  Example:

  6B1321B7038349038B81F2AB3F3DFED1

• eventId(required): string
  Get query data for a specific visit event.

  Example:

  8F1E8B453D8F4B6EB278B324EFE38A7C

• eventInstanceNumber(required): string
  Get query data for a specific event instance number.

  Example:

  1

• formId(required): string
  Get query data for a specific form.

  Example:

  BEF84349611E441D8A3CC3555DA0E80E

• formInstanceNumber(required): string
  Get query data for a specific form instance number.

  Example:

  1

• isSideBar(required): string
  Is the call coming from sidebar

  Example:

  1

• itemId(required): string
  Get query data for a specific itemId.

  Example:

  F931D4F68BD54F5A9455D91583FFE3F7

• limit(required):
  Specify the maximum number of queries to return.

  Example:

  100

• mode(required): string
  Study mode. (Test, Training, Active)

  Example:

  test

• offset(required):
  Specify the offset in the query results from which to start returning data

  Example:

  20

• oldest(required):
  Order query data in ascending time order if oldest=true. Descending order otherwise.

  Example:

  true

• propertyName(required): string
  Property Type

  Example:

  visitStartDate

• propertyType(required): string
  Property Type

  Example:

  visit

• ruleTypeId(required): string
  Rule query types

  Example:

  3

• siteId(required): string
  Get query data for a specific site.

  Example:

  8F1E8B453D8F4B6EB278B324EFE38A7C

• state(required): array
  Get query data in a specific state.

  Example:

  [Closed,Opened]

• studyId(required): string
  Study ID.

  Example:

  0D04308A0ECE4DD0AAA2C2C4C5FF8995

• subjectId(required): string
  Get query data for a specific subject.

  Example:

  7837ED89824C40329635EC020C290530

• visitId(required): string
  Get query data for a specific visit.

  Example:

  8F1E8B453D8F4B6EB278B324EFE38A7C

Query Parameters

• repeatFormNumber: integer
  Repeat Form Number

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object QueryDetailsDTOv9Resp

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

Nested Schema : QueryDetailsDTOv9Resp

Type: object

Show Source

• comments: array comments
  A list of comments associated with the query
• 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
  The name of the form associated with the query

  Example: Form 1
• id: string (uuid)
  Query Unique GUID
• isQueryCreator: boolean
  Is Query creator (true or false)

  Example: true
• itemId: string (uuid)
  Item Unique GUID
• itemName: string
  The name of the item associated with the query

  Example: Item 1
• objectVersionNumber: number
  Sequence number (0, 1, 2, ...) of object Version Number

  Example: 0
• propertyName: string
  The name of the property associated with the query

  Example: visitStartDatev
• propertyType: string
  The type of property associated with the query

  Example: visit
• queryModAllowedByUser: boolean
  Indicates whether the user is allowed to modify the query

  Example: true
• repeatFormNumber: integer
  Repeat Form Number
• ruleId: string (uuid)
  The ID of the rule associated with the query
• studyRoles: array studyRoles
• studyVersion: string
  The version of the study associated with the query

  Example: 1.0
• subjectId: string (uuid)
  Subject Unique GUID
• subjectName: string
  The name of the subject associated with the query

  Example: John Doe
• userCanAnswerQuery: boolean
  Indicates whether the user can answer the query

  Example: true
• userCanCloseQuery: boolean
  Indicates whether the user can close the query

  Example: true
• visitId: string (uuid)
  The ID of the visit associated with the query

  Example: 123e4567-e89b-12d3-a456-426655440000
• visitName: string
  The name of the visit associated with the query

  Example: Visit 1

{
    "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
        },
        "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",
            "description":"The name of the property associated with the query",
            "example":"visitStartDatev"
        },
        "propertyType":{
            "type":"string",
            "description":"The type of property associated with the query",
            "example":"visit"
        },
        "ruleId":{
            "type":"string",
            "description":"The ID of the rule associated with the query",
            "format":"uuid"
        },
        "isQueryCreator":{
            "type":"boolean",
            "description":"Is Query creator (true or false)",
            "example":true
        },
        "subjectName":{
            "type":"string",
            "description":"The name of the subject associated with the query",
            "example":"John Doe"
        },
        "visitName":{
            "type":"string",
            "description":"The name of the visit associated with the query",
            "example":"Visit 1"
        },
        "formName":{
            "type":"string",
            "description":"The name of the form associated with the query",
            "example":"Form 1"
        },
        "visitId":{
            "type":"string",
            "description":"The ID of the visit associated with the query",
            "format":"uuid",
            "example":"123e4567-e89b-12d3-a456-426655440000"
        },
        "studyVersion":{
            "type":"string",
            "description":"The version of the study associated with the query",
            "example":"1.0"
        },
        "itemName":{
            "type":"string",
            "description":"The name of the item associated with the query",
            "example":"Item 1"
        },
        "comments":{
            "type":"array",
            "description":"A list of comments associated with the query",
            "items":{
                "$ref":"#/components/schemas/CommentDetailsDTO"
            }
        },
        "queryModAllowedByUser":{
            "type":"boolean",
            "description":"Indicates whether the user is allowed to modify the query",
            "example":true
        },
        "userCanCloseQuery":{
            "type":"boolean",
            "description":"Indicates whether the user can close the query",
            "example":true
        },
        "userCanAnswerQuery":{
            "type":"boolean",
            "description":"Indicates whether the user can answer the query",
            "example":true
        }
    }
}

Nested Schema : comments

Type: array

A list of comments associated with the query

Show Source

• Array of: object CommentDetailsDTO
  A list of comments associated with the query

{
    "type":"array",
    "description":"A list of comments associated with the query",
    "items":{
        "$ref":"#/components/schemas/CommentDetailsDTO"
    }
}

Nested Schema : studyRoles

Type: array

Show Source

• Array of: object QueryStudyRoleDTOv6

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

Nested Schema : CommentDetailsDTO

Type: object

A list of comments associated with the query

Show Source

• queryComment: string
• state: string
  Allowed Values: [ "Candidate", "Opened", "Answered", "Deleted", "Closed" ]
• userInfo: object DisplayUserDto
  User details including name, username, and email address.
• 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"
        }
    },
    "description":"A list of comments associated with the query"
}

Nested Schema : DisplayUserDto

Type: object

User details including name, username, and email address.

Show Source

• emailAddress: string
  User's email address.

  Example: [e-mail]
• firstName: string
  User's first name.

  Example: Alice
• id: string
  Unique identifier for the user.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• lastName: string
  User's last name.

  Example: Brown
• userName: string
  User's login name.

  Example: alicebrown

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the user.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "firstName":{
            "type":"string",
            "description":"User's first name.",
            "example":"Alice"
        },
        "lastName":{
            "type":"string",
            "description":"User's last name.",
            "example":"Brown"
        },
        "userName":{
            "type":"string",
            "description":"User's login name.",
            "example":"alicebrown"
        },
        "emailAddress":{
            "type":"string",
            "description":"User's email address.",
            "example":"[e-mail]"
        }
    },
    "description":"User details including name, username, and email address."
}

Nested Schema : QueryStudyRoleDTOv6

Type: object

Show Source

• studyRoleId: string (uuid)
  Study role of the user performing the query operation
• studyRoleName: string
  Study role name of the user performing the query operation

  Example: CRA

{
    "type":"object",
    "properties":{
        "studyRoleId":{
            "type":"string",
            "description":"Study role of the user performing the query operation",
            "format":"uuid"
        },
        "studyRoleName":{
            "type":"string",
            "description":"Study role name of the user performing the query operation",
            "example":"CRA"
        }
    }
}

Examples

Select an example QueryDetailsDTOResponseExample

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