Software AG · Example Payload

Webmethods Create Api Example

Example of creating a new REST API in the webMethods API Gateway from an OpenAPI spec URL

API ManagementEnterprise IntegrationiPaaSwebMethodsIntegration PlatformAPI Gateway

Webmethods Create Api Example is an example object payload from Software AG, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionrequestresponse

Example Payload

Raw ↑ 
{
  "title": "Create API - Example Request and Response",
  "description": "Example of creating a new REST API in the webMethods API Gateway from an OpenAPI spec URL",
  "request": {
    "method": "POST",
    "url": "http://localhost:5555/rest/apigateway/apis",
    "headers": {
      "Authorization": "Basic YWRtaW5pc3RyYXRvcjptYW5hZ2U=",
      "Content-Type": "application/json"
    },
    "body": {
      "type": "REST",
      "apiName": "Payment Processing API",
      "apiVersion": "1.0",
      "apiDescription": "REST API for processing customer payments and transactions",
      "swagger": "https://example.com/payment-api-openapi.json"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "apiResponse": {
        "api": {
          "id": "c3d4e5f6-a7b8-9012-cdef-012345678901",
          "apiName": "Payment Processing API",
          "apiVersion": "1.0",
          "apiDescription": "REST API for processing customer payments and transactions",
          "type": "REST",
          "isActive": false,
          "tags": [],
          "maturityState": "BETA",
          "systemVersion": 1,
          "created": "2026-05-02T12:00:00Z",
          "modified": "2026-05-02T12:00:00Z"
        }
      }
    }
  }
}