• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Free Trial
    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/formDefinitions/{id}
    Delete form definition
    FormDefinitions
    GET
    /forms/{id}/download[?fileType][&includeHeader]
    Download form as file
    Export
    GET
    /forms/storageExport?ids[&includeHeader][&fileType][&folderId]
    Export forms to Storage
    Export
    GET
    /forms/{id}/attachments/{attachmentId}
    Get attachment file by ID
    Attachments
    GET
    /forms/{id}/auditTrailEntries
    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/formDefinitions/{id}
    Get form definition by ID
    FormDefinitions
    GET
    /forms/?iTwinId[&$top][&continuationToken][&type][&state]
    Get iTwin form data
    FormData
    GET
    /forms/formDefinitions?iTwinId[&type][&search][&status]
    Get iTwin form definitions
    FormDefinitions
    GET
    /forms/iTwins/{iTwinId}/listGroups[?search]
    Get iTwin list groups
    FormDefinitions
    GET
    /forms/formDefinitions/{id}/listGroups/{listGroupId}
    Get list group
    FormDefinitions
    GET
    /forms/formDefinitions/{id}/staticImages/{fileId}
    Get static image
    FormDefinitions
    GET
    /forms/templates[?type]
    Get templates
    FormDefinitions
    GET
    /forms/workflows/{type}?iTwinId
    Get workflow
    Workflow
    POST
    /forms/formDefinitions/import
    Import form definition from another iTwin
    FormDefinitions
    POST
    /forms/templates/import
    Import template
    FormDefinitions
    PATCH
    /forms/{id}
    Update form data
    FormData
    PATCH
    /forms/formDefinitions/{id}
    Update form definition metadata
    FormDefinitions
    PUT
    /forms/{id}/attachments/{attachmentId}
    Upload attachment file
    Attachments
    PUT
    /forms/iTwins/{iTwinId}/listGroups/{id}
    Upload list group file
    FormDefinitions

    Was this page helpful?