Jump to

• Request
• Response
• Examples

Retrieve Subject Clinical Specimen Queries Status

get

/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries

This endpoint supports the retrieval of Subject Clinical Specimen Queries Status.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• apiContext: string
  Patient/Subject API context

Query Parameters

• limit(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0
• offset(optional): integer(int32)
  Pagination query params: ?limit=2&offset=0

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : APIQueryStatus

Type: object

Show Source

• cohortQueryName(optional): string
• createdOnDate(optional): string(date-time)
• executeAsync(optional): boolean
• minRetentionPeriodDays(optional): integer(int64)
  Minimum Value: 0
• queryCriteria(optional): object AllCriteriaList
  Contains all the Query Criteria
• queryExecutionStatus(optional): object QueryExecutionStatus
• queryId(optional): integer(int64)
• retentionDate(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "executeAsync":{
            "type":"boolean"
        },
        "cohortQueryName":{
            "type":"string"
        },
        "minRetentionPeriodDays":{
            "type":"integer",
            "format":"int64",
            "minimum":0
        },
        "queryCriteria":{
            "$ref":"#/definitions/OracleDBQueryDS"
        },
        "createdOnDate":{
            "type":"string",
            "format":"date-time"
        },
        "retentionDate":{
            "type":"string",
            "format":"date-time"
        },
        "queryId":{
            "type":"integer",
            "format":"int64"
        },
        "queryExecutionStatus":{
            "$ref":"#/definitions/QueryExecutionStatus"
        }
    }
}

Nested Schema : AllCriteriaList

Type: object

Contains all the Query Criteria

Show Source

• allCriteriaList: array allCriteriaList
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria

{
    "type":"object",
    "required":[
        "allCriteriaList"
    ],
    "properties":{
        "allCriteriaList":{
            "type":"array",
            "description":"List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria",
            "items":{
                "$ref":"#/definitions/criteria"
            },
            "maxItems":2147483647,
            "minItems":1
        }
    },
    "xml":{
        "name":"AllCriteriaList"
    },
    "description":"Contains all the Query Criteria"
}

Nested Schema : QueryExecutionStatus

Type: object

Show Source

• error(optional): object QueryJobError
• links(optional): array links
  A collection of links containing hrefs to query status and results
• queryId(optional): integer(int64)
• status(optional): string

{
    "type":"object",
    "properties":{
        "queryId":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "error":{
            "$ref":"#/definitions/QueryJobError"
        },
        "links":{
            "type":"array",
            "example":"{rel: 'status',href: '/patientapi/patients/queries/{id}'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to query status and results",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : allCriteriaList

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria

Show Source

• Array of: object criteria
  Discriminator: type

{
    "type":"array",
    "description":"List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria",
    "items":{
        "$ref":"#/definitions/criteria"
    },
    "maxItems":2147483647,
    "minItems":1
}

Nested Schema : criteria

Type: object

Discriminator: type

Show Source

• disabled(optional): boolean
• exclude(optional): boolean

{
    "type":"object",
    "discriminator":"type",
    "properties":{
        "exclude":{
            "type":"boolean"
        },
        "disabled":{
            "type":"boolean"
        }
    }
}

Nested Schema : QueryJobError

Type: object

Show Source

• errorCode(optional): string
• errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

A collection of links containing hrefs to query status and results

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'status',href: '/patientapi/patients/queries/{id}'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to query status and results",
    "items":{
        "type":"string"
    }
}

Example:

{rel: 'status',href: '/patientapi/patients/queries/{id}'}

400 Response

Invalid request parameters

404 Response

Query status not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries

Example of Response Body

The following example shows the response returned in JSON format.

{
  "items": [
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1066,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1066"
          },
          {
            "rel": "result",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1066/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1065,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1065"
          },
          {
            "rel": "result",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1065/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1034,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1034"
          },
          {
            "rel": "result",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1034/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/10/2017",
      "retentionDate": "02/15/2017",
      "queryId": 1033,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1033"
          },
          {
            "rel": "result",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1033/data"
          }
        ]
      }
    },
    {
      "createdOnDate": "02/15/2017",
      "retentionDate": "02/20/2017",
      "queryId": 1005,
      "queryExecutionStatus": {
        "status": "DONE",
        "links": [
          {
            "rel": "status",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1005"
          },
          {
            "rel": "result",
            "href": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1005/data"
          }
        ]
      }
    }
  ],
  "count": 5,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries?limit=5"
    },
    {
      "rel": "next",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries?offset=5&limit=5"
    }
  ]
}

Back to Top