Deletes the form definition with the specified ID.
Note that you cannot delete a form definition that already has one or more form data instances filled out using it. Attempting to do so will result in a 409 Conflict response. You would have to delete those form data instances first, such as through the Delete form data endpoint. Note that form data instances users choose to delete are first marked as soft-deleted for a time, and then purged from the system no less than 60 days later. These soft-deleted instances will also prevent you from deleting a form definition unless you set the hardDeleteSoftDeletedData parameter to true, in which case the soft-deleted instances will be deleted permanently along with the form definition.
Permissions
To use this endpoint, the user is required to have the Forms Delete (Forms_DeleteForms) permission for the iTwin.
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
The ID of the form definition to delete. This should be an ID retrieved from the "Get iTwin form definitions" endpoint or a form data instance's "formId" property.
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 204 No Content
Indicates that the form definition was successfully deleted. There is no response body in this case.
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified form definition does not exist.
{ "error": { "code": "FormDefNotFound", "message": "Requested form definition is not available.", "target": "id" } }
Response 409 Conflict
This response indicates that the specified form definition cannot be deleted at this time, likely due to being in use by form data instances.
{ "error": { "code": "FormDefInUse", "message": "Filled-out instances of this form definition exist, so it cannot be deleted." } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "additionalProperties": true }
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Error Response", "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?