Retrieve Subject Query Results for a Query Identifier
get
/ohfapi/cg/v3.3/subjectapi/subjects/queries/{id}/data
This endpoint supports the retrieval of Subject Record (row) Ids resulted as response to the Query.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
Query ID
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
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : SubjectId
Type:
Show Source
object
-
subjectId(optional):
integer
Subject Row ID
-
subjectIdentifier(optional):
string
Subject Identifier
400 Response
Invalid request parameters
404 Response
Query not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/queries/977/data
Example of Response Body
The following example shows the response returned in JSON format.
{ "items": [ { "subjectId": 1095, "subjectIdentifier": "OBFUSCATED_1089" }, { "subjectId": 1235, "subjectIdentifier": "OBFUSCATED_1229" }, { "subjectId": 1485, "subjectIdentifier": "OBFUSCATED_1479" }, { "subjectId": 1618, "subjectIdentifier": "OBFUSCATED_1612" }, { "subjectId": 10103, "subjectIdentifier": "OBFUSCATED_10097" }, { "subjectId": 11012, "subjectIdentifier": "OBFUSCATED_11006" }, { "subjectId": 11526, "subjectIdentifier": "OBFUSCATED_11520" }, { "subjectId": 11963, "subjectIdentifier": "OBFUSCATED_11957" }, { "subjectId": 12347, "subjectIdentifier": "OBFUSCATED_12341" }, { "subjectId": 12398, "subjectIdentifier": "OBFUSCATED_12392" }, { "subjectId": 34085, "subjectIdentifier": "OBFUSCATED_34079" }, { "subjectId": 34560, "subjectIdentifier": "OBFUSCATED_34554" } ], "count": 12, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/queries/977/data" } ] }