The TopologyType related APIs include the following:
|
• |
API Name: Get type information |
|
• |
Description: Get the information of an type. |
|
• |
Request type: GET |
|
• |
API path: /api/v1/type/typeName |
|
• |
Sample usage: http://<server>:<port>/api/v1/type/Host |
|
• |
|
The token is retrieved after successfully logging in to the Management Server. | ||
|
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
|
Either the response data format (JSON/XML) or exception message. | ||
|
Error code if some exception occurs; otherwise this field is not shown. |
|
• |
API Name: Get type super type’s information |
|
• |
Description: Get the information of a type’s parent type. |
|
• |
Request type: GET |
|
• |
API path: /api/v1/type/typeName/super |
|
• |
Sample usage: http://<server>:<port>/api/v1/type/Host/super |
|
• |
|
The token is retrieved after successfully logging in to the Management Server. | ||
|
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
|
Either the response data format (JSON/XML) or exception message. | ||
|
Error code if some exception occurs; otherwise this field is not shown. |
|
• |
API Name: Get all instances of a type |
|
• |
Description: Get all instances of a type. |
|
• |
Request type: GET |
|
• |
API path: /api/v1/type/typeName/instances |
|
• |
Sample usage: http://<server>:<port>/api/v1/type/Host/instances |
|
• |
|
The token is retrieved after successfully logging in to the Management Server. | ||
|
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
|
Either the response data format (JSON/XML) or exception message. | ||
|
Error code if some exception occurs; otherwise this field is not shown. |
The User Information related API includes the following:
|
• |
API Name: Get current user information |
|
• |
Description: Get the information of the current user. |
|
• |
Request type: GET |
|
• |
API path: /api/v1/user/current |
|
• |
Sample usage: http://<server>:<port>/api/v1/user/current |
|
• |
|
The token is retrieved after successfully logging in to the Management Server. | ||
|
Specifies the response data format which can be either application/json or application/xml. The default value is application/json. |
|
Either the response data format (JSON/XML) or exception message. | ||
|
Error code if some exception occurs; otherwise this field is not shown. |
Foglight enables cartridges to provide custom REST APIs. Any REST API implementation that conforms the JAX-RS specification can be registered as a custom REST API.
A custom REST API is implemented as a Java class that uses the JAX-RS annotations to specify the details of the REST API endpoint that it implements. The @Path annotation is used to specify the URL, and will be appended to the /api/v1 context used by the REST API cartridge. Therefore, if a custom REST API specifies the @Path("/example") annotation, then the fully qualified API endpoint will be /api/v1/example on the FMS.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center
