iTwin Platform
Get Started
Documentation
Learning
Samples
Blog
Support
Pricing
Sign In
Table of contents
v1
REST API Overview
Overview
Samples
Reference
Changelog
Documentation
Forms
Forms
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
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/formDefinitions/{id}/listGroups/{listGroupId}
Get list group
FormDefinitions
GET
/forms/?projectId[&$top][&continuationToken][&type][&state]
Get project form data
FormData
GET
/forms/formDefinitions?projectId[&type]
Get project form definitions
FormDefinitions
GET
/forms/formDefinitions/{id}/staticImages/{fileId}
Get static image
FormDefinitions
GET
/forms/workflows/{type}?projectId
Get workflow
Workflow
PATCH
/forms/{id}
Update form data
FormData
PUT
/forms/{id}/attachments/{attachmentId}
Upload attachment file
Attachments
Call
Title
Tags
POST
Add attachment to form
Attachments
POST
Add comment to form
Comments
POST
Create form data
FormData
DELETE
Delete attachment
Attachments
DELETE
Delete comment
Comments
DELETE
Delete form data
FormData
GET
Download form as file
Export
GET
Export forms to Storage
Export
GET
Get attachment file by ID
Attachments
GET
Get audit trail for form data
AuditTrail
GET
Get form data attachments
Attachments
GET
Get form data comments
Comments
GET
Get form data details
FormData
GET
Get form definition by ID
FormDefinitions
GET
Get list group
FormDefinitions
GET
Get project form data
FormData
GET
Get project form definitions
FormDefinitions
GET
Get static image
FormDefinitions
GET
Get workflow
Workflow
PATCH
Update form data
FormData
PUT
Upload attachment file
Attachments