Queries
projectByDataManagementAPIId
Retrieves an object representing a project by its external id.
A project is a shared workspace for teams of people to store, organize, and manage all related design data.
Template for Query:
query GetProjectByDataManagementAPIId($dataManagementAPIProjectId: ID!) {
projectByDataManagementAPIId(dataManagementAPIProjectId: $dataManagementAPIProjectId) {
# ProjectByDataManagementAPIId Fields
}
}
Template for Query Variables:
{
"dataManagementAPIProjectId" : "<SOME-ID-TYPE-SCALAR-VALUE>"
}
Arguments
dataManagementAPIProjectId* ID! non-null | The external 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 entity data. |
Examples
Example 1
Retrieves a project by legacy dataManagement API Project ID
Query:
query GetProject($dataManagementAPIProjectId: ID!) {
projectByDataManagementAPIId(
dataManagementAPIProjectId: $dataManagementAPIProjectId
) {
id
name
alternativeIdentifiers {
dataManagementAPIProjectId
}
}
}
Show More
Query Variables:
{
"dataManagementAPIProjectId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE"
}
Response:
{
"data": {
"projectByDataManagementAPIId": {
"id": "urn:adsk.workspace:beta.project:e7cc7e8d-5246-4800-b07e-97eee2a0aa07",
"name": "DOCS_STG",
"alternativeIdentifiers": {
"dataManagementAPIProjectId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE"
}
}
}
}
Show More