Jump to

• Request
• Response

Get the number of open queries in a study

get

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

Retrieves a list of all queries with the status Open by study ID

Request

Path Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : StudyOpenQueryCountRespDTO v1.0

Type: object

Title: StudyOpenQueryCountRespDTO v1.0

Study Open Query Count payload

Show Source

• errorData: object Error details DTO
  Read Only: true

  Error details from Query APIs
• result: object StudyOpenQueryCountDTO v1.0
  Title: StudyOpenQueryCountDTO v1.0

  Read Only: true

  Study Query Count request payload
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status
• version: string
  Read Only: true

  Response version

{
    "title":"StudyOpenQueryCountRespDTO v1.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "$ref":"#/components/schemas/StudyOpenQueryCountDTO"
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Response version",
            "readOnly":true
        }
    },
    "description":"Study Open Query Count payload"
}

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 : StudyOpenQueryCountDTO v1.0

Type: object

Title: StudyOpenQueryCountDTO v1.0

Read Only: true

Study Query Count request payload

Show Source

• answered: integer (int32)
  answered query count

  Example: 0
• closed: integer (int32)
  closed query count

  Example: 1
• opened: integer (int32)
  opened query count

  Example: 2

{
    "title":"StudyOpenQueryCountDTO v1.0",
    "type":"object",
    "properties":{
        "opened":{
            "type":"integer",
            "description":"opened query count",
            "format":"int32",
            "example":2
        },
        "answered":{
            "type":"integer",
            "description":"answered query count",
            "format":"int32",
            "example":0
        },
        "closed":{
            "type":"integer",
            "description":"closed query count",
            "format":"int32",
            "example":1
        }
    },
    "description":"Study Query Count request payload",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

204 Response

No Content.

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

500 Response

Internal server error.

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