Previous Topic

Next Topic

openapi.json - Web Service Function

The openapi.json endpoint returns generated OAS (OpenAPI Specification) metadata output. The output is in OAS Version 2 JSON format.

OAS is a standard format used to present web endpoints. The open source Swagger Editor can be used to view and test the file.

Note: OpenAPI is not fully compatible with OData and there are differences between the generated documentation for OpenAPI and the correct query and parameter structure for OData. This endpoint is provided as a convenience only.

See Also

Company Web Service Actions and Functions

Book Contents

Book Index