Item Details Endpoint
GET /v3/workspaces/{workspaceId}/itemsThis endpoint now supports the following query parameters:
Return “plain” values (unformatted) for paragraph fields
This functionality allows adding a query parameter to the Item Details GET call to fetch plain text values in the payload, originally entered in Paragraph fields, without formatting HTML tags, and decoded URL-encoded characters. The query parameter is ?paragraph-content=text/plain
Examples:
GET https://tenant_name.autodeskplm360.net/api/v3/workspaces/1/items/1001
Returns:
{
"__self__": "/api/v3/workspaces/1/items/1001/views/1/fields/RTF1",
"urn": "urn:adsk.plm:tenant.workspace.item.view.field:TENANT_NAME.1.1001.1.RTF1",
"title": "RTF1",
"type": {
"link": "/api/v3/field-types/8",
"urn": "urn:adsk.plm:tenant.field-type:TENANT_NAME.8",
"title": "Paragraph",
"deleted": false
},
"value": "Testing HTML <span><b>1+^&#@</b></span>",
"defaultValue": ""
}
GET https://tenant_name.autodeskplm360.net/api/v3/workspaces/1/items/1001?paragraph-content=text/plain
Returns:
{
"__self__": "/api/v3/workspaces/1/items/1001/views/1/fields/RTF1",
"urn": "urn:adsk.plm:tenant.workspace.item.view.field:TENANT_NAME.1.1001.1.RTF1",
"title": "RTF1",
"type": {
"link": "/api/v3/field-types/8",
"urn": "urn:adsk.plm:tenant.field-type:TENANT_NAME.8",
"title": "Paragraph",
"deleted": false
},
"value": "Testing HTML 1+^&#@",
"defaultValue": ""
}Return items that have been modified since a specific date and time
This functionality allows adding a header parameter, If-Modified-Since, with a value containing a date and time, and returning all items in the workspace that have been modified since a particular date. The user performing this GET will only see items they are allowed to – the same privileges and filtering applied to workspace views and search are applied to this GET payload. For a full explanation of the syntax, check the MDN documentation on the standard.
Examples:
GET https://tenant_name.autodeskplm360.net/api/v3/workspaces/1/items/
Header:
If-Modified-Since: Wed, 29 May 2019 07:00:00 GMT
Returns:
{
"__self__": "/api/v3/workspaces/{id}/items?offset=0&limit=10",
"offset": 0,
"limit": 10,
"totalCount": 1,
"first": {
"link": "/api/v3/workspaces/{id}/items?offset=0&limit=10",
"title": "First",
"deleted": false,
"count": 1
},
"last": {
"link": "/api/v3/workspaces/{id}/items?offset=0&limit=10",
"title": "Last",
"deleted": false,
"count": 1
},
"items": [
{
"urn": "urn:adsk.plm:tenant.workspace.item:TENANTNAME.170.7962",
"workspaceShortName": "",
"creator": "John Doe",
"categoryThumbnail": "/images/home/approval_24.png",
"categoryThumbnailSmall": "/images/home/approval_16.png",
"workspaceLongName": "Approval Workspace",
"owner": "Jane Doe",
"category": "Product Development",
"descriptor": "Generic Item – Modified on May 30th, 2019",
"__self__": "/api/v3/workspaces/170/items/7962"
}
]
}Return values of items details in bulk
This functionality allows setting the Accept header parameter to a value application/vnd.autodesk.plm.items.bulk+json when performing a GET against the list of items. This will return the whole item details data for each item in workspace, instead of just the basic information. This can be leveraged by integrations to reduce the number of calls to fetch each item’s details individually. Note: the number of items in the page will be limited to 100. If more than 100 items are available in the workspace, the next page can be fetched by following the links in the payload.
Examples:
GET https://tenant_name.autodeskplm360.net/api/v3/workspaces/9/items/
Header:
Accept: application/vnd.autodesk.plm.items.bulk+json
Returns:
{
"__self__": "/api/v3/workspaces/9/items?offset=0&limit=10",
"offset": 0,
"limit": 10,
"totalCount": 1,
"first": {
"link": "/api/v3/workspaces/9/items?offset=0&limit=10",
"title": "First",
"deleted": false,
"count": 1
},
"last": {
"link": "/api/v3/workspaces/9/items?offset=0&limit=10",
"title": "Last",
"deleted": false,
"count": 1
},
"items": [
{
"__self__": "/api/v3/workspaces/9/items/134615",
"urn": "urn:adsk.plm:tenant.workspace.item:TENANTNAME.9.134615",
"workspace": {
"link": "/api/v3/workspaces/9",
"urn": "urn:adsk.plm:tenant.workspace:TENANTNAME.9",
"title": "Change Orders",
"deleted": false,
"type": "/api/v3/workspace-types/7"
},
"root": {
"link": "/api/v3/workspaces/9/items/134615",
"urn": "urn:adsk.plm:tenant.workspace.item:TENANTNAME.9.134615",
"title": "Some Generic Item - 000001",
"deleted": false
},
"title": "Some Generic Item - 000001",
"deleted": false,
"latestRelease": true,
"workingVersion": true,
"itemLocked": true,
"workflowReference": false,
"workingHasChanged": false,
"currentState": {
"link": "/api/v3/workspaces/9/workflows/1/states/33",
"urn": "urn:adsk.plm:tenant.workspace.workflow.state:TENANTNAME.9.1.33",
"title": "Released",
"deleted": false
},
"lifecycle": {
"link": "/api/v3/workflows/9223372036854775807/states/0",
"urn": "urn:adsk.plm:tenant.workflow.state:TENANTNAME.9223372036854775807.0",
"title": "Unreleased",
"deleted": false
},
"bom": {
"link": "/api/v3/workspaces/9/items/134615/bom",
"deleted": false
},
"nestedBom": {
"link": "/api/v3/workspaces/9/items/134615/bom-items",
"deleted": false,
"count": 0
},
"flatBom": {
"link": "/api/v3/workspaces/9/items/134615/bom-items",
"deleted": false
},
"whereUsed": {
"link": "/api/v3/workspaces/9/items/134615/where-used",
"count": {
"value": 0,
"type": "EXACT"
}
},
"milestones": {
"link": "/api/v3/workspaces/9/items/134615/views/17",
"deleted": false
},
"audit": {
"link": "/api/v3/workspaces/9/items/134615/audit",
"deleted": false
},
"owners": {
"link": "/api/v3/workspaces/9/items/134615/owners",
"deleted": false
},
"sectionsLink": "/api/v3/workspaces/9/items/134615/views/1/sections",
"sections": [
{
"link": "/api/v3/workspaces/9/items/134615/views/1/sections/466",
"title": "Some Section 01",
"sectionLocked": false,
"fields": [
{
"__self__": "/api/v3/workspaces/9/items/134615/views/1/fields/DESCRIPTOR_RESULT",
"urn": "urn:adsk.plm:tenant.workspace.item.view.field:TENANTNAME.9.134615.1.DESCRIPTOR_RESULT",
"title": "descriptor_result",
"type": {
"link": "/api/v3/field-types/4",
"urn": "urn:adsk.plm:tenant.field-type:TENANTNAME.4",
"title": "Single Line Text",
"deleted": false
},
"value": null,
"defaultValue": ""
}
]
}
]
}
]
}