Queries
projects
Retrieves all projects that match the specified filter criteria from a specified hub.
Template for Query:
query GetProjects($hubId: ID!, $filter: ProjectFilterInput, $pagination: PaginationInput) {
projects(hubId: $hubId, filter: $filter, pagination: $pagination) {
# Projects Fields
}
}
Template for Query Variables:
{
"hubId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
"filter" : "<SOME-PROJECTFILTER-INPUT-TYPE-VALUE>",
"pagination" : "<SOME-PAGINATION-INPUT-TYPE-VALUE>"
}
Arguments
hubId* ID! non-null | The ID of the hub that contains the projects. |
filter | Specifies how to filter a list of projects. You can filter by ID or by name. |
pagination | Specifies how to split the response into multiple pages. |
* Required
Possible Returns
Value Type | Description |
---|---|
Projects! non-null |
Contains a list of projects returned in response to a query. |
Examples
Example 1
Retrieves all projects in a hub by ID.
Query:
query GetProjects($hubId: ID!) {
projects(hubId: $hubId) {
results {
id
name
}
}
}
Show More
Query Variables:
{
"hubId":"b.768cae14-76b3-4531-9030-25212dab4e48"
}
Response:
{
"data": {
"projects": {
"results": [
{
"id": "cHJvan5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZg",
"name": "DataExchange-Graph"
},
{
"id": "cHJvan5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjViYWI0YWUzLTRjM2QtNDMxYi05NWQzLWViMjJlOGU1MDg5NA",
"name": "Data Exchanges"
}
]
}
}
}
Show More