Jump to

• Request
• Response

Retrieve Transports

get

/ic/api/b2b/v1/tpm/partners/{tpId}/transports

Retrieves all the available transports with the specified trading partner ID.

Request

Path Parameters

• tpId(required): string

  Trading partner ID.

  Example:

  /b2b/v1/tpm/partners/TP123/transports

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : TransportsRs

Match All

Show Source

• object GenericRestRs
• object TransportsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TransportRs"
                    }
                },
                "size":{
                    "type":"integer",
                    "format":"int32"
                },
                "partnerId":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : TransportsRs-allOf[1]

Type: object

Show Source

• items: array items
• partnerId: string
• size: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransportRs"
            }
        },
        "size":{
            "type":"integer",
            "format":"int32"
        },
        "partnerId":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: TransportRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TransportRs"
    }
}

Nested Schema : TransportRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object TransportRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "transportType":{
                    "type":"string"
                },
                "connectionId":{
                    "type":"string"
                },
                "connectionName":{
                    "type":"string"
                },
                "direction":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "deployedBy":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "deployedDate":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "characterEncoding":{
                    "type":"string"
                },
                "params":{
                    "$ref":"#/components/schemas/TransportParams.Params"
                },
                "tradingPartnerId":{
                    "type":"string"
                },
                "b2bIntegrations":{
                    "$ref":"#/components/schemas/TransportIntegrations"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : TransportRs-allOf[2]

Type: object

Show Source

• b2bIntegrations: object TransportIntegrations
• characterEncoding: string
• connectionId: string
• connectionName: string
• createdBy: string
• createdDate: string
• deployedBy: string
• deployedDate: string
• desc: string
• direction: string
• id: string
• name: string
• params: object TransportParams.Params
• status: string
• tradingPartnerId: string
• transportType: string
• updatedBy: string
• updatedDate: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "transportType":{
            "type":"string"
        },
        "connectionId":{
            "type":"string"
        },
        "connectionName":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "deployedBy":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "deployedDate":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "characterEncoding":{
            "type":"string"
        },
        "params":{
            "$ref":"#/components/schemas/TransportParams.Params"
        },
        "tradingPartnerId":{
            "type":"string"
        },
        "b2bIntegrations":{
            "$ref":"#/components/schemas/TransportIntegrations"
        }
    }
}

Nested Schema : TransportIntegrations

Type: object

Show Source

• integrationIdentifierPrefix: string
• integrationNamePrefix: string
• receivedIntegration: object TransportIntegrations.Integration
• sendIntegration: object TransportIntegrations.Integration

{
    "type":"object",
    "properties":{
        "integrationNamePrefix":{
            "type":"string"
        },
        "integrationIdentifierPrefix":{
            "type":"string"
        },
        "sendIntegration":{
            "$ref":"#/components/schemas/TransportIntegrations.Integration"
        },
        "receivedIntegration":{
            "$ref":"#/components/schemas/TransportIntegrations.Integration"
        }
    }
}

Nested Schema : TransportParams.Params

Type: object

Show Source

• param: array param
  Gets the value of the param property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the param property. For example, to add a new item, do as follows: getParam().add(newItem); Objects of the following type(s) are allowed in the list Transport.Params.Param

{
    "type":"object",
    "properties":{
        "param":{
            "type":"array",
            "description":"Gets the value of the param property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the param property.\n \n \n For example, to add a new item, do as follows:\n \n    getParam().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n Transport.Params.Param",
            "items":{
                "$ref":"#/components/schemas/TransportParams.Params.Param"
            }
        }
    }
}

Nested Schema : TransportIntegrations.Integration

Type: object

Show Source

• code: string
• name: string
• reason: string
• scheduleDefined: boolean
• state: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "scheduleDefined":{
            "type":"boolean"
        }
    }
}

Nested Schema : param

Type: array

Gets the value of the param property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the param property. For example, to add a new item, do as follows: getParam().add(newItem); Objects of the following type(s) are allowed in the list Transport.Params.Param

Show Source

• Array of: object TransportParams.Params.Param

{
    "type":"array",
    "description":"Gets the value of the param property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the param property.\n \n \n For example, to add a new item, do as follows:\n \n    getParam().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n Transport.Params.Param",
    "items":{
        "$ref":"#/components/schemas/TransportParams.Params.Param"
    }
}

Nested Schema : TransportParams.Params.Param

Type: object

Show Source

• name: string
  Gets the value of the type property. possible object is String
• value: string
  Gets the value of the value property. possible object is String

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"Gets the value of the value property.\n \n     possible object is\n     String"
        },
        "name":{
            "type":"string",
            "description":"Gets the value of the type property.\n \n     possible object is\n     String"
        }
    }
}

412 Response

Pre-condition failure

500 Response

Server error

Back to Top