Fetching all Plans for your Organization
Below is the query to fetch all the plans, with their name, geometry, location and the date they were created. Since this is a paged API you also need to fetch the pageInfo, see Pagination for more details.
query GetPlans{
viewer{
organization{
plans(first:50){
pageInfo{
hasNextPage
endCursor
}
edges{
cursor
node{
name
geometry{
lat
lng
}
location {
lat
lng
}
dateCreation
}
}
}
}
}
}
You can try this query out yourself using the API explorer here.
The top level query viewer
is the context for the currently logged in user. From this you fetch the organization
object and the first 50 of the plans associated with that. If you have less than 50 plans you are done. If you have more example you will get a response like this.
{
"data": {
"viewer": {
"organization": {
"plans": {
"pageInfo": {
"hasNextPage": true,
"endCursor": "YXJyYXljb25uZWN0aW9uOjI="
},
"edges": [
... // Data removed for the sake of brevity
]
}
}
}
}
}
As you can see in the pageInfo
section hasNextPage
is True so you know you need to fetch the next page of data. To do this simply modify your query to set the after
paging parameter to the endCursor
from the pageInfo
:
query GetPlans{
viewer{
organization{
plans(first:50, after:"YXJyYXljb25uZWN0aW9uOjI="){
pageInfo{
hasNextPage
endCursor
}
edges{
cursor
node{
name
geometry{
lat
lng
}
location {
lat
lng
}
dateCreation
}
}
}
}
}
}
More Detail
If you look through the schema the plans
query returns type Plan
. This is an interface for the common fields across all types of plans. There are more specific types of Plans, specifically MapPlan
which includes more data such as exports. To fetch these extra fields you need to use an Inline Fragment.
query GetPlans{
viewer{
organization{
plans(first:50){
edges{
node{
id
name
... on MapPlan{
status
}
}
}
pageInfo{
hasNextPage
endCursor
}
}
}
}
}
This specifies that you are looking for the id
and name
of all plans, but for objects of type MapPlan
you want the status
of the processing as well.