GET api/dataQRelationships?name={name}&code={code}&page={page}&pagesize={pagesize}
Gets a collection of entities from dataQ
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| name |
Name of related entity |
string |
None. |
| code |
Code to use to filter related entities |
string |
None. |
| page |
Page index of results to return (optional, default is 1) |
integer |
Default value is 1 |
| pagesize |
The number of data q providers to return per page (optional, 10 by default, max 50) |
integer |
Default value is 10 |
Body Parameters
None.
Response Information
Resource Description
A paged collection of entities from dataQ
PagedResultModelOfDataQRelationshipModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNumber | integer |
None. |
|
| PageCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| Items | Collection of DataQRelationshipModel |
None. |
|
| TotalRecordCount | integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
Sample:
{
"pageNumber": 1,
"pageCount": 2,
"pageSize": 3,
"items": [
{
"dataQRelationshipID": "sample string 1",
"code": "sample string 2",
"type": "sample string 3",
"relationshipTypeDescription": "sample string 4",
"name": "sample string 5",
"parentOrganizationID": "sample string 6",
"parentOrganizationName": "sample string 7"
},
{
"dataQRelationshipID": "sample string 1",
"code": "sample string 2",
"type": "sample string 3",
"relationshipTypeDescription": "sample string 4",
"name": "sample string 5",
"parentOrganizationID": "sample string 6",
"parentOrganizationName": "sample string 7"
}
],
"totalRecordCount": 4
}