Request

Response

    Items
    PATCH

    projects/:project_id/items/:item_id

    Updates the properties of the given item_id object. Note that updating the displayName of an item is not supported for BIM 360 Docs or ACC items. Instead, use the POST projects/:project_id/versions endpoint.

    New! Autodesk Construction Cloud platform (ACC). Note that this endpoint is compatible with ACC projects. For more information about the Autodesk Construction Cloud APIs, see the Autodesk Construction Cloud documentation.

    Resource Information
    Method and URI
    PATCH
     https://developer.api.autodesk.com/data/v1/projects/:project_id/items/:item_id
    Authentication Context
    user context optional
    Required OAuth Scopes
    data:write
    Data Format
    JSON

    Request

    Headers
    Authorization*
    string
    		Must be Bearer <token>, where <token> is obtained via either a two-legged or three-legged OAuth flow.
    Content-Type*
    string
    		Must be application/vnd.api+json
    x-user-id
    string
    		In a two-legged authentication context, the app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act on behalf of only the user specified.
    * Required

    Request

    URI Parameters
    project_id
    string
    		The unique identifier of a project.

    For BIM 360 Docs, the project ID in the Data Management API corresponds to the project ID in the BIM 360 API. To convert a project ID in the BIM 360 API into a project ID in the Data Management API you need to add a “b." prefix. For example, a project ID of c8b0c73d-3ae9 translates to a project ID of b.c8b0c73d-3ae9.

    item_id
    string
    		The unique identifier of an item.

    Request

    Body Structure

    describe the item to be patched.

    Expand all
    jsonapi*
    object
    		The JSON API object.
    version*
    enum:string
    		The version of JSON API. Will always be: 1.0
    data*
    object
    		The data object.
    type*
    enum:string
    		The type of this resource. Will always be: items
    id*
    string
    		The id of the resource.
    attributes
    object
    		Attributes of the item.
    * Required

    Response

    HTTP Status Code Summary
    200
    OK
    		Successful update of a specific item’s properties.
    400
    Bad Request
    		The request could not be understood by the server due to malformed syntax or missing request headers. The client SHOULD NOT repeat the request without modifications. The response body may give an indication of what is wrong with the request.
    403
    Forbidden
    		The request was successfully validated but permission is not granted or the application has not been white-listed. Do not try again unless you solve permissions first.
    404
    Not Found
    		The specified resource was not found.
    423
    Locked
    		The source or destination resource is locked or being modifed.

    Response

    Body Structure (200)
    Expand all
    jsonapi
    object
    		The JSON API object.
    version
    enum:string
    		The version of JSON API. Will always be: 1.0
    links
    object
    		Information on links to this resource.
    self
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		The object containing information on the item.
    type
    enum:string
    		The type of this resource. Will always be: items
    id
    string
    		The unique identifier of the item.
    attributes
    object
    		Attributes of the latest version of an item.
    displayName
    string
    		Displayable name of an item. Note that for BIM 360 projects, this field is reserved for future releases and should not be used. Use version’s attributes.name for the file name.
    createTime
    datetime: ISO 8601
    		The time the item was created, in the following format: YYYY-MM-DDThh:mm:ss.sz.
    createUserId
    string
    		The unique identifier of the user who created the item.
    createUserName
    string
    		The name of the user who created the item.
    lastModifiedTime
    datetime: ISO 8601
    		The last time the item was modified, in the following format: YYYY-MM-DDThh:mm:ss.sz.
    lastModifiedUserId
    string
    		The unique identifier of the user who last modified the item.
    lastModifiedUserName
    string
    		The name of the user who last modified the item.
    hidden
    boolean
    		true if the file has been deleted. false if the file has not been deleted.
    reserved
    boolean
    		true if the file has been locked.``false`` if the file has not been locked. Note that you can lock BIM 360 Project Files folder files and A360 files, but you cannot lock BIM 360 Plans Folder files.
    reservedTime
    datetime: ISO 8601
    		The time the item was reserved.
    reservedUserId
    string
    		The unique identifier of the user who reserved the item.
    reservedUserName
    string
    		The name of the user who reserved the item.
    extension
    object
    		The extension object of the data.
    type
    string
    		The type of the schema that the resource’s data object adheres to.
    version
    string
    		The version of the schema that the data is adhering to.
    schema
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		Additional properties that the resource’s data possesses.
    relationships
    object
    		Information on other resources that shares a relationship with this item.
    parent
    object
    		Information on resources that are found above this resource.
    links
    object
    		The object containing information on links of related resources.
    related
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		An object containing the id and type properties of a resource.
    id
    string
    		The id of the resource.
    type
    string
    		The type of this resource.
    tip
    object
    		Information on resources that are found above this resource.
    links
    object
    		The object containing information on links of related resources.
    related
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		An object containing the id and type properties of a resource.
    id
    string
    		The id of the resource.
    type
    string
    		The type of this resource.
    versions
    object
    		Information on resources that are found under this resource.
    links
    object
    		The object containing information on links of related resources.
    related
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    refs
    object
    		Information on other resources that shares a custom relationship with this resource.
    links
    object
    		The object containing information on links of related resources that shares a custom relationship with this resource.
    self
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    related
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    links
    object
    		Information on the link resources found in this resource.
    links
    object
    		The object containing information on links to this resource.
    self
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    links
    object
    		Information on links to this resource.
    self
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    webView
    object
    		An object containing a link that opens the resource in a browser.
    href
    string
    		The location (URL) of the resource the link goes to.
    included
    array: object
    		The other resources included within this item.
    type
    enum:string
    		The type of this resource. Will always be: versions
    id
    string
    		The id of the resource.
    attributes
    object
    		The attributes of the resource.
    name
    string
    		The filename used when synced to local disk.
    displayName
    string
    		Displayable name of the version. Note that for BIM 360 projects, this field is reserved for future releases and should not be used. Use version’s attributes.name for the file name.
    versionNumber
    int
    		Version number of this versioned file.
    mimeType
    string
    		Mimetype of the version’s content.
    fileType
    string
    		File type, only present if this version represents a file.
    storageSize
    int
    		File size in bytes, only present if this version represents a file.
    createTime
    datetime: ISO 8601
    		The time that the resource was created at.
    createUserId
    string
    		The userId that created the resource.
    createUserName
    string
    		The username that created the resource.
    lastModifiedTime
    datetime: ISO 8601
    		The time that the resource was last modifed.
    lastModifiedUserId
    string
    		The userId that last modified the resource.
    lastModifiedUserName
    string
    		The username that last modified the resource.
    extension
    object
    		The extension object of the data.
    type
    string
    		The type of the schema that the resource’s data object adheres to.
    version
    string
    		The version of the schema that the data is adhering to.
    schema
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		Additional properties that the resource’s data possesses.
    conformingStatus
    enum:string
    		A status indicating whether or not this version conforms to its parent folder’s file naming standard.

    Possible values:

    • NONE: The conforming status is not applicable for the version.
    • CONFORMING: The version conforms to its parent folder’s file naming standard.
    • NON_CONFORMING: The version does not conform to its parent folder’s file naming standard.

    In the event of a NON_CONFORMING status, call GET folders/folder_id to get the file naming standards IDs that have been applied to the version’s parent folder, and then use the ID to call GET naming-standards to get the details of the file naming standard.

    Note that this feature is only available for BIM 360 projects.

    To learn more about the file naming standard feature, see the BIM 360 File Naming Standard help documentation.

    relationships
    object
    		Information on other resources that shares a relationship with this resource.
    item
    object
    		Information on resources that are found above this resource.
    links
    object
    		The object containing information on links of related resources.
    related
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		An object containing the id and type properties of a resource.
    id
    string
    		The id of the resource.
    type
    string
    		The type of this resource.
    refs
    object
    		Information on other resources that shares a custom relationship with this resource.
    links
    object
    		The object containing information on links of related resources that shares a custom relationship with this resource.
    self
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    related
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    links
    object
    		Information on the link resources found in this resource.
    links
    object
    		The object containing information on links to this resource.
    self
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    storage
    object
    		Information on resources that are indirectly related to this resource.
    meta
    object
    		Meta-information on links to this resource.
    link
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		An object containing the id and type properties of a resource.
    id
    string
    		The id of the resource.
    type
    string
    		The type of this resource.
    derivatives
    object
    		Information on resources that are indirectly related to this resource.
    meta
    object
    		Meta-information on links to this resource.
    link
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		An object containing the id and type properties of a resource.
    id
    string
    		The id of the resource.
    type
    string
    		The type of this resource.
    thumbnails
    object
    		Information on resources that are indirectly related to this resource.
    meta
    object
    		Meta-information on links to this resource.
    link
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    data
    object
    		An object containing the id and type properties of a resource.
    id
    string
    		The id of the resource.
    type
    string
    		The type of this resource.
    downloadFormats
    object
    		Information on resources that are found under this resource.
    links
    object
    		The object containing information on links of related resources.
    related
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    links
    object
    		Information on links to this resource.
    self
    object
    		An object containing an API link property.
    href
    string
    		A hyperlink reference to this resource.
    webView
    object
    		An object containing a link that opens the resource in a browser.
    href
    string
    		The location (URL) of the resource the link goes to.

    Example

    Successful update of a specific item’s properties.

    Request

    curl -v 'https://developer.api.autodesk.com/data/v1/projects/:project_id/items/:item_id' \
  -X 'PATCH' \
  -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
        "jsonapi": {
          "version": "1.0"
        },
        "data": {
          "type": "items",
          "id": "urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ",
          "attributes": {
            "displayName": "new name for drawing.dwg"
          }
        }
      }'
    Show More

    Response

    {
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": {
      "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ"
    }
  },
  "data": {
    "type": "items",
    "id": "urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ",
    "attributes": {
      "displayName": "new name for drawing.dwg",
      "extension": {
        "data": {},
        "version": "1.0",
        "type": "items:autodesk.core:File",
        "schema": {
          "href": "https://developer.api.autodesk.com/schema/v1/versions/items:autodesk.core:File-1.0"
        }
      },
      "createUserId": "BW9RM76WZBGL",
      "createUserName": "John Doe",
      "lastModifiedUserId": "BW9RM76WZBGL",
      "lastModifiedUserName": "John Doe",
      "lastModifiedTime": "2015-11-27T11:11:27.000Z",
      "createTime": "2015-11-27T11:11:23.000Z",
      "hidden": false,
      "reserved": true,
      "reservedTime": "2015-11-27T11:11:25.000Z",
      "reservedUserId": "BW9RM76WZBGL",
      "reservedUserName": "John Doe"
    },
    "relationships": {
      "tip": {
        "data": {
          "type": "versions",
          "id": "urn:adsk.wipprod:fs.file:vf.AeYgDtcTSuqYoyMweWFhhQ?version=1"
        },
        "links": {
          "related": {
            "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ/tip"
          }
        }
      },
      "parent": {
        "data": {
          "type": "folders",
          "id": "urn:adsk.wipprod:fs.folder:co.sdfedf8wefl"
        },
        "links": {
          "related": {
            "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ/parent"
          }
        }
      },
      "versions": {
        "links": {
          "related": {
            "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ/versions"
          }
        }
      },
      "refs": {
        "links": {
          "self": {
            "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ/relationships/refs"
          },
          "related": {
            "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ/refs"
          }
        }
      },
      "links": {
        "links": {
          "self": {
            "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ/relationships/links"
          }
        }
      }
    },
    "links": {
      "self": {
        "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/items/urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ"
      }
    }
  },
  "included": [
    {
      "type": "versions",
      "id": "urn:adsk.wipprod:fs.file:vf.AeYgDtcTSuqYoyMweWFhhQ?version=1",
      "attributes": {
        "name": "testFile.dwg",
        "displayName": "testFile.dwg",
        "createTime": "2016-04-01T11:09:03.000Z",
        "createUserId": "BW9RM76WZBGL",
        "createUserName": "John Doe",
        "lastModifiedTime": "2016-04-01T11:11:18.000Z",
        "lastModifiedUserId": "BW9RM76WZBGL",
        "lastModifiedUserName": "John Doe",
        "versionNumber": 1,
        "mimeType": "application/vnd.autodesk.autocad.dwg",
        "storageSize": 35696,
        "fileType": "dwg",
        "extension": {
          "type": "versions:autodesk.core:File",
          "version": "1.0",
          "schema": {
            "href": "https://developer.api.autodesk.com/schema/v1/versions/versions:autodesk.core:File-1.0"
          },
          "data": {}
        }
      },
      "links": {
        "self": {
          "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/versions/urn:adsk.wipprod:fs.file:vf.AeYgDtcTSuqYoyMweWFhhQ%3Fversion=1"
        }
      },
      "relationships": {
        "item": {
          "links": {
            "related": {
              "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/versions/urn:adsk.wipprod:fs.file:vf.AeYgDtcTSuqYoyMweWFhhQ%3Fversion=1/item"
            }
          },
          "data": {
            "type": "items",
            "id": "urn:adsk.wipprod:dm.lineage:AeYgDtcTSuqYoyMweWFhhQ"
          }
        },
        "refs": {
          "links": {
            "self": {
              "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/versions/urn:adsk.wipprod:fs.file:vf.AeYgDtcTSuqYoyMweWFhhQ%3Fversion=1/relationships/refs"
            },
            "related": {
              "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/versions/urn:adsk.wipprod:fs.file:vf.AeYgDtcTSuqYoyMweWFhhQ%3Fversion=1/refs"
            }
          }
        },
        "links": {
          "links": {
            "self": {
              "href": "https://developer.api.autodesk.com/data/v1/projects/a.YnVzaW5lc3M6YXV0b2Rlc2swMDEjMjAyNDA0MTEwMTAxMDEw/versions/urn:adsk.wipprod:fs.file:vf.AeYgDtcTSuqYoyMweWFhhQ%3Fversion=1/relationships/links"
            }
          },
          "storage": {
            "meta": {
              "link": {
                "href": "https://developer.api.autodesk.com/oss/v2/buckets/wip.dm.prod/objects/44f771a1-3b11-4ff1-b6d7-5b4719481c93.dwg?scopes=global"
              }
            },
            "data": {
              "type": "objects",
              "id": "urn:adsk.objects:os.object:wip.dm.prod/44f771a1-3b11-4ff1-b6d7-5b4719481c93.dwg"
            }
          }
        }
      }
    }
  ]
}
    Show More