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.
|
|
|
|
|
|
|
|
|
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.
|
Returns the list of all the Inbox transactions and their detailed information, including the protocol name, processing status, user transaction ID, BC transaction ID, action, TS, size, status, operation ID, user name, and attachment status.
|
|
|
|
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.
|
|