Queries
item
Retrieves an object representing an item.
An item refers to a file or sub-folder that exists within a folder.
Template for Query:
query GetItem($projectId: String!, $itemId: String!) {
item(projectId: $projectId, itemId: $itemId) {
# Item Fields
}
}
Template for Query Variables:
{
"projectId" : "<SOME-STRING-TYPE-SCALAR-VALUE>",
"itemId" : "<SOME-STRING-TYPE-SCALAR-VALUE>"
}
Arguments
| projectId* String! non-null | The ID of the project that contains the item. |
| itemId* String! non-null | The ID of the item to retrieve. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
| Item | Represents an Item. An item refers to a file or sub-folder that exists within a folder. |
Example
Example 1
This example retrieves an item by its ID and displays its name.
Query:
query Getltem($projectId: String!, $itemId: String!) {
item(projectId: $projectId, itemId: $itemId) {
name
}
}
Query Variables:
{
"projectId": "a.YnVzaW5lc3M6YXV0bZRlcZsyMDAZI0QyMDIxMTIwNzQ5ODUlNTY5",
"itemId": "urn:adsk.wipstg:dm.lineage:iXZvqClST7ZtSZXGNtuLEg"
}
Response:
"data": {
"item": {
"name": "End Cap"
}
}
