Issue Service

View, create, and edit details of issues that have been raised in an iTwin or project, as well as their comments, attached files, and change history.  Retrieval of form definitions (which define how to display an issue in an interactive UI) is also supported, though customization of them is not, and should be done by a project administrator through the CONNECT Issues web application, if needed. This form-editing app can be found at https://connect-formmanager.bentley.com/designer/#/your-itwin-id where `your-itwin-id` is replaced by the ID of the iTwin or project you're creating custom forms for.

## Limits

All API calls that return a list of results will return a maximum of 50 results. Some endpoints support a `$top` parameter to specify a number of results to retrieve (up to the maximum) and a `continuationToken` parameter to continue paging through results, allowing access to results beyond the first 50. These parameters will be included in the documentation for those endpoints.

Clients with a Developer, Partner, or Integrator subscription will be limited to 5000 requests per minute. Clients with a Trial subscription will be limited to 500 requests per minute.

issues-v1

This information is included in every event the webhook will receive.

base-event

content

object

Base Event eventType

base-event-eventType

enqueuedDateTime

string

iTwinId

messageId

webhookId

Base Event

Event that gets triggered when an attachment instance became attached (related) to an issue.

issues.attachmentAttached.v1-event

The globally unique identifier of the attachment.

attachmentId

The globally unique identifier of the issue the attachment became attached to.

issueId

issues.attachmentAttached.v1

Event that gets triggered when an attachment is unattached from an issue

issues.attachmentUnattached.v1-event

The globally unique identifier of the issue the attachment was unattached from.

issues.attachmentUnattached.v1

Event that gets triggered when a comment was created for a particular issue instance.

issues.commentCreated.v1-event

The globally unique identifier of the comment.

commentId

The globally unique identifier of the issue the comment was created for.

issues.commentCreated.v1

Event that gets triggered when an issue was created.

issues.issueCreated.v1-event

Denotes what file or iModel element the data instance was created about. Will be null if not applicable.

sourceEntityId

The globally unique identifier of the issue that was created.

issues.issueCreated.v1

Event that gets triggered when an issue was deleted.

issues.issueDeleted.v1-event

The globally unique identifier of the issue that was deleted.

issues.issueDeleted.v1

Event that gets triggered when an issue was modified.

issues.issueUpdated.v1-event

The globally unique identifier of the issue that was updated.

issues.issueUpdated.v1

Event that gets triggered when an external file instance became linked (related) to an issue.

issues.externalFileLinked.v1-event

The globally unique identifier of the external file instance that was linked. Will generally consist of `ES_` followed by a GUID.

fileId

The globally unique identifier of the issue the external file was linked to.

issues.externalFileLinked.v1

Event that gets triggered when an external file instance became unlinked from an issue. (This means the relationship between the two was deleted, but the external file itself may or may not have been deleted).

issues.externalFileUnlinked.v1-event

The globally unique identifier of the external file instance that was unlinked. Will generally consist of `ES_` followed by a GUID.

The globally unique identifier of the issue the external file was unlinked from.

issues.externalFileUnlinked.v1

Event that gets triggered when an issue metadata instance was deleted.

issues.metadataDeleted.v1-event

The globally unique identifier of the issue metadata instance.

metadataId

issues.metadataDeleted.v1

Added technology preview operation 'Delete form definition'.

Added technology preview operation 'Get templates'.

Added technology preview operation 'Import form definition from another iTwin'.

Added technology preview operation 'Import template'.

Added technology preview operation 'Update form definition metadata'.

---

Adds a new attachment to the specified issue. This only creates the attachment metadata; the file will need to be uploaded through a subsequent PUT call to the URL returned in the Location header of this endpoint's response.

### Permissions

To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

add-attachment-to-issue

The ID of the issue to add an attachment to.

OAuth access token with `itwin-platform` scope

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

default

Indicates that the attachment metadata was created successfully. The file should then be uploaded via PUT to the URL in the Location header.

The URL where the attachment file should be uploaded.

Location

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.

HeaderNotFound

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

InvalidApplicationTier

This response indicates that the user attempted to add an attachment to an issue that does not exist or is inaccessible to the user.

This response indicates that there is a problem with the request. Most likely, the 'includeHeader' parameter is included but not set to true or false.

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Deletes the specified attachment (including both its metadata and file) from the specified issue.

### Permissions

To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

delete-attachment

The ID of the issue to delete an attachment from.

Indicates that the attachment was successfully deleted. There is no response body in this case.

This response indicates that the attachment with the specified ID does not exist or is inaccessible to the user.

---

Retrieves the actual file contents for the attachment with the given ID. This API will attempt to infer the MIME type to return from the file's extension, but will return the default value of `application/octet-stream` if it does not recognize the extension.

### Permissions

To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated definition if form definition security is specified. (Having any other Forms permission automatically grants the **View** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-attachment-by-id

This response indicates that the specified attachment does not exist (code = 'AttachmentNotFound') or that the attachment metadata instance exists but does not have an associated file (code = 'FileNotFound').

---

Retrieves the metadata for all files attached to the given issue. In order to get the contents of a file itself, use the `Get attachment file by ID` endpoint, passing the `id` from the metadata object returned by this request as the `attachmentId` parameter of that request.

### Permissions

To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having any other level of Forms permission automatically grants the **View** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-issue-attachments

The ID of the issue to get attachments for

This response indicates that the specified issue does not exist or is inaccessible to the user.

---

Uploads a file's contents, associating it with the attachment metadata instance with the given ID. The request body is simply the file's bytes. If a file was already uploaded for the attachment with the given ID, that file will be overwritten.

### Permissions

To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

upload-attachment-file

The ID of the issue this attachment belongs to.

The ID of the attachment metadata instance this file will be associated with.

Indicates that the attachment file was successfully uploaded

This response indicates that the specified attachment metadata instance does not exist or is inaccessible to the user.

Indicates that the file the user attempted to upload is above the maximum size.

---

Retrieves a reverse-chronologically-ordered list of all changes that have been made to this issue, including authors, dates, and old vs. new property values.

### Permissions

To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated definition if form definition security is specified. (Having any other level of Forms permission automatically grants the **View** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-issue-audit-trail

The ID of the issue to get audit entries for

---

Adds a new comment to the specified issue. Only the comment text is needed; the author and creation time will be automatically set by the server.

### Permissions

To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

add-comment-to-issue

Indicates that the comment was created successfully

This response indicates that the issue the user attempted to add a comment to does not exist or is inaccessible to the user.

This response indicates that there is a problem with the format of the request body. Most likely causes: The body is not valid JSON, or the 'text' property is missing or not a string.

---

Deletes the specified comment from the specified issue.

### Permissions

To use this endpoint, the user is required to have the Forms **Comment** (`Forms_CommentAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having **Create/Modify**, **Assign**, **Approve**, or **Full** permission automatically grants the **Comment** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

delete-comment

The ID of the issue the comment is associated with.

Indicates that the comment was successfully deleted. There is no response body in this case.

This response indicates that the comment with the specified ID does not exist or is inaccessible to the user.

---

Retrieves the text and metadata for all comments that have been posted to the given issue. If the Prefer header was specified with the value "return=representation", the response will include the email address of each comment author, though this may incur additional processing time.  If there is an extraordinarily large number of comments, only 50 distinct user email addresses will be retrieved and shown. Regardless of the Prefer header value, the "_links" object associated with each comment will provide a link to additional information about the comment author.

### Permissions

To use this endpoint, the user is required to have the Forms **View** (`Forms_ViewAccess`) permission for the iTwin, or for the issue's associated form definition if form definition security is specified. (Having any other level of Forms permission automatically grants the **View** permission as well.)

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-issue-comments

Sets the level of detail to return. For this endpoint, setting 'return=representation' will add the comment authors' email addresses to the response.

Prefer

minimal

representation

---

Gets the specified issue exported to the specified file format. Currently, the default--and only supported format--is PDF. The issue with the specified ID will be laid out in the PDF according to its associated form definition.

The generated PDF will have a header at the top of each page with metadata about the issue (such as its name and creation date) unless the 'includeHeader' query parameter is set to false.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

download-issue-as-file

The ID of the issue to download as a file.

The type of file to download the form as. Currently the default, and only supported value, is 'PDF'.

fileType

If downloading as PDF, sets whether to include form metadata on the top of each page. Default is true.

includeHeader

Indicates that the file was successfully generated in the requested format. The response body consists of the generated file.

This response indicates that the specified issue does not exist or is inaccessible.

This response indicates that there is a problem with the format of the URL. Most likely problem: The 'fileType' parameter is set to an unsupported file type, or the 'includeHeader' parameter is set to a non-boolean value.

---

Requests that anywhere from 1 to 5 issues be exported to a file and saved in cloud-based storage (accessible through the Storage API). Currently 'pdf' is the only supported file type. The IDs of the issues must be specified in a query string parameter named "ids", separated by commas if there is more than one. A sample request URL that exports 3 issues to a PDF is as follows--

https://api.bentley.com/issues/exportPdfToStorage?ids=abab23524535,89458jjlij,32636wtewtwt&folderId=090909877987&includeHeader=true

Note that unlike most GET requests, this is not an idempotent operation; each time it is called, a new file will be generated. The response will not contain the file itself, but links to download it from Storage.

All issues specified in the request must come from the same iTwin, or the request will fail. The client may also specify the ID of a destination folder where the file should be saved; otherwise, it will be saved in the iTwin's root folder.  They can also specify whether to include a textual header with issue metadata at the top of each page (default) or exclude it.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

export-issues-to-storage

Instance IDs of issues to export. Must include at least 1, but no more than 5, IDs, separated by commas, and they all must come from the same project.

If exporting to PDF, indicates whether to include metadata on top of each page.  Default is true.

Indicates the type of file to create. Right now PDF is the only valid option, and is the default if not specified.

The ID, as retrieved from the Storage API, of the folder where the produced file should be saved. If not set, will default to the project's root folder.

folderId

Indicates that the file was generated successfully. The response includes the generated file's filename as well as links for using the Storage API to retrieve it.

Either one of the issues specified does not exist (code = 'IssueNotFound') or the destination folder does not exist (code = 'FolderNotFound').

This response indicates that there is a problem with the request parameters. Depending on the problem, the 'details' array may include specific errors.

---

Deletes the form definition with the specified ID.

Note that you cannot delete a form definition that already has one or more issues filled out using it. Attempting to do so will result in a 409 Conflict response. You would have to delete those issues first, such as through the `Delete issue` endpoint. Note that issues 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 issues will also prevent you from deleting a form definition unless you set the `hardDeleteSoftDeletedData` parameter to `true`, in which case the soft-deleted issues 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

delete-form-definition

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.

Indicates that the form definition was successfully deleted. There is no response body in this case.

This response indicates that the specified form definition does not exist.

This response indicates that the specified form definition cannot be deleted at this time, likely due to being in use by existing issues.

---

Gets the full form definition with the specified ID.

If you have permission to edit this form definition, then the response will also include a link you can follow in your browser to edit its layout in the Form Manager webapp.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-form-definition-by-id

The ID of the form definition to get. This should be an ID retrieved from the "Get project form definitions" endpoint or an issue's "formId" property.

This response indicates that the form definition with the specified ID does not exist or is inaccessible to the user.

---

Retrieves a list of form definitions for the iTwin with the given ID.  By default this retrieves only Approved form definitions; set the `status` parameter to `any` or another status to override this.

Note that in order to create an issue, it must be associated with the ID of one of these form definitions (through the 'formId' property in the 'Create issue' request body). This API cannot be used to create or edit form definitions. They can only be created/edited/imported by project administrators through the Bentley Form Manager webapp, which is accessible at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace `your-itwin-id` with your actual project or iTwin ID). If you call this endpoint with the `Prefer` header set to `return=representation`, then any form definitions in the response that you have permission to edit will include a link you can follow to edit their layout in the Form Manager webapp.

Note that the 'iTwinId' query string parameter is required. It must be a valid iTwin or project GUID to get form definitions from. Older clients can continue to use 'projectId' as an alias for 'iTwinId'.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-project-form-definitions

The GUID of the iTwin or project to get form definitions for. (Note: projectId is also accepted as an alias for this parameter.)

The issue type to get form definitions for. Omit to get all form definitions, regardless of type.

type

If present, filters the results to only include form definitions with the given string (case-insensitive) in their names.

search

Filters form definitions by their status (i.e., whether they are ready for use). Options are 'Draft', 'Approved', 'Maintenance', or 'Archived' to only get form definitions with the given status, or 'any' to get form definitions regardless of status. Default is 'Approved'.

status

Chooses whether to get a summary of each form definition (return=minimal) or more properties (return=representation)

Minimal

Representation

This response indicates that the project with the specified ID does not exist or is inaccessible to the user due to insufficient permissions. (For security reasons, the response will not differ between inaccessible and missing projects.)

This response indicates that there is a problem with the format of the URL. Most likely problem: The 'iTwinId' parameter is missing or not a valid GUID.

---

Retrieves the list of list groups in the chosen iTwin. List groups govern the options that appear for the user to select in cascading list controls. These are a series of dropdown list controls in a form definition where the options available in each control beyond the first vary depending on which options were selected in the preceding controls.

By default, this endpoint gets all list groups in the iTwin. If `search` is specified, only list groups whose names include the given search string (case-insensitive) will be returned.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-itwin-list-groups

The ID of the iTwin to get list groups for.

Optionally provide a string to filter by. List groups will only be returned in the results if their display name contains the string.

Indicates whether to get just each list group's name and created date (return=minimal) or to get the entire options tree for each list group (return=representation)

This response indicates that the iTwin with the specified ID does not exist or is inaccessible to the user due to insufficient permissions. (For security reasons, the response will not differ between inaccessible and missing projects.)

---

Use this request to look up a list group, which is a nested object structure that defines the options available in a chain of cascading list form controls. (Cascading lists are a set of &lt;select&gt; elements where only the first one is initially enabled until an option in it is selected, and then, depending on which option was selected, the available options in the next list can vary.) Each property in the structure represents an option in a select list, and its children represent options that become available in the next list in the chain if that option is selected.

### Sample Explanation

The sample for the 200 response shows an example of a list group that could be assigned to 3 controls in a form to let the user pick an American football team by conference, division, and name. Since the result has two properties ("AFC" and "NFC") as direct children of the "optionsTree" property, the first list in the cascading list chain would have two options--"AFC" and "NFC".  Whichever option is chosen, its child properties become available for selection in the second list, and so forth.  For example, if "AFC" and "North" were chosen for the first two lists respectively, the third list would show the available options "Bengals", "Browns", "Ravens", and "Steelers".  These four properties just have empty objects as their values because this particular list group only has three layers; these options are the final options in the chain and have no descendants.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-list-group

The ID of the form definition this list group is used in.

listGroupId

This response indicates that the list group or its associated form definition was not found.

---

Gets a link to a static image to be displayed in a form. The 'fileId' parameter should match the 'fileId' property of a static image control in the form definition.  It will be a positive integer.  This endpoint returns only a _links object containing the URL of the actual file, which will be publicly available at that URL for a brief time and can be set as the 'src' attribute of an HTML <img> tag to display the image.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-static-image

The ID of the form definition to get a static image for.

The ID of the static image.  Will be a positive integer, not a GUID.

This response indicates that the static image or its associated form definition was not found.

---

Gets a list of form definition templates. These are publicly available form definitions created by Bentley that you can import into any iTwin in your organization through the `Import template` endpoint. These templates are not editable in the public repository, but importing a template will create a local copy if it in your iTwin, private to your organization, that you can customize to your needs and use for creating issues.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-templates

A list of the available templates, filtered by issue type if a type was specified.

---

Imports a form definition into one iTwin from another iTwin in your organization. Use this to copy a form definition or to share a form definition so that multiple iTwins can use it to fill out issues. You can also use this endpoint's "Upsert" `importAction` to update a previously-imported form definition to match the current contents of the original one it was imported from--useful to quickly distribute a form layout change to multiple iTwins in your project.

If you want to import one of Bentley's publicly available template form definitions, use the `Import templates` endpoint instead.

**Note** If you set `importAction` to "Copy", then some properties of the form definition (`status`, `type`, `displayName`, and `idPrefix`) can be set as part of the import request. These changes will be applied to the new copy of the form definition in the destination iTwin, but will *not* affect the original form definition.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

import-form-definition-from-another-itwin

The results of the form definition import request, showing the ID of the created or modified form definition in the destination iTwin.

Indicates that the form definition or the iTwin to import into was either not found or inaccessible to the user.

This response indicates that there is a problem with the request body--either a missing property or invalid property value.

---

Imports a form definition template into your iTwin.

Templates are form definitions from Bentley's publicly available template repository. Importing a template creates a private copy of it in your iTwin that behaves like any other form definition--you can fill out issues from it, or customize it to your organization's needs using the Bentley Form Manager webapp.

**Note:** If you need to import a form definition from your own organization (including a form definition that your organization imported from a template and then customized), use the `Import form definition from another iTwin` endpoint instead.

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

import-template

The results of the template import request, showing the ID of the newly created form definition.

Indicates that no template has the given name, or the destination iTwin was not found or inaccessible to the user.

This response indicates that there is a problem with the request body--either a missing property, invalid property value, or invalid combination of `importAction` and other properties.

---

Allows you to modify certain properties of a form definition, such as its display name, status (availability for use), and its ID number prefix that will appear on filled-out instances.

**Note:** Modifying the layout of the form (the `definition` property) is not supported through this endpoint. For that, use the Bentley Form Manager webapp, located at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace `your-itwin-id` with your actual iTwin ID).

### 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](https://developer.bentley.com/apis/overview/authorization/) page.

---

update-form-definition-metadata

The ID of the form definition to update. This should be an ID retrieved from the "Get iTwin form definitions" endpoint or a form data instance's "formId" property.

This response indicates that the specified form definition could not be updated, either because it does not exist (UpsertNotSupported), or because it is not in an editable status and the requested change is not allowed (FormDefIsClosed).

This response indicates that there is a problem with the request body, such as an invalid property value or an unsupported property.

Changelog

Aug 6, 2024