Hybrid Integration 10.1 | Integrating On-Premises Applications | Document Conventions | Working with REST API Descriptors | About REST Definitions
 
About REST Definitions
The REST Definitions tab for a REST API descriptor provides a consolidated view of the parameters used by the operations for the REST resources included in the REST API descriptor. The contents of the REST Definitions tab become the definitions object in the Swagger document.
Integration Server creates a REST definition for each of the following:
*Input parameter that is a Document, Document List, Document Reference, or Document Reference List.
*An input signature that includes the above along with one or more scalar parameters. The REST definition includes the scalar parameters and a reference to the REST definition created for the Document, Document List, Document Reference, or Document Reference.
*Output parameters returned by an operation.
The REST Definitions tab is read only. For information about REST Definitions properties, see REST Definition Properties and REST Definition Parameter Properties.

Copyright © 2015- 2017 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.