academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Buildings → Update building

AI-generated

Summary

Update an existing building's details in the academyFIVE system by specifying the building's type, attributes, and relationship data.

Inputs

  • data (required) — Includes the building type (string), optional building id (string), and required attributes such as name, active status, and status, with optional fields for description, company, address details, contact person, phone, fax, email, website, usage.
  • relationships (required) — Defines relationships such as countries, sites, and optionally approved sites, each containing type and id identifiers to associate the building with other entities.

Output shape

a list of JSON objects representing the updated building data returned from the API after the update operation

The operation returns JSON response data from the academyFIVE API reflecting the result of the update. If the API supports binary responses, the node converts and outputs binary data, but typically it returns JSON. Errors are handled per workflow configuration; on failure, an error object with the message is returned if "Continue on Fail" is enabled.

Examples

Example 1: Update a building's name, active status, and address, and associate it with specific countries and sites

Specify 'Buildings' resource and 'Update building' operation. Provide 'data' with building type, attributes (required fields like name, active, status), and optionally building id for identification. Specify 'relationships' with countries and sites by their ids to relate the building accordingly.

Links

Discussion