Skip to content

About

The Batch API is the recommended way to work with components and references in Ardoq. It lets you combine multiple create, update and delete operations on both components and references into a single request. All operations are executed within a transaction. If any of the operations fail then the whole request will fail leaving the state of Ardoq unmodified.

Info

You can view the OpenAPI/Swagger schema for the Batch API here.

Components

  • Create - Create a new component.
  • Update - Update an existing component.
  • Delete - Delete a component.

References

  • Create - Create a new reference.
  • Update - Update an existing reference.
  • Delete - Delete a reference.