• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Start Free
    Table of contents
    Overview
    Available Events
    Samples
    Changelog
    Forms
    Download API definition:

    API references

    Call
    Request URL
    Title
    Tags
    post
    /forms/{id}/attachments
    Add attachment to form
    Attachments
    post
    /forms/{id}/comments
    Add comment to form
    Comments
    post
    /forms/
    Create form data
    FormData
    delete
    /forms/{id}/attachments/{attachmentId}
    Delete attachment
    Attachments
    delete
    /forms/{id}/comments/{commentId}
    Delete comment
    Comments
    delete
    /forms/{id}
    Delete form data
    FormData
    delete
    /forms/form-definitions/{id}
    Delete form definition
    FormDefinitions
    get
    /forms/{id}/download[?fileType][&includeHeader]
    Download form as file
    Export
    get
    /forms/storage-export[?ids][&includeHeader][&fileType][&folderId]
    Export forms to Storage
    Export
    get
    /forms/{id}/attachments/{attachmentId}
    Get attachment file by ID
    Attachments
    get
    /forms/{id}/audit-trail-entries
    Get audit trail for form data
    AuditTrail
    get
    /forms/{id}/attachments
    Get form data attachments
    Attachments
    get
    /forms/{id}/comments
    Get form data comments
    Comments
    get
    /forms/{id}
    Get form data details
    FormData
    get
    /forms/form-definitions/{id}
    Get form definition by ID
    FormDefinitions
    get
    /forms/[?iTwinId][&$top][&continuationToken][&type][&state][&discipline]
    Get iTwin form data
    FormData
    get
    /forms/form-definitions[?iTwinId][&type][&search][&status][&discipline]
    Get iTwin form definitions
    FormDefinitions
    get
    /forms/itwins/{iTwinId}/list-groups[?search]
    Get iTwin list groups
    FormDefinitions
    get
    /forms/form-definitions/{id}/list-groups/{listGroupId}
    Get list group
    FormDefinitions
    get
    /forms/form-definitions/{id}/static-images/{fileId}
    Get static image
    FormDefinitions
    get
    /forms/templates[?type][&discipline]
    Get templates
    FormDefinitions
    get
    /forms/workflows/{type}[?iTwinId][&discipline]
    Get workflow
    Workflow
    post
    /forms/form-definitions/import
    Import form definition from another iTwin
    FormDefinitions
    post
    /forms/templates/import
    Import template
    FormDefinitions
    patch
    /forms/{id}
    Update form data
    FormData
    patch
    /forms/form-definitions/{id}
    Update form definition metadata
    FormDefinitions
    put
    /forms/{id}/attachments/{attachmentId}
    Upload attachment file
    Attachments
    put
    /forms/itwins/{iTwinId}/list-groups/{id}
    Upload list group file
    FormDefinitions

    Was this page helpful?