B2B Gateway

Back Next

Run Partner REST API request

Use a POST request with an application/json content type to run a partner flow.

To run a flow, use the following REST URL:

https://use6-b2bgw.dm-us.informaticacloud.com/b2b-gw/api/v1/partner/run

Where:

<pod>

is the name of the

Informatica Intelligent Cloud Services

point of delivery (PoD) where you access

B2B Gateway

. For example:

pod1

is the

Informatica Intelligent Cloud Services

URL. For example:

dm-us.informaticacloud.com/

For example:

https://use6-b2bgw.dm-us.informaticacloud.com/b2b-gw/api/v1/partner/run

You can copy the values of

<pod>

and

from the

B2B Gateway

URL after you access it from the My Services page of

Informatica Intelligent Cloud Services

Request syntax

To run a flow, use the following request syntax:

{
"partnerName":"<partner name>",
"direction":"<direction of flow>"
}

Where:

partner name

is the name of the partner to run the flow for. The name must not contain angled brackets (<>), backslashes (\), or double quotes ("). If the defined partner name contains backslashes, add another backslash before each existing backslash (\\). If the defined partner name contains double quotes, add a backslash before each double quote (\").

direction of flow

is the flow to run for the customer:

INBOUND

for an inbound flow and

OUTBOUND

for an outbound flow. The direction is not case sensitive.

For example:

To run the inbound flow for the customer My_Customer, use the following request syntax:

{
"partnerName":"My_Customer",
"direction":"INBOUND"
}

To run the outbound flow for the customer My_Customer, use the following request syntax:

{
"partnerName":"My_Customer",
"direction":"OUTBOUND"
}

When you run partner flows, you can also include the mapping task advanced session parameters in the Run Partner API using the mctAdvSessionProperties object.

Use the following request syntax that includes the buffer block size as advance session mapping parameter session when you run an inbound flow:

{ 
"partnerName":
"<Customer name>",
"direction":"INBOUND",
"mappingParameters": {
 "inputParameters": {"param": "no"},
 {
"inOutParameters": {
"ob_customer_param": "<parameter value>"     
},
{"mctAdvSessionProperties":
 {"Default buffer block size": "<Buffer block size in megabytes>"        
  }
}
 }

Use the following request syntax that includes the buffer block size as advance session mapping parameter session when you run an outbound flow:


{
"direction": "outbound",
"partnerName": "ob_with_parameters",
"mappingParameters":
 {
"inputParameters": 
{    
"param": "no" 
  },
"inOutParameters":
 {"ob_customer_param": "60" 
 },
"mctAdvSessionProperties": {  "Default buffer block size": "18MB" 
 }
}
}

The following table shows the sample Run Partner REST API request and the corresponding response:

Request	Response
{ "partnerName":"sony_out_ER-32909", "direction":"INBOUND", "mappingParameters": { "mctAdvSessionProperties": { "Default buffer block size": "18MB" } } }	{ "responseStatus": "SUCCESS", "responseExtraMessage": "", "responseType": "/v1/partner/run", "eventId": 15648046 }

Request

Response

{
"partnerName":"sony_out_ER-32909",
"direction":"INBOUND",
"mappingParameters": {
"mctAdvSessionProperties": {
  "Default buffer block size": "18MB"
  }
 }
}

{    "responseStatus": "SUCCESS",
     "responseExtraMessage": "",
     "responseType": "/v1/partner/run",
     "eventId": 15648046
}

Rename Saved Search

Table of Contents

B2B Gateway

B2B Gateway

Run Partner REST API request

Run Partner REST API request

Request syntax