...

The edges of the graph are provisioned using a relationship list construct.  For PUT methods, a relationship contains the vertex type or category (related-to) and a list of relationship data which captures the key pieces of data required to uniquely identify the resource.  On a GET method, the above information and a URL are returned.  The URL can be used to GET all the details of that object.  The URL returned is suitable for retrying failed commands but should not be expected to be cacheable for very long periods (e.g., the version of the URL may get deprecated when the release changes).The REST API describes each API that AAI provides, independent of the caller of the

API

...

At its simplest, the data flow between AAI and clients can be depicted as shown in Figure 1:

Image Removed

Figure 1. Data flow for AAI.

API Definition

The API structure is composed of:

...

The full definition of the API can be found here: AAI REST Specification. This document includes an explanation of how to use the  Active and Available Inventory REST API reference document. The The API documentation generated from the schema (OXM file) can be found here: AAI REST Specification. The XSD generated from the schema can be found here: AAI schema.