Query string parameters
You can append query string parameters to a REST service URL to request OpenAPI documents or retrieve version information about the service.
Different parameters support tasks such as selecting an OpenAPI format or version, listing all available service versions, or providing authentication details when required.
The following table lists the supported parameters and explains how each one is used.
| Name | Value | Description |
|---|---|---|
| ?openapi.json | None | Request the service's OpenAPI document in JSON. Example: http://myServer:port/gas/ws/r/group/xcf/myService?openapi.json. For more details, go to Get the OpenAPI service description |
| ?openapi.yaml | None | Request the service's OpenAPI document in YAML. Example: http://myServer:port/gas/ws/r/group/xcf/myService?openapi.yaml. For more details, go to Get the OpenAPI service description |
| access_token | OAuth access token | Include this parameter to retrieve protected OpenAPI documents or access services that require authentication. Example: ?openapi.json&access_token=token. For more details, go to Get OpenAPI description for a secure service |
| version | OpenAPI version identifier | When combined with ?openapi.json, selects the OpenAPI version to return. Example: ?openapi.json&version=v3. For more details, go to Get the OpenAPI description for a specific version |
| version | Response format suffix | When used alone as ?version.json or ?version.yaml, triggers version-listing mode. The response lists all declared versions of the service and identifies the default version if one is defined. Any value assigned to the parameter is ignored. For more details, go to Get available versions of a service |