Jump to

• Request
• Response

[Deprecated]: Get the list of all query states

get

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

Deprecated: Use latest version instead. Retrieves the list of all transition states of a query.

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 QueryStateDTO

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

Nested Schema : QueryStateDTO

Type: object

Show Source

• createdBy: string
• creationDate: string (date-time)
• lastUpdateDate: string (date-time)
• lastUpdatedBy: string
• softwareVersionNumber: number
• state: string
• stateId: number
• systemState: string

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdateDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "state":{
            "type":"string"
        },
        "systemState":{
            "type":"string"
        },
        "stateId":{
            "type":"number"
        }
    }
}

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

Back to Top