IBM Sterling B2B Integration SaaS

https://www.ibm.com/docs/en/b2bis
Admin
IBM Sterling B2B Integration SaaS is a cloud-based platform designed to manage and optimize...
Tokens:235,860
Snippets:1,525
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### XML Document Structure Example

Source: https://www.ibm.com/docs/en/b2bis/index_topic=overview-xml-syntax

Demonstrates the basic structure of an XML document, including the XML declaration, root element, child elements, and their corresponding start and end tags. This example illustrates how data is organized hierarchically in XML.

```xml
<?xml version= "1.0" encoding="ISO-8859-1"?>
<note>
<to>Dick</to>
<from>Jane</from>
<heading>Notice</heading>
<body>See Spot run!</body>
</note>
```

--------------------------------

### POST /migrationpreviews

Source: https://www.ibm.com/docs/en/b2bis/index_topic=references-onboarding-migration-reports

Creates an onboarding preview report for a company. This report provides details of all code lists or maps before they are migrated.

```APIDOC
## POST /migrationpreviews

### Description
Generates an onboarding preview report that details code lists or maps for a company prior to migration. This report is essential for understanding the migration scope and potential issues.

### Method
POST

### Endpoint
/migrationpreviews

### Parameters
#### Query Parameters
None

#### Request Body
This endpoint does not explicitly define a request body in the provided text, but it is implied to be associated with a company for which the report is generated. The exact structure would depend on the system's implementation for identifying the target company.

### Request Example
```json
{
  "companyId": "123e4567-e89b-12d3-a456-426614174000"
}
```

### Response
#### Success Response (200 or 201)
- **reportId** (string) - The unique identifier for the generated onboarding preview report. This ID is used to download the report.

#### Response Example
```json
{
  "reportId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```
```

--------------------------------

### GET /migrationpreviews/{id}/report

Source: https://www.ibm.com/docs/en/b2bis/index_topic=references-onboarding-migration-reports

Downloads the onboarding preview report for a specific company, identified by its SCI ID. The report is generated by a prior POST request.

```APIDOC
## GET /migrationpreviews/{id}/report

### Description
Downloads the generated onboarding preview report. The `{id}` parameter is the Company SCI ID for which the report was created.

### Method
GET

### Endpoint
/migrationpreviews/{id}/report

### Parameters
#### Path Parameters
- **id** (string) - Required - The Company SCI ID for which the onboarding preview report was generated.

#### Query Parameters
None

### Request Example
```
GET /migrationpreviews/123e4567-e89b-12d3-a456-426614174000/report
```

### Response
#### Success Response (200)
- **Report Data** (file) - The onboarding preview report, typically in an XLS format, containing summary and detailed information about code lists or maps eligible for migration.
```

--------------------------------

### GET /ssmap/api/maps - IBMer Get Map ID using map name

Source: https://www.ibm.com/docs/en/b2bis/index_topic=environment-post-production-deployment-cleanup

Retrieves the ID of a specific map from Configuration Hub using its name. This ID is required for subsequent map operations.

```APIDOC
## GET /ssmap/api/maps

### Description
Fetches the unique identifier (Map ID) for a given map name from Configuration Hub. This Map ID is essential for performing actions like marking a map as final or deleting it.

### Method
GET

### Endpoint
https://IPandPort/ssmap/api/maps

### Parameters
#### Path Parameters
None

#### Query Parameters
- **mapName** (string) - Required - The name of the map to retrieve the ID for.
- **tenantId** (string) - Required - The tenant ID associated with the map.

### Request Example
(This endpoint is typically called with prompted input for map name and tenant ID)

### Response
#### Success Response (200 OK)
- **mapId** (string) - The unique identifier for the specified map.

#### Response Example
```json
{
  "mapId": "a1b2c3d4-e5f6-7890-1234-abcdef123456"
}
```
```

--------------------------------

### GET /sscodelist/api/codelists - IBMer Get Codelist ID using name

Source: https://www.ibm.com/docs/en/b2bis/index_topic=environment-post-production-deployment-cleanup

Retrieves the ID of a specific code list from Configuration Hub using its name. This ID is required for subsequent code list operations.

```APIDOC
## GET /sscodelist/api/codelists

### Description
Fetches the unique identifier (Codelist ID) for a given code list name from Configuration Hub. This Codelist ID is essential for performing actions like marking a code list as final or deleting it.

### Method
GET

### Endpoint
https://IPandPort/sscodelist/api/codelists

### Parameters
#### Path Parameters
None

#### Query Parameters
- **codeListName** (string) - Required - The name of the code list to retrieve the ID for.
- **tenantId** (string) - Required - The tenant ID associated with the code list.

### Request Example
(This endpoint is typically called with prompted input for code list name and tenant ID)

### Response
#### Success Response (200 OK)
- **codeListId** (string) - The unique identifier for the specified code list.

#### Response Example
```json
{
  "codeListId": "x7y8z9-a0b1-c2d3-e4f5-abcdefghijkl"
}
```
```

--------------------------------

### Download Onboarding Migration Report

Source: https://www.ibm.com/docs/en/b2bis/index_topic=references-onboarding-migration-reports

Downloads the generated onboarding migration report for a specific company, identified by its SCI ID.

```APIDOC
## GET /migrations/{id}/report

### Description
Downloads the onboarding migration report associated with a specific Company SCI ID. The report contains summary and detailed information about migrated code lists or maps.

### Method
GET

### Endpoint
/migrations/{id}/report

### Parameters
#### Path Parameters
- **id** (string) - Required - The Company SCI ID for which the migration report is requested.

#### Query Parameters
None

### Request Example
```
GET /migrations/a1b2c3d4-e5f6-7890-1234-567890abcdef/report
```

### Response
#### Success Response (200)
- The response is an XLS file containing the onboarding migration report. The content of the report includes:
  - **Date** (string): The date the report was generated.
  - **Overall report status** (string): Status of the report generation (in progress, timed out, or complete).
  - **Company name** (string): The name of the company.
  - **Company SCI ID** (string): The Supply Chain Insights identifier for the company.
  - **Total business relationships** (integer): Total business relationships shown in the report.
  - **Report status** (string): Status for a specific business relationship (In progress, Timed out, or Complete).
  - **Business relationship ID** (string): Identifier for the business relationship.
  - **CTE business alias** (string): CTE business alias for the asset.
  - **Production business alias** (string): Production business alias for the asset.
  - **Total number of [assets] in Production** (integer): Total assets in the production environment.
  - **Total number of [assets] eligible for migration** (integer): Assets present in both CTE and Production.
  - **Total number of [assets] successfully migrated to Configuration Hub** (integer): Assets migrated to Configuration Hub.
  - **Total number of [assets] in Production but not in CTE** (integer): Assets not eligible for migration.
  - **Total number of [assets] for which error occurred** (integer): Assets with migration errors.
  - **[asset] name** (string): Name of the map or code list.
  - **Exists in CTE** (string): 'Y' or 'N'.
  - **Exists in Production** (string): 'Y' or 'N'.
  - **Eligible to be migrated to Configuration Hub** (string): 'Y' or 'N'.
  - **[asset] migration state** (string): 'Success' or 'Failed'.
  - **Comments** (string): Any comments about the asset.

#### Response Example
(The response is a file download, not a JSON object. The content described above would be within the downloaded XLS file.)
```

--------------------------------

### GET /geos/{geo}/environments/{environment}/payloads/{id}

Source: https://www.ibm.com/docs/en/b2bis/index_topic=inflight-data-extract-apis

Retrieves the payload associated with a document event.

```APIDOC
## GET /geos/{geo}/environments/{environment}/payloads/{id}

### Description
Retrieves the payload that is associated with a document event.

### Method
GET

### Endpoint
/geos/{geo}/environments/{environment}/payloads/{id}

### Parameters
#### Path Parameters
- **geo** (string) - Required - The geographic region.
- **environment** (string) - Required - The specific environment.
- **id** (string) - Required - The identifier of the document event.

### Response
#### Success Response (200)
- **payload** (string) - The content of the payload.

#### Response Example
```json
{
  "payload": "<order>...</order>"
}
```
```

--------------------------------

### GET /v2/geos/{geo}/environments/{environment}/documentcount

Source: https://www.ibm.com/docs/en/b2bis/index_topic=inflight-data-extract-apis

Retrieves the count of documents that match the specified filters.

```APIDOC
## GET /v2/geos/{geo}/environments/{environment}/documentcount

### Description
Retrieves the count of documents that match the specified filters.

### Method
GET

### Endpoint
/v2/geos/{geo}/environments/{environment}/documentcount

### Parameters
#### Path Parameters
- **geo** (string) - Required - The geographic region.
- **environment** (string) - Required - The specific environment.

#### Query Parameters
- **direction** (string) - Optional - Filter by document direction.
- **doc_type** (string) - Optional - Filter by document type.
- **received_after** (string) - Optional - Filter documents received after a specific date.
- **received_before** (string) - Optional - Filter documents received before a specific date.
- **receiver_id** (string) - Optional - Filter by receiver ID.
- **sender_id** (string) - Optional - Filter by sender ID.
- **state** (string) - Optional - Filter by document state.
- **status** (string) - Optional - Filter by document status.
- **composite_status** (string) - Optional - Filter by composite status.
- **substatus** (string) - Optional - Filter by substatus.

### Response
#### Success Response (200)
- **count** (integer) - The total number of documents matching the filters.

#### Response Example
```json
{
  "count": 150
}
```
```

--------------------------------

### Generate Onboarding Migration Report

Source: https://www.ibm.com/docs/en/b2bis/index_topic=references-onboarding-migration-reports

Initiates the generation of an onboarding migration report. This report provides details on code lists or maps for a company after migration.

```APIDOC
## POST /migrations

### Description
Creates an onboarding migration report for a company, detailing code lists or maps that have been migrated. This action requires administrator or support role access.

### Method
POST

### Endpoint
/migrations

### Parameters
#### Query Parameters
None

#### Request Body
None specified in the documentation. The report is generated based on the company context associated with the authenticated user.

### Request Example
```json
{} 
```

### Response
#### Success Response (200 or 201)
- **id** (string) - The unique identifier for the generated migration report.
- **status** (string) - The current status of the report generation (e.g., 'in progress').

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "in progress"
}
```
```

--------------------------------

### GET /v2/geos/{geo}/environments/{environment}/documents/jmsid/{id}

Source: https://www.ibm.com/docs/en/b2bis/index_topic=inflight-data-extract-apis

Retrieves a document summary by its JMS ID.

```APIDOC
## GET /v2/geos/{geo}/environments/{environment}/documents/jmsid/{id}

### Description
Retrieves a document summary by JMS ID.

### Method
GET

### Endpoint
/v2/geos/{geo}/environments/{environment}/documents/jmsid/{id}

### Parameters
#### Path Parameters
- **geo** (string) - Required - The geographic region.
- **environment** (string) - Required - The specific environment.
- **id** (string) - Required - The JMS ID.

### Response
#### Success Response (200)
- **document** (object) - The document summary object (same structure as retrieval by reference number).

#### Response Example
```json
{
  "document": {
    "id": "doc112",
    "direction": "inbound",
    "doc_type": "invoice",
    "sender_id": "senderPQR",
    "receiver_id": "receiverSTU"
  }
}
```
```

--------------------------------

### Migration Previews API

Source: https://www.ibm.com/docs/en/b2bis/index_topic=chra-map

Endpoints for triggering migration previews, retrieving preview summaries, and generating preview reports.

```APIDOC
## POST /migrationpreviews

### Description
Triggers a migration preview of maps for the specified tenant business(es) and creates a summary of the sync job IDs from Config Center.

### Method
POST

### Endpoint
/migrationpreviews

### Parameters
#### Request Body
*To be documented: The structure of the request body for triggering migration previews.*

### Response
#### Success Response (200)
- **syncJobIds** (array) - A summary of sync job IDs from Config Center.

#### Error Response (4xx/5xx)
*To be documented: The structure of an error response.*

## GET /migrationpreviews

### Description
Gets all the tenant's map migration preview summaries.

### Method
GET

### Endpoint
/migrationpreviews

### Response
#### Success Response (200)
- **migrationPreviewSummaries** (array) - A list of map migration preview summaries.

#### Error Response (4xx/5xx)
*To be documented: The structure of an error response.*

## GET /migrationpreviews/{id}

### Description
Gets a specific map migration preview summary by ID.

### Method
GET

### Endpoint
/migrationpreviews/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the map migration preview summary.

### Response
#### Success Response (200)
- **migrationPreviewSummary** (object) - The specific map migration preview summary.

#### Error Response (4xx/5xx)
*To be documented: The structure of an error response.*

## GET /migrationpreviews/{id}/report

### Description
Generates a map migration preview report by ID.

### Method
GET

### Endpoint
/migrationpreviews/{id}/report

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the map migration preview.

### Response
#### Success Response (200)
*To be documented: The map migration preview report content.*

#### Error Response (4xx/5xx)
*To be documented: The structure of an error response.*
```
Tokens:
Raw