Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

Endpoints in the REST API v3.0

TrueSight Network Automation REST API – Version 3.0
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

See the following topics for the endpoints in REST API version 3.0:

For a few services, endpoints are included as supporting components. See the following topic for the same.

supporting components

GET /v3.0/device_adapters
 Retrieves device adapters, matching any filter criteria


Parameters

Name

Located in

Description

Default

Schema

filter.type

query

Filter for device adapters matching this type


string
Enum: [
  "configurationTrail",
  "customAction",
  "deviceType",
  "externalScriptAction",
  "vendor"
]

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

[
   #DeviceAdapterDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to access device adapters


500

Internal server error: Unexpected exception occurred


GET /v3.0/device_adapters/{nameOrKeyOrGuid}
 Retrieves one device adapter either by name, by database key, or by GUID


Parameters

Name

Located in

Description

Default

Schema

nameOrKeyOrGuid

path

Name or database key or GUID of the one device adapter of interest


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#DeviceAdapterDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to access device adapters


404

Not found: No single matching device adapter found


500

Internal server error: Unexpected exception occurred


GET /v3.0/models
 Retrieves all models


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

[
   #ModelDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


500

Internal server error: Unexpected exception occurred


GET /v3.0/models/{nameOrKey}
 Retrieves one model either by name or by database key


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the model of interest


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#ModelDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


404

Not found: No single matching model found


500

Internal server error: Unexpected exception occurred


GET /v3.0/os_images
 Retrieves OS images from the library, matching any filter criteria


Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for OS images matching this name, asterisk wildcards allowed


string

filter.filename

query

Filter for OS images matching this filename, asterisk wildcards allowed


string

filter.onlyDeployable

query

Filter for OS images that can be deployed; when true, returns only OS images whose 'Forbid Deployment of This Image' setting is unchecked; when false or when this filter is absent, no filtering is done


boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

[
   #OsImageDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to access the OS image library


500

Internal server error: Unexpected exception occurred


GET /v3.0/os_images/{nameOrKey}
 Retrieves one OS image from the library either by name or by database key


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the OS image of interest


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#OsImageDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


403

Forbidden: Not allowed to access the OS image library


404

Not found: No single matching OS image found


500

Internal server error: Unexpected exception occurred


GET /v3.0/time_period_types
 Retrieves all time period types


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

[
   #TimePeriodTypeDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


500

Internal server error: Unexpected exception occurred


GET /v3.0/time_period_types/{idOrUrlKey}
 Retrieves one time period type either by its unique ID or its urlKey


Parameters

Name

Located in

Description

Default

Schema

idOrUrlKey

path

ID or urlKey of the time period type of interest


string*

Authorization

header

Authorization token formatted as 'Bearer [token]'


string*

Responses

Code

Description

Schema

200

successful operation

#TimePeriodTypeDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in


404

Not found: No single matching time period type found


500

Internal server error: Unexpected exception occurred



Object Definitions

Object

Schema

DeviceAdapterDTO


 Information about a device adapter


{
    id: string
    The adapter's unique database key
 
    name: string
    The adapter's display name
 
    annotation: string
    Annotation with reasons for modification
 
    enabledFlag: boolean
    Whether or not this adapter is enabled
 
    guid: string
    The adapter's GUID
 
    lastModifiedTimestamp: date-time
    When this adapter was last modified
    Example: 2017-01-31T13:45:00.000+0000
 
    lastModifiedUserName: string
    The name of the user who last modified this adapter
 
    requiresMergeFlag: boolean
    Whether or not the adapter requires a manual three-way merge, caused by a software upgrade
 
    stateId: integer
    Whether an adapter is currently in the new, modified, or baseline state
 
    stateName: string
    The meaning of the numeric stateId
 
    typeId: integer
    The type of device adapter
 
    typeName: string
    The meaning of the numeric typeId
}

DynamicFieldValueDTO


 A dynamic field value


{
    id: string
    The database key of the dynamic field whose value this is (read-only)
 
    name: string
    The name of the dynamic field (read-only)
 
    values: [
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
      string
    ]
 
    dynamicFieldDetailsLink: string
    Link to get more detailed information about the dynamic field (read-only)
}

ModelDTO


 Information about a model, as discovered while accessing devices


{
    id: string
    The model's unique database key
 
    name: string
    The model name, unique within a vendor
 
    vendorGuid: string
    The GUID of the vendor associated with this model
 
    vendorName: string
    The name of the vendor associated with this model
}

OsFileDTO


 Information about an operating system binary file


{
    imageTypeName: string
    What type of binary file this is, when a device supports multi-file images
 
    name: string
    The name of the file
 
    sizeBytes: integer
    The size of the file in bytes
 
    messageDigest: string
    The MD5 checksum or digest
}

OsImageDTO


 Information about an operating system image


{
    id: string
    The OS image's unique database key
 
    name: string
    The OS image's display name; null/empty when this image has not been verified as having run on a device
 
    deviceTypeGuid: string
    Which device type this OS image applies to
 
    deviceTypeName: string
    The name of the device type
 
    vendorGuid: string
    Which vendor owns the associated device type
 
    vendorName: string
    The name of the vendor
 
    forbidDeploymentFlag: boolean
    Whether or not this OS image is allowed to be deployed
 
    annotation: string
    Notes, comments, description, explanation
 
    memoryFootprintBytes: integer
    Bytes of memory this image consumes; a zero indicates this value is not used by the device
 
    activationKey: string
    License key to activate features in the binary image on the device
 
    files: [
      The binary files; null/empty when no image snapshot has been taken from a device running this image, or user has not supplied any files
 
       #OsFileDTO
    ]
 
    modelNames: [
      The models where this image can be deployed
 
      string
    ]
 
    dynamicFields: [
      The dynamic fields
 
       #DynamicFieldValueDTO
    ]
}

TimePeriodTypeDTO


 Information about a time period type


{
    id: integer
    Unique identifier of this time period type
 
    name: string
    The time period type's display name
 
    futureOrientedFlag: boolean
    Whether or not this time period type is future-oriented (refers to dates/times in the future, such as tomorrow or next week)
 
    hourOrientedFlag: boolean
    Whether or not this time period type is hour-oriented (refers to a span of a certain number of hours, such as last 2 hours or last 24 hours)
 
    preDefinedFlag: boolean
    Whether or not the time period type is pre-defined; when true, the time period is a known or fixed range (such as last week or this month); when false, the time period includes dynamically selected or computed dates or times (such as before or since trusted)
 
    sortOrder: integer
    Where this time period type appears among the other time period types
 
    urlKey: string
    Unique identifier for this time period type for use in an external URL
}


Was this page helpful? Yes No Submitting... Thank you

Comments