• Created by Unknown User (rnnavarro), last modified on Feb 01, 2017

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »


( Under construction...don't bother making comments yet )


The Active and Available Inventory (AAI or A&AI) has its own REST API. 

The AAI REST API provides access to the AAI active inventory graph.  The API is largely configured from models and configuration files.  Each vertex in the graph has an API that can be called separately or, if part of a tree structure, as a nested element with one or more generations (parent, grandparent, and so on).

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. Therefore there is no information to be found here regarding the expectations on the callers.  That information is conveyed in design documents for each client.

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

Figure 1. Data flow for AAI.

API Definition

The API structure is composed of:

  • The HTTP command, which indicates the operation to perform
  • The HTTP URI, which defines what object this operation is related to
  • The HTTP version, which MUST be 1.1

Available HTTP commands are:

  • PUT: used to create or update an object
  • DELETE: used to delete an object or a set of objects
  • GET : used to query an object or set of objects
  • PATCH :  used to update specific fields owned by the client doing the update

The HTTP URI is built according to this pattern:

https://{serverRoot}/{namespace}/{resource}

  • (serverRoot} refers to the server base url: hostname+port+base path+version. Port and base path are OPTIONAL but AAI will use port 8443 and base path aai.  The first release version will be v8.
  • {namespace} refers to the API namespace. Supported namespaces are cloud-infrastructure, business, service-design-and-creation, and network
  • {resource} refers to how the object is identified according to the namespace specifications.

Example

GET https://aai.att.com:8443/aai /v8/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

References

The full definition of the API can be found here: AAIRESTAPI_8.docx. This document includes the conventions used in the Active and Available Inventory REST API reference document.

The schema can be found here: aai_schema_v8.xsd

  • No labels