Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Using TIBCO PartnerExpress on the Client Side : PX REST APIs

PX REST APIs
All the operations in TIBCO PartnerExpress are exposed as RESTful APIs that can be invoked over HTTP protocol. The schema of these RESTful APIs are described by using Swagger specification in JSON format.
After you log on to TIBCO PartnerExpress, click the REST Swagger Specification tab, and then you can find the definitions of all the REST APIs in TIBCO PartnerExpress.
Figure 8 REST Swagger Specification View
Swagger
Swagger is an open source project for representing RESTful APIs. Swagger provides specifications for defining RESTful APIs, and also provides a browser based Swagger UI on which you can test and interact with the Swagger-compliant APIs while checking generated documentation.
For more information about Swagger specifications, go to http://swagger.io/.
JSON
JSON, JavaScript Object Notation, is a language-independent data format designed for interchanging data objects in human-readable text.
In JSON, data objects are represented by name/value pairs, which usually take the form of Object, Array, Value, String, and Number.
For more information about JSON format, go to http://json.org/.
Invoking PX REST APIs by Using Clients
REST being an open standard, REST APIs can be invoked through a variety of tools and frameworks regardless of whether they natively interpret Swagger specification. For example, you can write raw HTTP client code by using the Swagger specification as a guiding tool for the request and response formats, and then use tools like the official Swagger UI and SOAP UI to interpret the Swagger specification and present the customized UI. There are also tools that you can use to generate programming language specific bindings out of the Swagger specification.
This section provides instructions on how to invoke PX REST APIs by using Swagger UI Client and Swagger Java Client.
You can disable the REST interface by setting the below property in the gsengine.tra file:
java.property.gs.px.rest.disable=true
Invoking PX REST APIs by Using Swagger UI Client
Swagger UI Client is a tool that takes Swagger specification files and displays them visually. The RESTful operations in PX can be invoked by using Swagger UI Client which can show the detailed representation of each operation using the PX REST Swagger specification.
Complete the following steps to invoke PX REST APIs in Swagger UI Client:
1.
Go to https://github.com/swagger-api/swagger-ui, and click Download ZIP to download Swagger UI Client.
2.
Extract the downloaded file into a local folder, and find the dist folder in the extracted folder. Open the index.html page with your browser.
3.
Replace http://petstore.swagger.io/v2/swagger.json with https://host_name:port/px/pxserver/rest/1.0/swagger, and then click Explore. The PX REST APIs are displayed.
4.
Click List Operations to select an operation, enter the required parameters, and then click Try it out to execute the operation.
Figure 9 PX REST APIs in Swagger UI Client
Invoking PX REST APIs by Using Swagger Java Client
Swagger also supports various programming language clients. The stubs for these programming languages can be generated at the http://editor.swagger.io/ website by entering the Swagger specification for applications.
The following sample demonstrates this approach for Java which is based on the open source Jersey framework.
1.
2.
a.
Click File > Import URL / Import file, to import the Swagger specification for PX.
b.
Click Generate Client > Java.
3.
Save the java-client-generated.zip file to your local file system, extract it, and then navigate to the java-client\src\main\java\io\swagger\client directory. Open the ApiClient.java file.
4.
private Client getClient() {
  if(!this.hostMap.containsKey(this.basePath)) {
      DefaultClientConfig config = new DefaultClientConfig();
      config.getClasses().add(com.sun.jersey.multipart.impl.MultiPartWriter.class);
    Client client = Client.create(config);
    if(this.debugging) {
        client.addFilter(new LoggingFilter());
        }
      this.hostMap.put(this.basePath, client);
  }
  return (Client)this.hostMap.get(this.basePath);
}
5.
6.
7.
    import io.swagger.client.ApiClient;
import io.swagger.client.api.DefaultApi;
import io.swagger.client.model.GetInboxTransactionListResponse;
import io.swagger.client.model.InboxTransactionRow;
import io.swagger.client.model.LogonResponse;
import io.swagger.client.model.UploadFileResponse;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLSession;
import java.io.File;
import java.io.FileOutputStream;
import java.util.List;
public class SwaggerRESTClient {
public static void main(String args []) throws Exception {
System.setProperty("javax.net.ssl.trustStore", "BC_HOME\\samples\\keys\\bc_trustcacertstore.jks");
HttpsURLConnection.setDefaultHostnameVerifier(new HostnameVerifier() {
public boolean verify(String s, SSLSession sslSession) {
return true;
}
});
ApiClient client = new ApiClient();
client.setBasePath("https://host_name:port/px/pxserver/rest/1.0");
DefaultApi defaultApi = new DefaultApi(client);
// Logon
LogonResponse logonResponse = defaultApi.logon("user", "user", "partner");
String sessionId = logonResponse.getSession();
System.out.println("Session ID = " + sessionId);
// File upload
File file = new File("BC_HOME\\protocols\\tibedi\\samples\\sampleDocs\\X12_4030_850.dat");
UploadFileResponse fileResponse = defaultApi.uploadFile(file, "X12", "EDI/Inbound/Interchange", sessionId, null, null);
System.out.println("File upload status = " + fileResponse.getResult());
// Get pending downloads
GetInboxTransactionListResponse ibTxnListResponse = defaultApi.getInboxTransactionList("0", "100", "[]", "[]", sessionId);
List<InboxTransactionRow> inboxTransactionRows = ibTxnListResponse.getRows();
if(inboxTransactionRows != null) {
for(InboxTransactionRow row : inboxTransactionRows)
// Issue file download
if("Server Request Awaiting".equals(row.getSTATUS()) || "Server Response Awaiting".equals(row.getSTATUS())) {
System.out.println("Downloading file for transaction id = " + row.getBCTRANSID());
String fileStr = defaultApi.downloadFile(row.getUSERTRANSID(), row.getBCTRANSID(), row.getPROTOCOLNAME(), row.getOPERATIONID(), sessionId);
byte[] fileBytes = fileStr.getBytes();
FileOutputStream fileOutputStream = new FileOutputStream("c:/temp/filedownload" + row.getBCTRANSID() +".dat");
fileOutputStream.write(fileBytes);
fileOutputStream.close();
}
}
// Logout
defaultApi.logout(sessionId);
System.out.println("Logout, exiting...");
}
}
PX REST Operations
This section provides an overview of all the RESTful operations in TIBCO PartnerExpress. These RESTful operations are categorized according to the HTTP methods they use, including GET, POST, PUT, and DELETE.
 
Table 2 Overview of the RESTful Operations
partner: the partner name that you are associated with. This parameter is optional, and you can also leave it blank.
user: the name of the client that is set up by the PartnerExpress server administrator.
password: the password for the client that is set up by the PartnerExpress server administrator.
Returns the session ID that can be used to authenticate all the subsequent requests.
user: the name of the client that is set up by the PartnerExpress server administrator.
appKey: the alphanumeric string that is provided by the PartnerExpress server administrator.
session ID: this value is returned by the GET/logon operation.
type: the type of the query, which is history or inbox.
session ID: this value is returned by the GET/logon operation.
startRow: this value specifies that transactions from which row on are returned by the response. For example, if the startRow is 2, the response returns transactions from row 3 on.
maxRow: this value specifies the maximum rows of transactions that can be returned in the response.
sort: this value specifies what sort of information about the transactions is returned by the response.
conditions: the query conditions, such as [{"name": "PROTOCOL_NAME", "operator": "EQUALS", "value": "string"}]. If timestamp (TS) is used in the conditions, it has to be in the "yyyy-mm-dd" format, such as "2015-09-10".
session ID: this value is returned by the GET/logon operation.
Note: When timestamp (TS) is used in the conditions, for operator "EQUALS", all the transactions that occur within that day are returned; while for operator "NOT_EQUALS", all the transactions that did not occur within that day are returned.
transaction ID: this is the bc transaction ID.
session ID: this value is returned by the GET/logon operation.
startRow: this value specifies that transactions from which row on are returned by the response. For example, if the startRow is 2, the response returns transactions from row 3 on.
maxRow: this value specifies the maximum rows of transactions that can be returned in the response.
sort: this value specifies what sort of information about the transactions is returned by the response.
conditions: the query conditions, such as [{"name": "PROTOCOL_NAME", "operator": "EQUALS", "value": "string"}]. If timestamp (TS) is used in the conditions, it has to be in the "yyyy-mm-dd" format, such as "2015-09-10".
session ID: this value is returned by the GET/logon operation.
Note: When timestamp (TS) is used in the conditions, for operator "EQUALS", all the transactions that occur within that day are returned; whereas for operator "NOT_EQUALS", all the transactions that did not occur within that day are returned.
transaction ID: this is the bc transaction ID.
session ID: this value is returned by the GET/logon operation.
session ID: this value is returned by the GET/logon operation.
user_transaction_id, bc_transaction_id, protocol, operation: values of these parameters are returned by the GET/inboxtransactionlist operation.
session ID: this value is returned by the GET/logon operation.
Returns the file content. The content type of the HTTP response is application/octet-stream and content disposition is attachment;filename=xxx.
all: if this value is true, for each protocol, all operations for business transactions are fetched; if this value is false, for each protocol, all operations for file upload transactions are fetched. For EDI protocols, only the "EDI/Inbound/Interchange" or "EDI/Inbound" operations for file upload transactions are fetched when this value is false.
session ID: this value is returned by the GET/logon operation.
name: the name of the query.
conditions: the query conditions, such as [{"name": "OPERATION_ID", "value": "850", "operator": "EQUALS"}]
type: the type of the query, that is inbox or history.
session ID: this value is returned by the GET/logon operation.
Note: The Swagger schema type "QueryField" lists the valid fields for query conditions. For query type inbox, use the fields PROTOCOL_NAME, USER_TRANS_ID, GSUSER, STREAM_SIZE, OPERATION_ID, STATUS, and TS as the conditions. For query type history, use the fields PROTOCOL_NAME, USER_TRANS_ID, OPERATION_ID, STATUS, and TS as the conditions.
Returns the object ID (oid) of the created query. This oid value is required when you delete or update the query.
The file content is embedded as multipart form data. The content type of the HTTP request is multipart/form-data, and the content type of the part containing the file is application/octet-stream. The remaining request parameters are sent as regular query string parameters like the parameters of other operations.
file-upload: if you want to upload a file, specify a file for uploading; if not, you can leave it blank.
user_transaction_id: leave it blank, or get this value from the response returned by the GET/inboxtransactionlist operation.
bc_transaction_id: leave it blank, or get this value from the response returned by the GET/inboxtransactionlist operation.
protocol: the protocol name, such as EZComm.
operation: the operation ID, such as BC/1.0/Notify.
session ID: this value is returned by the GET/logon operation.
oid: the ID of the query object, which is returned by the POST/query operation.
conditions: enter your new search conditions.
session ID: this value is returned by the GET/logon operation.
oldpassword: your old logon password.
newpassword: your new logon password.
session ID: this value is returned by the GET/logon operation.
oid: the array of query object IDs to be deleted.
session ID: this value is returned by the GET/logon operation.
HTTP Wire Format
This section provides some examples of how the REST requests and responses are transported over HTTP.
All query parameter values have to be encoded appropriately for HTTP URL.
In general, all request parameters are passed in as HTTP query string parameter values. The only exception is file upload, where in addition to query string parameters, the file content is presented in the request body as a multipart form file control.
Similarly, all responses are JSON-formatted texts in the HTTP response body except for file download, where the file content is embedded in the response body.
Logon
The following table provides an example of the HTTP request and response messages for the logon operation.
Host: host_name:6809
File Upload
The following table provides an example of the HTTP request and response messages for the file upload operation.
Host: host_name:6809
File Download
To download a file, you have to perform the GET/inboxtransactionlist operation first to get the transaction ID, and then perform the file download operation.
The following table provides an example of the HTTP request and response messages for the GET/inboxtransactionlist operation:
Host: host_name:6809
The following table provides an example of the HTTP request and response messages for the file download operation:
Host: host_name:6809
 
JSON Request Parameters Example
Some request parameters and most responses are in JSON format. This is used to represent complex request parameters as simple request parameters when they are passed as query string parameters. For complex request parameters that are JSON-encoded, additional encoding has to be made to make them suitable for being passed in the HTTP query string URL. The JSON schema of the complex request parameters are specified in PX REST Swagger Specification.
The following is an example of a complex JSON request schema and its specific parameters:
"type":"array","items":{"$ref":"#/definitions/Condition"}
[
{
"name":"PROTOCOL_NAME",
"value":"X12",
"type":"STRING",
"operator":"EQUALS"
},
{
"name":"OPERATION_ID",
"value":"EDI/Inbound/Interchange",
"type":"STRING",
"operator":"EQUALS"
}
]
Because Swagger only supports string type of request parameters, the complex JSON schema is described in the Description field.
PX REST Swagger Specification
This section provides the Swagger specification of the PX REST APIs.
{
"swagger":"2.0",
"basePath":"/px/pxserver/rest/1.0",
"schemes":[
"https"
],
"info":{
"title":"Tibco BusinessConnect Partner Express (PX) REST API",
"description":"REST interface to Partner Express (PX)",
"contact":{
"name":"Tibco Software Inc",
"url":"http://www.tibco.com/support",
"email":"support@tibco.com"
},
"version":"6.2.1"
},
"paths":{
"/logon":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"logon",
"parameters":[
{
"name":"partner",
"in":"query",
"required":false,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"user",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"password",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/logonResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/query":{
"post":{
"description":"",
"produces":[
"application/json"
],
"operationId":"createQuery",
"parameters":[
{
"name":"name",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"conditions",
"in":"query",
"required":true,
"description":"\"type\":\"array\",\"items\":{\"$ref\":\"#\/definitions\/QueryCondition\"}",
"type":"string"
},
{
"name":"type",
"in":"query",
"required":true,
"description":"\"type\":\"string\",\"enum\":[\"history\",\"inbox\"]",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/createQueryResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
},
"put":{
"description":"",
"produces":[
"application/json"
],
"operationId":"updateQuery",
"parameters":[
{
"name":"oid",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"conditions",
"in":"query",
"required":true,
"description":"\"type\":\"array\",\"items\":{\"$ref\":\"#\/definitions\/QueryCondition\"}",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/updateQueryResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
},
"delete":{
"description":"",
"produces":[
"application/json"
],
"operationId":"deleteQuery",
"parameters":[
{
"name":"oid",
"in":"query",
"required":true,
"description":"\"type\":\"array\",\"items\":{\"$ref\":\"#\/definitions\/String\"}",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/deleteQueryResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/logonurl":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"generateLogonURL",
"parameters":[
{
"name":"user",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"appKey",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/generateLogonURLResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/historytransactionlist":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"getHistoryTransactionList",
"parameters":[
{
"name":"startRow",
"in":"query",
"required":true,
"description":"\"type\":\"integer\"",
"type":"string"
},
{
"name":"maxRow",
"in":"query",
"required":true,
"description":"\"type\":\"integer\"",
"type":"string"
},
{
"name":"sort",
"in":"query",
"required":true,
"description":"\"type\":\"array\",\"items\":{\"$ref\":\"#\/definitions\/HistoryTransactionSort\"}",
"type":"string"
},
{
"name":"conditions",
"in":"query",
"required":true,
"description":"\"type\":\"array\",\"items\":{\"$ref\":\"#\/definitions\/HistoryTransactionCondition\"}",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/getHistoryTransactionListResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/inboxtransactionsummary":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"getInboxTransactionSummary",
"parameters":[
{
"name":"transaction",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/getInboxTransactionSummaryResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/logout":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"logout",
"parameters":[
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/logoutResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/password":{
"put":{
"description":"",
"produces":[
"application/json"
],
"operationId":"changePassword",
"parameters":[
{
"name":"oldpassword",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"newpassword",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/changePasswordResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
}
},
"/operations":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"getOperations",
"parameters":[
{
"name":"all",
"in":"query",
"required":true,
"description":"\"type\":\"boolean\"",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/getOperationsResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/file":{
"get":{
"description":"",
"produces":[
"application/octet-stream"
],
"operationId":"downloadFile",
"parameters":[
{
"name":"user_transaction_id",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"bc_transaction_id",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"protocol",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"operation",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"type":"string"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
},
"post":{
"description":"",
"produces":[
"application/json"
],
"consumes":[
"multipart/form-data"
],
"operationId":"uploadFile",
"parameters":[
{
"name":"file-upload",
"in":"formData",
"required":true,
"description":"File upload",
"type":"file"
},
{
"name":"user_transaction_id",
"in":"query",
"required":false,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"bc_transaction_id",
"in":"query",
"required":false,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"protocol",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"operation",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/uploadFileResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/historytransactionsummary":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"getHistoryTransactionSummary",
"parameters":[
{
"name":"transaction",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/getHistoryTransactionSummaryResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/downloaduploadinfo":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"getDownloadUploadInfo",
"parameters":[
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/getDownloadUploadInfoResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/querylist":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"getQueryList",
"parameters":[
{
"name":"type",
"in":"query",
"required":true,
"description":"\"type\":\"string\",\"enum\":[\"history\",\"inbox\"]",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/getQueryListResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"/inboxtransactionlist":{
"get":{
"description":"",
"produces":[
"application/json"
],
"operationId":"getInboxTransactionList",
"parameters":[
{
"name":"startRow",
"in":"query",
"required":true,
"description":"\"type\":\"integer\"",
"type":"string"
},
{
"name":"maxRow",
"in":"query",
"required":true,
"description":"\"type\":\"integer\"",
"type":"string"
},
{
"name":"sort",
"in":"query",
"required":true,
"description":"\"type\":\"array\",\"items\":{\"$ref\":\"#\/definitions\/InboxTransactionSort\"}",
"type":"string"
},
{
"name":"conditions",
"in":"query",
"required":true,
"description":"\"type\":\"array\",\"items\":{\"$ref\":\"#\/definitions\/InboxTransactionCondition\"}",
"type":"string"
},
{
"name":"session",
"in":"query",
"required":true,
"description":"\"type\":\"string\"",
"type":"string"
}
],
"responses":{
"200":{
"description":"Success",
"schema":{
"$ref":"#/definitions/getInboxTransactionListResponse"
}
},
"400":{
"description":"Error processing request",
"schema":{
"$ref":"#/definitions/Error"
}
}
}
}
},
"definitions":{
"logoutResponse":{
"properties":{
"result":{
"type":"string"
}
}
},
 
"getOperationsResponse":{
"properties":{
"result":{
"type":"array",
"items":{
"$ref":"#/definitions/ProtocolOperation"
}
}
}
},
"getHistoryTransactionSummaryResponse":{
"properties":{
"totalRows":{
"type":"integer"
},
"rows":{
"type":"array",
"items":{
"$ref":"#/definitions/HistoryTransactionSummary"
}
}
}
},
"logonResponse":{
"properties":{
"session":{
"type":"string"
},
"user":{
"type":"object",
"$ref":"#/definitions/User"
}
}
},
"generateLogonURLResponse":{
"properties":{
"url":{
"type":"string"
},
"user":{
"type":"object",
"$ref":"#/definitions/User"
}
}
},
"getHistoryTransactionListResponse":{
"properties":{
"conditions":{
"type":"array",
"items":{
"$ref":"#/definitions/HistoryTransactionCondition"
}
},
"totalRows":{
"type":"integer"
},
"rows":{
"type":"array",
"items":{
"$ref":"#/definitions/HistoryTransactionRow"
}
}
}
},
"getDownloadUploadInfoResponse":{
"properties":{
"data":{
"type":"array",
"items":{
"$ref":"#/definitions/DownloadUploadInfo"
}
},
"download":{
"type":"object",
"$ref":"#/definitions/DownloadInfo"
},
"upload":{
"type":"object",
"$ref":"#/definitions/UploadInfo"
}
}
},
"getQueryListResponse":{
"properties":{
"result":{
"type":"array",
"items":{
"$ref":"#/definitions/Query"
}
}
}
},
"getInboxTransactionSummaryResponse":{
"properties":{
"totalRows":{
"type":"integer"
},
"rows":{
"type":"array",
"items":{
"$ref":"#/definitions/InboxTransactionSummary"
}
}
}
},
"getInboxTransactionListResponse":{
"properties":{
"conditions":{
"type":"array",
"items":{
"$ref":"#/definitions/InboxTransactionCondition"
}
},
"totalRows":{
"type":"integer"
},
"rows":{
"type":"array",
"items":{
"$ref":"#/definitions/InboxTransactionRow"
}
}
}
},
"uploadFileResponse":{
"properties":{
"result":{
"type":"string"
}
}
},
"createQueryResponse":{
"properties":{
"oid":{
"type":"string"
}
}
},
"changePasswordResponse":{
"properties":{
"result":{
"type":"string"
}
}
},
"updateQueryResponse":{
"properties":{
"result":{
"type":"string"
}
}
},
"deleteQueryResponse":{
"properties":{
"result":{
"type":"string"
}
}
},
"QueryCondition":{
"properties":{
"name":{
"type":"string",
"enum":[
"PROTOCOL_NAME",
"TPNAME",
"USER_TRANS_ID",
"GSUSER",
"STREAM_SIZE",
"OPERATION_ID",
"STATUS",
"TS"
]
},
"operator":{
"type":"string",
"enum":[
"EQUALS",
"NOT_EQUALS",
"LIKE",
"NOT_LIKE"
]
},
"value":{
"type":"string"
}
}
},
"HistoryTransactionSort":{
"properties":{
"name":{
"type":"string",
"enum":[
"PROTOCOL_NAME",
"USER_TRANS_ID",
"BC_TRANS_ID",
"OPERATION_ID",
"STATUS",
"TS",
"TPNAME"
]
},
"inc":{
"type":"boolean"
}
}
},
"HistoryTransactionCondition":{
"properties":{
"name":{
"type":"string",
"enum":[
"PROTOCOL_NAME",
"USER_TRANS_ID",
"BC_TRANS_ID",
"OPERATION_ID",
"STATUS",
"TS",
"TPNAME"
]
},
"operator":{
"type":"string",
"enum":[
"EQUALS",
"NOT_EQUALS",
"LIKE",
"NOT_LIKE"
]
},
"value":{
"type":"string"
}
}
},
"DownloadUploadInfo":{
"properties":{
"id":{
"type":"string"
},
"type":{
"type":"string"
},
"name":{
"type":"string"
},
"total":{
"type":"number"
},
"current":{
"type":"number"
},
"user_transaction_id":{
"type":"string"
},
"protocol":{
"type":"string"
},
"operation":{
"type":"string"
},
"bc_transaction_id":{
"type":"string"
},
"startTime":{
"type":"string"
}
}
},
"InboxTransactionSort":{
"properties":{
"name":{
"type":"string",
"enum":[
"PROTOCOL_NAME",
"USER_TRANS_ID",
"OPERATION_ID",
"STATUS",
"TS",
"TPNAME"
]
},
"inc":{
"type":"boolean"
}
}
},
"ProtocolOperation":{
"properties":{
"protocol":{
"type":"string"
},
"operations":{
"type":"array",
"items":{
"$ref":"#/definitions/Operation"
}
}
}
},
"InboxTransactionCondition":{
"properties":{
"name":{
"type":"string",
"enum":[
"PROTOCOL_NAME",
"USER_TRANS_ID",
"OPERATION_ID",
"STATUS",
"TS",
"TPNAME"
]
},
"operator":{
"type":"string",
"enum":[
"EQUALS",
"NOT_EQUALS",
"LIKE",
"NOT_LIKE"
]
},
"value":{
"type":"string"
}
}
},
"Query":{
"properties":{
"conditions":{
"type":"array",
"items":{
"$ref":"#/definitions/QueryCondition"
}
},
"name":{
"type":"string"
},
"type":{
"type":"string",
"enum":[
"history",
"inbox"
]
},
"editable":{
"type":"boolean"
},
"oid":{
"type":"string"
},
"description":{
"type":"string"
},
"partner":{
"type":"string"
},
"user":{
"type":"string"
}
}
},
"UploadInfo":{
"properties":{
"finish":{
"type":"number"
},
"active":{
"type":"number"
}
}
},
"User":{
"properties":{
"host":{
"type":"string"
},
"readOnly":{
"type":"boolean"
},
"name":{
"type":"string"
},
"partner":{
"type":"string"
}
}
},
"Operation":{
"properties":{
"operation":{
"type":"string"
},
"type":{
"type":"string",
"enum":[
"notify",
"asyncRequestResponse"
]
}
}
},
"HistoryTransactionSummary":{
"properties":{
"Operation":{
"type":"string"
},
"Status":{
"type":"string"
},
"Date":{
"type":"string"
},
"ID":{
"type":"string"
},
"Protocol":{
"type":"string"
}
}
},
"DownloadInfo":{
"properties":{
"finish":{
"type":"number"
},
"active":{
"type":"number"
}
}
},
"HistoryTransactionRow":{
"properties":{
"PROTOCOL_NAME":{
"type":"string"
},
"TPNAME":{
"type":"string"
},
"USER_TRANS_ID":{
"type":"string"
},
"BC_TRANS_ID":{
"type":"string"
},
"TS":{
"type":"string"
},
"STATUS":{
"type":"string"
},
"OPERATION_ID":{
"type":"string"
}
}
},
"InboxTransactionSummary":{
"properties":{
"Host":{
"type":"string"
},
"Status":{
"type":"string"
},
"Operation":{
"type":"string"
},
"Date":{
"type":"string"
},
"ID":{
"type":"string"
},
"Protocol":{
"type":"string"
},
"Size":{
"type":"integer"
}
}
},
"InboxTransactionRow":{
"properties":{
"PROTOCOL_NAME":{
"type":"string"
},
"PROCESSING":{
"type":"boolean"
},
"USER_TRANS_ID":{
"type":"string"
},
"BC_TRANS_ID":{
"type":"string"
},
"STATUS":{
"type":"string"
},
"SIZE":{
"type":"integer"
},
"TS":{
"type":"string"
},
"ACTION":{
"type":"string"
},
"OPERATION_ID":{
"type":"string"
},
"ATTACHMENT":{
"type":"boolean"
},
"USER":{
"type":"string"
}
}
},
"Error":{
"properties":{
"error":{
"type":"string"
}
}
}
}
}
 

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved