Prepare-Update Schemas Subtypes

POST

Gets the new fragment IDs and fields resulting from changing a subtype.

Request

This endpoint expects an object.
leaf_typestringRequiredformat: "text"

Leaf type of the object.

is_custom_leaf_typebooleanOptional

Whether the leaf type corresponds to a custom object.

new_subtypestringOptionalformat: "text"

Name of the new subtype for the object.

objectstringOptionalformat: "id"

ID of the object of which subtype is to be changed. Used to fetch the object’s custom schema fragments and custom fields

Response

Success.

added_fieldslist of objectsOptional

List of fields that have a default value and need to be set.

dropped_fieldslist of objectsOptional

List of fields that will be dropped from the object.

new_custom_schema_fragmentslist of stringsOptional

List of new custom schema fragment IDs of the object.

new_start_stagestringOptionalformat: "id"

ID of the start stage of the new diagram if the subtype change results in a change in the stage diagram.

Built with