Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please note documentation for these APIs can also be accessed via the swagger document

The way to access this would be to visit <server>/swagger/?url=apidocs/aai_swagger_bulk_v15.yaml 

Bulk Add

Getting Started with the Bulk add API

To execute a bulk add, a client will perform a PUT on the bulk add API URI and include a payload indicating the nodes to be added.The version (v$ ie. v15) dictates which release's REST API version the output will be based on.


API URI

PUT /aai/v$/bulkadd


Payload

The payload must include a "transactions" parameter. This typically is an array of multiple "put" operations that include the associated A&AI URI for the put operation and corresponding body payload. Multiple PUT operations can be done within a single transaction or can be split into multiple transactions. A transaction's changes will not be committed to the database unless all operations within a single transaction succeed. Each transaction must include a "put" array including at least one set of "uri" and "body" parameters. The "uri" parameter designates the endpoint of the A&AI (C)RUD operation that will add the node/relationship, the "body" designates the payload that URI accepts to do so.

...