API Reference
Topic

Update topic

PUT
https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}

Update a topic.

Not all properties are included in the response by default, make use of the OData select feature to adjust the response fields.

Nullable fields without a value may not be included in the response.

Values for Catenda fields (usually prefixed with bimsync_) are persistent across updates. Other fields are not and their values will be unset if not included in the update request. For example, an update request that doesn't include a description will remove any existing value for description.

BCF fields that have a corresponding Catenda field will be updated when setting the Catenda field. For example setting bimsync_assigned_to will also set assigned_to and viceversa if the assignee is a Catenda user. This means that the assigned_to field of a topic doesn't need to be set if bimsync_assigned_to is being used. But if the assignee is not a member of the project then the assigned_to field should always be set when updating a topic to avoid losing its value.

Authentication
Bearer
Path Parameters
topic-board-id
*
topic-id
*
Query Parameters
includeAuthorization
$select
Body Parameters
body
*
topic_type
topic_status
title
*
priority
labels
assigned_to
stage
description
due_date
bimsync_assigned_to
bimsync_custom_fields
bimsync_labels
bimsync_requester
creation_date
creation_author
Responses
200
OK
guid
server_assigned_id
topic_type
topic_status
title
labels
creation_date
creation_author
modified_date
modified_author
assigned_to
stage
description
due_date
authorization
bimsync_issue_number
bimsync_creation_author
bimsync_viewpoints
bimsync_points
bimsync_requester
bimsync_document_references
bimsync_comments_size
bimsync_assigned_to
bimsync_labels
bimsync_custom_fields




Updated 02 Dec 2024
Did this page help you?