Get an interface
get
https://{your_site_interface}/opa-hub/api/12.2.35/operations/{operation-name}/interfaces/{interface-name}
This operation will get an interface.
Request
Path Parameters
-
interface-name(required): string
The name of the interface
-
operation-name(required): string
The name of the operation.
Query Parameters
-
expand: string
Comma separated list of named resources to expand, or "all" to expand all
-
fields: string
Comma separated list of fields to be returned
-
links: string
Comma separated list of links to be returned, or "none" to omit links
There's no request body for this operation.
Security
-
Authorization: apiKey
Type:
apiKey
Description:Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
-
oauth2_opa: oauth2
Type:
oauth2
Description:POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.
Response
Supported Media Types
- application/json
200 Response
The request was successfully completed.
Root Schema : interface
Type:
Show Source
object
-
name: string
Read Only:
true
The name of the interface -
properties: object
interfaceProperties
Additional Properties Allowed:
true
Nested Schema : interfaceProperties
Type:
object
Additional Properties Allowed:
true