Send Requests
Use these guidelines when sending requests using the REST API for Oracle Communications Unified Assurance Microservices.
URL Structure
The URL structure for the requests is:
https://hostFQDN:port/resource-path or
https://clusterFQDN:port/resource-pathWhere:
-
hostFQDN:port: Host FQDN and port where Unified Assurance is running. -
resource-path: Relative path that defines the resource. clusterFQDN:port: If you are using cluster-level FQDN instead of host-level FQDN.
For example, the URL for requesting the status of a discovery job for v1 endpoints is:
https://hostFQDN:port/discovery-service/discovery/request/status/
The URL for requesting the status of a discovery job for v2 endpoints is:
https://hostFQDN:port/api/app/discovery/<zoneid>/v2/devices/discoveryStatus
Supported Methods
You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.
| HTTP Method | Description |
|---|---|
GET
|
Retrieve information about objects. |
POST
|
Create objects. |
PATCH |
Update objects partially. |
PUT
|
Update objects by replacing them. |
Media Types
The Unified Assurance REST API supports the application/json media
type.