Tabs | Tab Details and Description |
Basic Information | The basic API details. API Name API Description API Version Maturity State Gateway Endpoint OData Version (for OData API only) For information on these API details, see the webMethods API Portal Consumer's Guide. |
REST API Details | |
Specifications | The standard specification format defined for the REST API. The supported specification formats for REST API are: RAML SWAGGER |
Access Policy | The combination of the identification condition and identification types indicating how the API can be accessed. Identification Condition. The combination in which the identifiers must be used such as AND or OR conditions. Identification Types.The identifiers to invoke the API such as an oAuth2 token or API Key. |
Resources and Methods | The list of resources or methods available in the API. Click each resource to view the corresponding HTTP methods, along with a summary. Below each of these methods, details such as parameters and response codes appear. |
Technical Information | The representation of the API schema. Name. Name of the object. Value. Key and value pairs represented in JSON or XML format. |
SOAP API Details | |
Specifications | The standard specification format defined for the SOAP API, WSDL. |
Access Policy | The combination of the identification condition and identification types indicating how the API can be accessed. Identification Condition. The combination in which the identifiers must be used such as AND or OR conditions. Identification Types.The identifiers to invoke the API such as an oAuth2 token or API Key. |
Operations | The list of operations available in the API. Operations are displayed along with their type of binding (SOAP 11 , SOAP 12, and other HTTP methods). Expand each method to view details such as input, output, and fault messages. |
REST Transformation | The list of operations exposed as REST resources. Operations are displayed along with the type of binding. |
ODATA API Details | |
Specifications | The standard specification format defined for the OData API, OData. This document describes the entity types, entity sets, functions, and actions. |
OData Action Import | The action import element represents an action in an entity model. Click each action import to view the resource path, entity type, and the corresponding HTTP methods. |
OData Entity-sets | The entity set element represents a single entity or a collection of entities of a specific entity type in the data model. Click each entity set to view the resource path, entity type, resource parameter details, and the corresponding HTTP methods. |
OData Singletons | Singletons are single entities appear as children of the entity container. Click each singleton to view the resource path, entity type, the corresponding HTTP methods, and the navigation properties that allow navigation from an entity to related entities. |
OData Function Import | The function import element represents a function in an entity model. It displays a list of OData function imports. Click each function import to view the resource path, entity type, and the corresponding HTTP methods. |