Interface BTAppElementUpdateParams

Export

Interface

BTAppElementUpdateParams

Hierarchy

  • BTAppElementUpdateParams

Properties

Edits to be applied to the element's subelement data.

Memberof

BTAppElementUpdateParams

description?: string

The label that will appear in the document's edit history for this operation. If blank, a value will be auto-generated.

Memberof

BTAppElementUpdateParams

jsonPatch?: string

A json patch that will be applied to the application element's json data.

Memberof

BTAppElementUpdateParams

jsonTreeEdit?: BTJEdit3734

Memberof

BTAppElementUpdateParams

parentChangeId?: string

The id of the last change made to this application element. This can be retrieved from the response for any app element modification endpoint.

Memberof

BTAppElementUpdateParams

propertyUpdates?: BTMetadataPropertyUpdateParams[]

Edits to be applied to the element's metadata.

Memberof

BTAppElementUpdateParams

returnError?: boolean

If true, errors in request processing will be returned in a 200 response with a meaningful description. Otherwise, errors will result in a relevant HTTP error response.

Memberof

BTAppElementUpdateParams

If specified, and jsonTreeEdit is non-empty, the json difference will be returned in this format, otherwise no json difference will be returned.

Memberof

BTAppElementUpdateParams

transactionId?: string

The id of the transaction in which this operation should take place. Transaction ids can be generated through the AppElement startTransaction API.

Memberof

BTAppElementUpdateParams

Generated using TypeDoc