--- sourceDocument: Australia Workflow Data Fabric sourceDocumentLink: https://www.servicenow.com/docs/r/australia/integrate-applications Release : - australia ft:locale : - en-US ft:publication_title : - Australia Workflow Data Fabric ft:clusterId : - crint bundleId : - crint workflow : - Creator --- # OpenAPI support in the REST step # OpenAPI support in the REST step {#ariaid-title1} Release version: Australia Updated March 12, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of OpenAPI Support in the REST Step The OpenAPI support in the REST step allows users to import OpenAPI Specifications directly into the Flow Designer. This functionality enables the configuration of REST operations, HTTP methods, parameters, and headers by importing from a YAML or JSON file, enhancing the efficiency of API integrations. Show full answer Show less ## Key Features * **Import Specifications:** Users can import specifications via URL or by pasting content, facilitating easy configuration. * **Auto-Generated Inputs:** Required inputs are automatically created based on the OpenAPI Specification, ensuring all necessary parameters for requests are included. * **View API Operations:** Users can review available API operations without navigating away from the Flow Designer interface. * **Specification Management:** Imported specifications are stored in the OpenAPIs table, where they can be viewed or deleted as needed. * **Customizable Parameters:** Users can remove unnecessary parameters and ensure input labels are user-friendly for easier flow design. ## Key Outcomes By utilizing the OpenAPI support in the REST step, ServiceNow customers can streamline their API integration processes, avoid manual errors, and improve the clarity of input configurations. This results in more efficient workflow designs and the ability to handle API requests more effectively. However, users should be aware of certain limitations, such as the restriction on request body media types and unsupported components from OpenAPI 3.0. Populate REST step fields and action inputs with information imported from an OpenAPI Specification. Import specifications by providing a URL to the YAML or JSON, or copying and pasting content. ## Benefits {#open-api-integration__section_u4r_txd_ygb} OpenAPI support in the REST step offers these benefits. * Use information imported from an OpenAPI Specification to configure REST step operations, HTTP methods, parameters, request body, path, and headers. * Review available API operations without leaving the Flow Designer interface. * Generate inputs required for the REST step to send valid requests to an OpenAPI service and add them to the REST step in the correct location. {#open-api-integration__ul_gfc_szd_ygb} Note: Always review REST step values imported from an OpenAPI Specification before sending a request. Remove parameters, headers, and inputs that the API does not require. ## Generated inputs {#open-api-integration__section_pjr_pnr_xgb} When you import an OpenAPI Specification, the system creates any required inputs and adds them to the REST step form where appropriate. At runtime, the system sends a REST request that contains input values provided to the action. For example, if an API requires a name parameter passed in the request, the system creates a name input and adds it to the REST step. When you add the action to the flow, name becomes an input to the action. The system maps OpenAPI data types to Workflow Studio data types. For example, if the OpenAPI Specification requires a user object, then the system creates a complex data object as input. For more information, see Complex data. ## Specification size limit {#open-api-integration__section_opj_pnr_xgb} By default, the system can import OpenAPI Specifications up to 10 MB. To increase the import size, update the glide.rest.openapi.max_request_size system property. The maximum value is 100 MB. ## Specification management {#open-api-integration__section_oj2_s3c_chb} Import an OpenAPI Specification by selecting options in the REST step. For more information, see [REST step](https://www.servicenow.com/docs/eu3lP8HWXOLP2X8LBMvJuA "Send an outbound REST web service request to an external system."). Importing an OpenAPI Specification creates a record in the OpenAPIs \[sys_openapi\] table. You can view or delete specification records directly from this table. To update a specification, delete it and import it again. ## Design considerations {#open-api-integration__section_bhg_hzm_ygb} Create a REST step from an OpenAPI Specification with these considerations in mind. Remove unnecessary REST step parameters : When importing an OpenAPI Specification, the system adds all parameters and headers present in the specification to the REST step. Review the final REST step values and remove parameters you do not want to send in the request. For example, if the API accepts content type headers for both JSON and XML, the system adds both headers to the REST step. Remove one of the headers depending on the content type you want to receive in the response. Make input labels user-friendly : Ensure that input labels required for the REST step are clear and understandable. Clear labels enable flow designers to easily understand the required inputs when using the action in a flow. Remove inputs that do not require flow designer configuration : When importing an OpenAPI Specification, the system adds all inputs present in the specification to the action input section. Remove any inputs that do not require a flow designer to configure. For example, if a REST step variable receives a value from another step in the action, an action input is not required. Avoid changing the API operation : Changing the value of the API Operation field removes all values dependent on that operation. If you configure the OpenAPI Specification values in the REST step form, then change the operation, the system does not save your configuration. Values that are entered manually by a user are not affected. ## Limitations {#open-api-integration__section_igf_lbp_zhb} Create a REST step from an OpenAPI Specification with these limitations. Request body media types : The request body only supports JSON and XML-based media types. If the selected operation from the imported OpenAPI Specification contains a request body with a different media type, the system adds a data pill of type String to the Request body field. OpenAPI 3.0 components : OpenAPI 3.0 adds new components to Swagger 2.0 to describe an API in further detail. OpenAPI support in the REST step supports some, but not all of these components. The REST step does not currently support these components. * Schema Object: oneOf, anyOf properties * Discriminator Object * Info object: termsOfService, contact, license fields * Example Object * Link Object * Callback Object * Security Scheme Object * Security Requirements Object * Tag Object * External Documentation Object * Server Object * Specification extensions * Recursive references {#open-api-integration__ul_gtc_xbp_zhb} More information on these components is available in the OpenAPI documentation. See [OpenAPI Specification](https://swagger.io/specification/).