Jump to

• Request
• Response

[Deprecated]: Get a query by ID

get

/ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/queries/{queryId}

Deprecated: Use latest version instead. Retrieves an existing query, based on a specified query ID parameter.

Request

Path Parameters

• mode(required): string
  Study mode.
• queryId(required): string
  Query ID.
• 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 : QueryDTO Version 4

Type: object

Title: QueryDTO Version 4

Information for creating/editing query

Show Source

• dataElementId(required): string (uuid)
  Data element Unique GUID
• eventId: string (uuid)
  Event Unique GUID
• 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
• id: string (uuid)
  Query Unique GUID
• objectVersionNumber: number
  Sequence number (0, 1, 2, ...) of object Version Number

  Example: 0
• queryComment(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Query comments

  Example: Comment
• siteId: string (uuid)
  Site Unique GUID
• state: string
  Query state

  Example: Opened
• studyVersionStart: string (date-time)
  Data element Version Start
• subjectId(required): string (uuid)
  Subject Unique GUID

{
    "title":"QueryDTO Version 4",
    "required":[
        "dataElementId",
        "queryComment",
        "subjectId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query Unique GUID",
            "format":"uuid"
        },
        "queryComment":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Query comments",
            "example":"Comment"
        },
        "state":{
            "type":"string",
            "description":"Query state",
            "example":"Opened"
        },
        "subjectId":{
            "type":"string",
            "description":"Subject Unique GUID",
            "format":"uuid"
        },
        "dataElementId":{
            "type":"string",
            "description":"Data element Unique GUID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Data element Version Start",
            "format":"date-time"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "siteId":{
            "type":"string",
            "description":"Site Unique GUID",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "description":"Event Unique GUID",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating event",
            "example":0
        },
        "formInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of repeating form",
            "example":0
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of object Version Number",
            "example":0
        }
    },
    "description":"Information for creating/editing query"
}

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