Jump to

• Request
• Response

Get subject and user information for queries in a study and mode

get

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

Retrieves the following query details for a given study ID and study mode:

• Subject
• CreatedBy
• ClosedBy
• Assignedrole

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 : schema

Type: array

Show Source

• Array of: object QueryManagementFilterDTO

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

Nested Schema : QueryManagementFilterDTO

Type: object

Show Source

• assignedQueryRoleList: array assignedQueryRoleList
• closedByList: array closedByList
• closedRoleList: array closedRoleList
• createdByList: array createdByList
• creatorRoleList: array creatorRoleList
• formNameList: array formNameList
• subjectList: array subjectList

{
    "type":"object",
    "properties":{
        "subjectList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "createdByList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryUserRoleDTO"
            }
        },
        "closedByList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryUserRoleDTO"
            }
        },
        "assignedQueryRoleList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryUserRoleDTO"
            }
        },
        "creatorRoleList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryUserRoleDTO"
            }
        },
        "closedRoleList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryUserRoleDTO"
            }
        },
        "formNameList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryUserRoleDTO"
            }
        }
    }
}

Nested Schema : assignedQueryRoleList

Type: array

Show Source

• Array of: object QueryUserRoleDTO

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

Nested Schema : closedByList

Type: array

Show Source

• Array of: object QueryUserRoleDTO

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

Nested Schema : closedRoleList

Type: array

Show Source

• Array of: object QueryUserRoleDTO

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

Nested Schema : createdByList

Type: array

Show Source

• Array of: object QueryUserRoleDTO

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

Nested Schema : creatorRoleList

Type: array

Show Source

• Array of: object QueryUserRoleDTO

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

Nested Schema : formNameList

Type: array

Show Source

• Array of: object QueryUserRoleDTO

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

Nested Schema : subjectList

Type: array

Show Source

• Array of: string

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

Nested Schema : QueryUserRoleDTO

Type: object

Show Source

• id: string (uuid)
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "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