Queries
project
Retrieves an object representing a project from a specified hub.
A project is a shared workspace for teams of people to store, organize, and manage all related design data.
Template for Query:
query GetProject($projectId: ID!) {
project(projectId: $projectId) {
# Project Fields
}
}
Template for Query Variables:
{
"projectId" : "<SOME-ID-TYPE-SCALAR-VALUE>"
}
Arguments
projectId* ID! non-null | The ID of the project to retrieve. |
* Required
Possible Returns
Value Type | Description |
---|---|
Project | Represents a project. A project is a shared workspace for teams of people working together on a project, to store, organize, and manage all related exchange data. |
Examples
Example 1
Retrieves a project by ID along with all top folders.
Query:
query GetProject($projectId: ID!){
project(projectId: $projectId){
id
name
folders{
results{
id
name
objectCount
}
}
}
}
Show More
Query Variables:
{
"projectId": "cHJvan5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZg"
}
Response:
{
"data": {
"project": {
"id": "cHJvan5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZg",
"name": "DataExchange-Graph",
"folders": {
"results": [
{
"id": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby40U0F5Z29SSFNjZUllVUlySVMtSUxB",
"name": "Project Files",
"objectCount": 7
}
]
}
}
}
}
Show More