Request

Response

    Projects
    GET

    projects/{projectId}/nda

    Retrieves the NDA file attachment for the specified project.

    When the NDA file is quarantined after a malware scan in cloud storage, this endpoint returns HTTP 200 with signedUrl set to null and fileStatus set to QUARANTINED so clients can surface messaging without treating the response as a hard failure. When the file is available for download, signedUrl is a short-lived URL and fileStatus is AVAILABLE.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/construction/buildingconnected/v3/projects/{projectId}/nda
    Authentication Context
    User context required
    Required OAuth Scopes
    data:read
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.

    The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    * Required

    Request

    URI Parameters

    projectId
    string
    The ID of a BuildingConnected project.

    Response

    HTTP Status Code Summary

    200
    OK
    OK
    400
    Bad Request
    The parameters of the requested operation are invalid.
    401
    Unauthorized
    The provided bearer token is not valid.
    403
    Forbidden
    The user or service represented by the bearer token does not have permission to perform this operation.
    404
    Not Found
    The requested resource could not be found.
    429
    Too Many Requests
    Rate limit exceeded; wait some time before retrying. The ‘Retry-After’ header might provide the amount of the time to wait.
    500
    Internal Server Error
    An unknown error occurred on the server.

    Response

    Body Structure (200)

    id
    string
    The unique ID of the attachment.

    Max length: 24

    name
    string
    The name of the attachment.
    signedUrl
    string
    A short-lived signed URL for downloading the attachment.

    The signed URL returned by this endpoint will expire after 2 minutes. You must begin the download before the URL expires, but the subsequent data transfer can take much longer.

    This field is null when fileStatus is QUARANTINED (the file is not available for download).

    fileStatus
    enum:string
    Whether the attachment file is available for download or quarantined after malware scanning.

    Possible values:

    • AVAILABLE: The file passed scanning; signedUrl is a non-null download URL.
    • QUARANTINED: The file did not pass scanning; signedUrl is null.

    Example

    OK

    Request

    curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v3/projects/:projectId/nda' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "id": "5d1ca35b3935dc00a8b18d79",
      "name": "filename.pdf",
      "signedUrl": "https://example.url/filename",
      "fileStatus": "AVAILABLE"
    }