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. |
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 entity data. |
Examples
Example 1
Retrieves a project by ID along with the hub it belongs to and the items in that project by folder.
Query:
query GetProject($projectId: ID!) {
project(projectId: $projectId) {
id
name
hub {
id
name
}
alternativeIdentifiers{
dataManagementAPIProjectId
}
folders {
results {
id
name
objectCount
items {
results {
id
name
__typename
}
}
}
}
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:e7cc7e8d-5246-4800-b07e-97eee2a0aa07"
}
Response:
{
"data": {
"project": {
"id": "urn:adsk.workspace:beta.project:e7cc7e8d-5246-4800-b07e-97eee2a0aa07",
"name": "DOCS_STG",
"hub": {
"id": "urn:adsk.ace:beta.scope:e7c7f5a9-a88a-40b4-85f6-ba1454def997",
"name": "stg-hds-test-hub"
},
"alternativeIdentifiers": {
"dataManagementAPIProjectId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE"
},
"folders": {
"results": [
{
"id": "urn:adsk.wipstg:fs.folder:co.75-EpQPXQ_ynLYL0bOxSIg",
"name": "extensibility",
"objectCount": 5,
"items": {
"results": [
{
"id": "urn:adsk.wipstg:dm.lineage:amvR65KFRouqbo47ye6bhw",
"name": "Hydraulic_Bottle_Jack",
"__typename": "DesignItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:dw4qLiUzT6So5K6B2OPhcQ",
"name": "Gas Pedal",
"__typename": "DesignItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:jYI275ltT0eiyF99nrQcyw",
"name": "Connector Joint Drawing",
"__typename": "DrawingItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:v99UgOsFT-OpfjHjs1ZtiA",
"name": "Connecting Rod Assembly",
"__typename": "DesignItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:zO8C8RUiTOOTITKo2pzG1Q",
"name": "Connector Joint",
"__typename": "DesignItem"
}
]
}
},
{
"id": "urn:adsk.wipstg:fs.folder:co.JqPba6NRT5-of8Eu7tpuXQ",
"name": "queries",
"objectCount": 7,
"items": {
"results": [
{
"id": "urn:adsk.wipstg:dm.lineage:2T9wT3rFSZW0SJkfo139PQ",
"name": "3D_Arm_Scan",
"__typename": "DesignItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:S4bzROmAQfeAe4YQCPK_jw",
"name": "Piston Linkage",
"__typename": "DesignItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:hauI21OwSb2dO5Aq-CL-Ag",
"name": "Bearing_Bracket",
"__typename": "DesignItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:iqfetvZhS-SbytPyge6s-w",
"name": "ALCOA Bracket",
"__typename": "DesignItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:xg_7JjcHRvqHQuSuCBiykQ",
"name": "3D_Arm_Scan Drawing",
"__typename": "DrawingItem"
},
{
"id": "urn:adsk.wipstg:dm.lineage:zwJH00uUTcKHVXTox_uzBA",
"name": "Drawings Utility Knife",
"__typename": "DesignItem"
}
]
}
}
]
}
}
}
}
Example 2
Retrieves a project by ID along with its members.
Query:
query GetProject($projectId: ID!, $pagination: PaginationInput) {
project(projectId: $projectId) {
name
id
__typename
legacyProjectMembers(pagination: $pagination) {
results {
user {
id
firstName
}
}
pagination {
cursor
pageSize
}
}
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:a69a9462-c5a1-4525-927a-e6d088573529",
"pagination": {
"cursor": "MH41"
}
}
Response:
{
"data": {
"project": {
"name": "FT_DOCS_PROJECT_STG",
"id": "urn:adsk.workspace:beta.project:a69a9462-c5a1-4525-927a-e6d088573529",
"__typename": "Project",
"legacyProjectMembers": {
"results": [
{
"user": {
"id": "MHL2DTVKNTQ27PJE",
"firstName": "Chetan"
}
},
{
"user": {
"id": "KFR256Q8QHU6AYXC",
"firstName": "Shubham"
}
},
{
"user": {
"id": "P7V2X8JRNJ8C7TYQ",
"firstName": "Rishabh"
}
}
],
"pagination": {
"cursor": null,
"pageSize": 3
}
}
}
}
}
Example 3
Retrieves the thumbnail Url of project
Query:
query Project($projectId: ID!) {
project(projectId: $projectId) {
id
name
thumbnailUrl
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
}
Response:
{
"data": {
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4",
"name": "GRAPHQL-FUNCTIONAL-TESTS",
"thumbnailUrl": "https://static.staging.autodesk360.com/static/10.17.0.cac5315718/communities/images/logos/biggerThumb/defaultProjectImage_01.png"
}
}
}
Example 4
Retrieves the current role of a legacy project member.
Query:
query project($projectId: ID!) {
project(projectId: $projectId) {
id
name
legacyProjectMembers {
results {
project {
id
}
role
user {
email
id
}
}
}
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
}
Response:
{
"data": {
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4",
"name": "GRAPHQL-FUNCTIONAL-TESTS",
"legacyProjectMembers": {
"results": [
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "PROJECT_ADMIN",
"user": {
"email": "demo.docs@yopmail.com",
"id": "MHL2DTVKNTQ27PJE"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "B4PJ8ZH8KBCUSWJN"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "T6722GRGLGQWE6VX"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "forgedata_service_and_test_users+graphql-hds-stg@ssttest.net",
"id": "LCXJJMMEKLKVBVTV"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "5DLJPBX2NL87E5WS"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "MRJJXC4HNJFS2Y8W"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "JY826YZANWTY7WBM"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "DTM2U955RCWPB44Q"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "HQSVRXME3XPD"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "VXBAL5H7DN96"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "UJH2V37MQLP7CGY7"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "ZBDTN3YZTEHE"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "KYWHNDN3BLK3"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "QVWPMXG9RSBY"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "YSA2NWHCQF7KSPPD"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "P27JZBT4KHYYMGNS"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "KFR256Q8QHU6AYXC"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "P7V2X8JRNJ8C7TYQ"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "SR2GNSE66V3K"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "cygnusstgtesthubrole@yopmail.com",
"id": "VWY2B7FJMG96EZTN"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "ftchangeprojectuserrole@yopmail.com",
"id": "XDGJ3WLMKBPMQ8FU"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "ftchangehubuserrole@yopmail.com",
"id": "5KE2V99KK7VTVT5C"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "QW8JLLNWP3U56QDR"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "MUEJ3GXEMB69H95U"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "NZ2XQVA9DQKY"
}
},
{
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
},
"role": "EDITOR",
"user": {
"email": "demo.docs@yopmail.com",
"id": "2E92YYMBQRSDYBU7"
}
}
]
}
}
}
}
Example 5
Retrieves the Fusion web URL that will redirect to the Fusion web.
Query:
query Project($projectId: ID!) {
project(projectId: $projectId) {
id
name
fusionWebUrl
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4"
}
Response:
{
"data": {
"project": {
"id": "urn:adsk.workspace:beta.project:3ee82b7c-6533-4d5c-aa1e-7c48793d79c4",
"name": "GRAPHQL-FUNCTIONAL-TESTS",
"fusionWebUrl": "https://autodesk2398.staging.autodesk360.com/portal/groups/2024032872200626/home/GRAPHQL-FUNCTIONAL-TESTS"
}
}
}
Example 6
Retrieves members of a folder level project.
Query:
query project($projectId: ID!) {
project(projectId: $projectId) {
id
name
folderLevelProjectMembers {
results {
user {
email
firstName
}
role
status
}
}
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08"
}
Response:
{
"data": {
"project": {
"id": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08",
"name": "FLP Project",
"folderLevelProjectMembers": {
"results": [
{
"user": {
"email": "demo.docs@yopmail.com",
"firstName": "Chetan"
},
"role": "ADMINISTRATOR",
"status": "ACTIVE"
}
]
}
}
}
}
Example 7
FIlter members of a folder level project member by name.
Query:
query project($projectId: ID!) {
project(projectId: $projectId) {
id
name
folderLevelProjectMembers(filter:{ name: "shubham" }) {
results {
user {
email
firstName
}
role
status
}
}
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08"
}
Response:
{
"data": {
"project": {
"id": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08",
"name": "FLP Project",
"folderLevelProjectMembers": {
"results": [
{
"user": {
"email": "demo.docs@yopmail.com",
"firstName": "Shubham"
},
"role": "ADMINISTRATOR",
"status": "ACTIVE"
}
]
}
}
}
}
Example 8
Retrieves a project by ID along with its groups.
Query:
query GetProject($projectId: ID!, $pagination: PaginationInput) {
project(projectId: $projectId) {
name
id
__typename
groups(pagination: $pagination) {
results {
id
name
role
}
pagination {
cursor
pageSize
}
}
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08",
"pagination": {
"cursor": "MH41"
}
}
Response:
{
"data": {
"project": {
"name": "FLP Project",
"id": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08",
"__typename": "Project",
"groups": {
"results": [
{
"id": "110434919",
"name": "admins",
"role": "ADMINISTRATOR"
},
{
"id": "173816631",
"name": "DocGroup1725880690106",
"role": "MANAGER"
}
],
"pagination": {
"cursor": null,
"pageSize": 2
}
}
}
}
}
Example 9
Retrieves role of groups in project.
Query:
query GetProject($projectId: ID!, $pagination: PaginationInput) {
project(projectId: $projectId) {
name
id
__typename
groups(pagination: $pagination) {
results {
id
name
role
}
pagination {
cursor
pageSize
}
}
}
}
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08",
"pagination": {
"cursor": "MH41"
}
}
Response:
{
"data": {
"project": {
"name": "FLP Project",
"id": "urn:adsk.workspace:beta.project:08570370-984f-4d59-b722-ecc3de7d8c08",
"__typename": "Project",
"groups": {
"results": [
{
"id": "110434919",
"name": "admins",
"role": "ADMINISTRATOR"
},
{
"id": "173816631",
"name": "DocGroup1725880690106",
"role": "MANAGER"
}
],
"pagination": {
"cursor": null,
"pageSize": 2
}
}
}
}
}