Jump to

• Request
• Response

Migrate Trading Partners from SOA-B2B

post

/ic/api/b2b/v1/migration/partners/import

Imports one or more trading partners with the associated B2B related artifacts such as agreements, documents, schemas, and host identifiers from the exported SOA-B2B design-time repository zip file.

Request

Query Parameters

• isFileZipOfZip(required): boolean

  If the imported zip file contains multiple zip files, then set this boolean value to true. The default value is false.

  Example:

  ic/api/b2b/v1/migration/partners/import?isFileZipOfZip=true

  Default Value: false
• isOverwrite(required): boolean

  To overwrite an existing trading partner and replace it with the new trading partner imported from the zip file, then set this boolean flag to true. The default value is false.

  Example:

  ic/api/b2b/v1/migration/partners/import?isOverwrite=true

  Default Value: false

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file: string (binary)
  Exported SOA-B2B trading partner zip file.
• option: string

  This is an optional property. Use this property to specify how you want to display the filenames of the imported files. The following options are available:

  showDescription: Set this value to true to display the description.

  description: Specify the description that you want to show for the imported trading partner.

  documentPrefix: Specify a value if you want to prefix any text to the filenames of the imported documents.

  schemaPrefix: Specify a value if you want to prefix any text to the file names of the imported schemas.

  filter: You have include and exclude filter options. To include TP/TPA files from the zip file, use the include parameter. To exclude TP/TPA files from the zip file, use the exclude parameter.

  Example:

  {"showDescription":"true","description":"IMPORT FROM SOA-B2b ","schemaPrefix":"SCH","documentPrefix":"DOC","filter":{"exclude":{"tpId":["tp_1","tp_2"],"tpa":["tpa_1","tpa_2"]},"include":{"tpId":[],"tpa":[]}}}

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "description":"Exported SOA-B2B trading partner zip file.",
            "format":"binary"
        },
        "option":{
            "type":"string",
            "description":"<p>This is an optional property. Use this property to specify how you want to display the filenames of the imported files. The following options are available:</p>\n<p>showDescription: Set this value to true to display the description.</p>\n<p>description: Specify the description that you want to show for the imported trading partner.</p>\n<p>documentPrefix: Specify a value if you want to prefix any text to the filenames of the imported documents.</p>\n<p>schemaPrefix: Specify a value if you want to prefix any text to the file names of the imported schemas.</p>\n<p>filter: You have include and exclude filter options. To include TP/TPA files from the zip file, use the include parameter. To exclude TP/TPA files from the zip file, use the exclude parameter.</p>\n<p>\n<b>Example:</b> \n</p> \n <pre>{\"showDescription\":\"true\",\"description\":\"IMPORT FROM SOA-B2b \",\"schemaPrefix\":\"SCH\",\"documentPrefix\":\"DOC\",\"filter\":{\"exclude\":{\"tpId\":[\"tp_1\",\"tp_2\"],\"tpa\":[\"tpa_1\",\"tpa_2\"]},\"include\":{\"tpId\":[],\"tpa\":[]}}}</pre>",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : TPMigrationImportRestResponse

Match All

Show Source

• object GenericRestRs
• object TPMigrationImportRestResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "required":[
                "option",
                "response"
            ],
            "type":"object",
            "properties":{
                "response":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TPMigrationService.ServiceResponse"
                    }
                },
                "option":{
                    "$ref":"#/components/schemas/ImportOption"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : TPMigrationImportRestResponse-allOf[1]

Type: object

Show Source

• option(required): object ImportOption
• response(required): array response

{
    "required":[
        "option",
        "response"
    ],
    "type":"object",
    "properties":{
        "response":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TPMigrationService.ServiceResponse"
            }
        },
        "option":{
            "$ref":"#/components/schemas/ImportOption"
        }
    }
}

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 : ImportOption

Type: object

Show Source

• debug: string
• description: string
• documentPrefix: string
• filter: object ImportOption.Filter
• schemaPrefix: string
• showDescription: string

{
    "type":"object",
    "properties":{
        "debug":{
            "type":"string"
        },
        "showDescription":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "schemaPrefix":{
            "type":"string"
        },
        "documentPrefix":{
            "type":"string"
        },
        "filter":{
            "$ref":"#/components/schemas/ImportOption.Filter"
        }
    }
}

Nested Schema : response

Type: array

Show Source

• Array of: object TPMigrationService.ServiceResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TPMigrationService.ServiceResponse"
    }
}

Nested Schema : ImportOption.Filter

Type: object

Show Source

• exclude: object ImportOption.Attribute
• include: object ImportOption.Attribute

{
    "type":"object",
    "properties":{
        "exclude":{
            "$ref":"#/components/schemas/ImportOption.Attribute"
        },
        "include":{
            "$ref":"#/components/schemas/ImportOption.Attribute"
        }
    }
}

Nested Schema : ImportOption.Attribute

Type: object

Show Source

• tpa: array tpa
• tpId: array tpId

{
    "type":"object",
    "properties":{
        "tpId":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tpa":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : tpa

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : tpId

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : TPMigrationService.ServiceResponse

Type: object

Show Source

• _execution: object TPMigrationService.Summary
• importStatus(required): string
• report(required): array report
• zipfileName: string

{
    "required":[
        "importStatus",
        "report"
    ],
    "type":"object",
    "properties":{
        "importStatus":{
            "type":"string"
        },
        "report":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport"
            }
        },
        "zipfileName":{
            "type":"string"
        },
        "_execution":{
            "$ref":"#/components/schemas/TPMigrationService.Summary"
        }
    }
}

Nested Schema : TPMigrationService.Summary

Type: object

Show Source

• importTimeInMillis: integer (int64)
• noOfDocumentImported: string
• noOfInboundAgreementImported: string
• noOfOutboundAgreementImported: string
• noOfSchemaImported: string
• noOfTransportImported: string
• parseTimeInMillis: integer (int64)
• totalTimeInMillis: integer (int64)

{
    "type":"object",
    "properties":{
        "noOfTransportImported":{
            "type":"string"
        },
        "noOfInboundAgreementImported":{
            "type":"string"
        },
        "noOfOutboundAgreementImported":{
            "type":"string"
        },
        "noOfDocumentImported":{
            "type":"string"
        },
        "noOfSchemaImported":{
            "type":"string"
        },
        "parseTimeInMillis":{
            "type":"integer",
            "format":"int64"
        },
        "importTimeInMillis":{
            "type":"integer",
            "format":"int64"
        },
        "totalTimeInMillis":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : report

Type: array

Show Source

• Array of: object ProcessingReport

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

Nested Schema : ProcessingReport

Type: object

Show Source

• artifacts: object ProcessingReport.State
• status: string
• summary: string
• tpId: string
• tpName: string

{
    "type":"object",
    "properties":{
        "tpId":{
            "type":"string"
        },
        "tpName":{
            "type":"string"
        },
        "artifacts":{
            "$ref":"#/components/schemas/ProcessingReport.State"
        },
        "status":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        }
    }
}

Nested Schema : ProcessingReport.State

Type: object

Show Source

• document: array document
• error: array error
• hostIdentifier: array hostIdentifier
• ignoredAgreement: array ignoredAgreement
• inboundAgreement: array inboundAgreement
• outboundAgreement: array outboundAgreement
• schema: array schema
• transport: array transport

{
    "type":"object",
    "properties":{
        "transport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "inboundAgreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "outboundAgreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "document":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "schema":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "hostIdentifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        },
        "error":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Error"
            }
        },
        "ignoredAgreement":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProcessingReport.Status"
            }
        }
    }
}

Nested Schema : document

Type: array

Show Source

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

Nested Schema : error

Type: array

Show Source

• Array of: object Error

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

Nested Schema : hostIdentifier

Type: array

Show Source

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

Nested Schema : ignoredAgreement

Type: array

Show Source

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

Nested Schema : inboundAgreement

Type: array

Show Source

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

Nested Schema : outboundAgreement

Type: array

Show Source

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

Nested Schema : schema

Type: array

Show Source

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

Nested Schema : transport

Type: array

Show Source

• Array of: object ProcessingReport.Status

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProcessingReport.Status"
    }
}

Nested Schema : ProcessingReport.Status

Type: object

Show Source

• id: string
• name: string
• reason: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        }
    }
}

Nested Schema : Error

Type: object

Show Source

• code(required): string
• detail: string
• msg(required): string

{
    "required":[
        "code",
        "msg"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "msg":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

400 Response

Bad request

404 Response

Not found

409 Response

Duplicate data error

412 Response

Pre-condition failure

500 Response

Server error

Back to Top