Document Management

Edit online

webMethods API Gateway provides the capability to store and manage the documents associated with an API.

webMethods API Gateway provides the following REST API and the resources to manage the documents associated with APIs:

  • GET/rest/apigateway/documents/{documentId}: Retrieves the requested document from webMethods API Gateway.
  • PUT/rest/apigateway/documents/{documentId}: Updates the requested document in webMethods API Gateway.
  • DELETE/rest/apigateway/documents/{documentId}: Deletes the requested document from webMethods API Gateway.
  • PATCH/rest/apigateway/documents/{documentId}: Patches the requested document in webMethods API Gateway.
  • POST/rest/apigateway/documents: Creates and stores the documents in webMethods API Gateway.

For details on the REST API, https://github.com/SoftwareAG/webmethods-api-gateway/blob/master/apigatewayservices/APIGatewayDocumentManagement.json.

For details on sample payloads, import Postman collection from the following link in Postman client: https://github.com/SoftwareAG/webmethods-api-gateway/blob/master/apigatewayservices/postmancollections/apis/document-mangement-service/DocumentManagementService.json.