Skip to main content Skip to complementary content

Creating a new REST API metadata from file


  1. In the Repository tree view of the Integration perspective, right-click the REST API Definitions node under the Metadata node and select Create API definition from the contextual menu.
    The Import API definition wizard opens.
    "Import API definition" dialog box.
  2. Select Import from file, choose an API format from OAS/Swagger 2.0 or OAS 3.0 and browse to the local REST API file.
    An automatic validation of the API is performed. If the file is valid, the Next and Finish buttons are enabled. If the validation fails, it is not possible to proceed. However, in case the validation shows only warnings, you can check the warnings using the link provided in this dialog and see if you can proceed with these warnings or not. For most use cases, warnings are not relevant and only shows information that you need to pay attention to, and the dialog still allows you to proceed with the Next and Finish actions.
  3. Click Next to show the API Definition properties that are filled automatically with the content of the API.
    "Import API definition" dialog box.
    API Definition properties
    Field Description
    Name The name of API Definition. This field is editable.

    Note that a message comes up if you enter prohibited characters.

    Purpose Purpose or any useful information regarding the API Definition. This field is editable.
    Description Description containing any information that helps you describe what the API Definition does and how it does it. This field is editable.
    Author A read-only field that shows by default the current user login.
    Locker A read-only field that shows by default the login of the user who owns the lock on the current Job. This field is empty when you are creating an API definition and has data only when you are editing the properties of an existing API.
    Version A read-only field. You can manually increment the version using the M and m buttons.
    Status A list to select from the status of the Job you are creating.
    Path A list to select from the folder in which the API definition will be created.
  4. Click Finish to validate the creation and close the wizard.
    The API definition you created is now listed under the Metadata > REST API Definitions node in the Repository tree view.
    From the context menu, you can:
    • Edit API definition: edit the API definition properties.
    • Update API definition: use the update to bring in an new version / updated version of the API Definition.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!