Skip to content

Warning

You are viewing documentation for a feature that is currently under incubation. This means that the feature is not yet fully supported and may change or be removed in future versions. This documentation is provided for early adopters and testers. Features under incubation should not be used in production environments.

Operations on Entities

The Batch API lets you perform operations on components and references in Ardoq. For the most part these operations mirror those available in the public API for each resource type.

For example - the following example compares updating the latest version of a component using the Components API with performing the action via the Batch API.

Method Path Query Parameters
PATCH /api/v2/component/c253c98231776d0c8a54879e ifVersionMatch=latest 
{
    "name": "Updated Component"
}
Method Path Query Parameters
POST /api/v2/batch 
{
    "components": {
        "update": [
        {
            "id": "c253c98231776d0c8a54879e",
            "ifVersionMatch": "latest",
            "body": {
            "name": "Updated Component"
            }
        }
        ]
    }
}

The Batch API lets you combine multiple create, update, upsert (update an existing entity or create a new one) 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.

Components

  • Upsert - Update an existing component or create a new one if it does not exist.
  • Create - Create a new component.
  • Update - Update an existing component.
  • Delete - Delete a component.

References

  • Upsert - Update an existing reference or create a new one if it does not exist.
  • Create - Create a new reference.
  • Update - Update an existing reference.
  • Delete - Delete a reference.