Trading Networks 10.3 | Administering and Monitoring B2B Transactions | Trading Networks User's Guide | Viewing APIs | Viewing API Details in a Partner Profile
 
Viewing API Details in a Partner Profile
Prerequisites: You must have access to at least one API to view the API details. If there is a need for your access other APIs, contact your Administrator to gain access.
You can view the details of an API that is accessible to a partner in the APIs tab of the Partner Profiles page.
*To view the details of an API in a Partner Profile
1. In My webMethods Server: Applications > Administration > B2B > Partner Administration > Partner Profiles.
2. Click a partner profile, and click APIs to view the list of APIs accessible to the partner.
3. Click the search icon of an API to view its details.
The following table describes the various tabs and the details:
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.
You can invoke any API that you view in the partner profile from API Gateway. For instructions on how to invoke an API, see the webMethods API Portal Consumer's Guide.