IBM Transformation Extender Advanced

Preview

IBM Transformation Extender Advanced

+ Day(s) remaining in the trial

Overview

IBM Transformation Extender Advanced RESTful API enables your organization to execute advanced transformation and document processing solution across your IT infrastructure. It can help you address the increasing volumes and regulatory complexity associated with healthcare, supply chain and financial payments. IBM Transformation Extender Advanced API provides access for on-board trading partners, de-envelope , envelope, validate , acknowledge and transform documents. Supported standards are:

Healthcare: Helps address HIPAA requirements including Workgroup for Electronic Data Interchange/Strategic National Implementation Process (WEDI/SNIP) levels 1-7.

Supply chain: Addresses key management requirements such as support for X.12 and Electronic Data Interchange For Administration, Commerce and Transport (EDIFACT) standards.

Financial payments: Addresses key requirements including support for SWIFT, SEPA and ISO 20022 transactions.

Generic Transformation. Ability to transform complex data for any to any format using IBM Transformation Extender, Sterling or XSLT maps.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Transformation Extender Advanced:

CheckPendingAckStatusJob

CheckPendingAckStatusJob : Create CheckPendingAckStatusJob
Service for creating new CheckPendingAckStatusJobs.

Preconditions : None

Security : You must be a member of one of the following roles in order to execute this service: REST

POST   /checkpendingackstatusjobs

			https://dev.api.ibm.com/transform/demo/spe/svc/checkpendingackstatusjobs
		
Keys
Path and Query parameters

_password

STRING , required

passWord

_username

STRING , required

userName

Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/transform/demo/spe/svc/checkpendingackstatusjobs?_username=SOME_STRING_VALUE&_password=SOME_STRING_VALUE") .header("accept", "application/xml") .header("content-type", "application/xml") .asString();
Request model

ackStatus

STRING , required

speOptions

ARRAY , optional

async

BOOLEAN , optional

optionName

STRING , optional

optionValue

STRING , optional

Request example
{
  "ackStatus": string,
  "speOptions": [{
    "optionName": string,
    "optionValue": string
  }],
  "async": boolean
}
Response model

200

Service for creating new CheckPendingAckStatusJobs. Response

Body

Location

STRING , optional

201

Service for creating new CheckPendingAckStatusJobs. Response

Body

Location

STRING , optional

400

Bad Request

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

401

Unauthorized

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

403

Forbidden

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

404

Not found

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

500

Internal Server Error

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

default

A sytem error has occured

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

Response example

200

Service for creating new CheckPendingAckStatusJobs. Response

								{
  "Location" : string
}
							

201

Service for creating new CheckPendingAckStatusJobs. Response

								{
  "Location" : string
}
							

400

Bad Request

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

401

Unauthorized

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

403

Forbidden

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

404

Not found

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

500

Internal Server Error

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

default

A sytem error has occured

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							
CheckPendingAckStatusJob : Delete CheckPendingAckStatusJob
Service for deleting CheckPendingAckStatusJobs.

Preconditions : None

Security : You must be a member of one of the following roles in order to execute this service: REST

DELETE   /checkpendingackstatusjobs/{id}

			https://dev.api.ibm.com/transform/demo/spe/svc/checkpendingackstatusjobs/{id}
		
Keys
Path and Query parameters

id

URL , required

ID of CheckPendingAckStatusJob

_password

STRING , required

passWord

_username

STRING , required

userName

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/transform/demo/spe/svc/checkpendingackstatusjobs/%7Bid%7D?_password=SOME_STRING_VALUE&_username=SOME_STRING_VALUE") .header("accept", "application/xml") .header("content-type", "application/xml") .asString();
Response model

200

Service for deleting CheckPendingAckStatusJobs. Response

Body

rowsAffected

STRING , optional

400

Bad Request

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

401

Unauthorized

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

403

Forbidden

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

404

Not found

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

500

Internal Server Error

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

default

A sytem error has occured

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

Response example

200

Service for deleting CheckPendingAckStatusJobs. Response

								{
  "rowsAffected" : string
}
							

400

Bad Request

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

401

Unauthorized

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

403

Forbidden

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

404

Not found

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

500

Internal Server Error

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

default

A sytem error has occured

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							
CheckPendingAckStatusJob : Read CheckPendingAckStatusJobs
Service for reading CheckPendingAckStatusJobs.

Preconditions : None

Security : You must be a member of one of the following roles in order to execute this service: REST

GET   /checkpendingackstatusjobs

			https://dev.api.ibm.com/transform/demo/spe/svc/checkpendingackstatusjobs
		
Keys
Path and Query parameters

_password

STRING , required

passWord

_username

STRING , required

userName

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/transform/demo/spe/svc/checkpendingackstatusjobs?_password=SOME_STRING_VALUE&_username=SOME_STRING_VALUE") .header("accept", "application/xml") .header("content-type", "application/xml") .asString();
Response model

200

Service for reading CheckPendingAckStatusJobs. Response

Body

id

STRING , required

startTime

STRING , optional

state

STRING , optional

speresponse [SPEResponse]

object , optional

endTime

STRING , optional

400

Bad Request

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

401

Unauthorized

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

403

Forbidden

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

404

Not found

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

500

Internal Server Error

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

default

A sytem error has occured

Body

errorDiscription

STRING , required

errorCode

INTEGER , required

Response example

200

Service for reading CheckPendingAckStatusJobs. Response

								{
  "id" : string,
  "startTime" : string,
  "state" : string,
  "speresponse" : object,
  "endTime" : string
}
							

400

Bad Request

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

401

Unauthorized

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

403

Forbidden

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

404

Not found

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

500

Internal Server Error

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

default

A sytem error has occured

								{
  "errorDiscription" : string,
  "errorCode" : integer
}
							

Loading content...