API Guide

10.3 GET /fabric-intents/{id}
Get a Fabric-Intent
retrieves a fabric intent represented by the requested 'id'.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
Unique identier of the fabric intent
RESPONSE
STATUS CODE - 200: Response to get a fabric intent
RESPONSE MODEL - application/json
{
Fabric Intent output object returned for GET API call
id string
Unique identier of the fabric intent object
name string
Name of the new fabric-intent
wiring_diagram_id string
Object id of wiring-diagram on which this intent will be applied.
description string
Text to describe the fabric-intent
user_info {
This object describes the user information with respect to object like who created or updated the object
created_by string
Name of the user who created the object.
created_at integer
creation date of this object
last_updated_by string
Name of the user who last updated this object
last_updated_at integer
last update date of this object
}
fabric-type enum DEFAULT:NOT_DEFINED
ALLOWED:NOT_DEFINED, L3_BGP, L3_BGP_NSX_T, L2_VLT,
BGP_EVPN
Type of the interlink. This denes how the switches are connected. Based on the type set,
corresponding object needs to be set with this input.
state {
Describes the current state and state transitions of this fabric-intent.
current_state enum ALLOWED:DRAFT, PENDING_APPROVAL, APPROVED,
DEPLOY_IN_PROGRESS, ACTIVE, INACTIVE
States of fabric intent.
timestamp integer
The time in seconds since epoch at which the current state was set.
timestamp_iso string
the time in ISO format at which the current state was set.
}
}
STATUS CODE - 401: You are not authorized to perform this operation.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
123 of 340