Boomi Platform API Reference (1.0.0) - TradingPartnerProcessingGroup

Toggle Pane

• TradingPartnerProcessingGroup
  • postCreates a TradingPartnerProcessingGroup object
  • getRetrieves an instance of a TradingPartnerProcessingGroup object
  • postModifies or updates a TradingPartnerProcessingGroup object
  • delDeletes a TradingPartnerProcessingGroup object
  • postRetrieves multiple TradingPartnerProcessingGroup objects by identifier
  • postQueries for a TradingPartnerProcessingGroup object(s)
  • postRetrieves additional results for a TradingPartnerProcessingGroup query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

TradingPartnerProcessingGroup

The Trading Partner Processing Group object allows users to retrieve, query, create, update, and delete Processing Group components through the Platform API.

Required Privileges

Read and Write access

• API — Use the Boomi Platform API to access account data.

Creates a TradingPartnerProcessingGroup object

Send an HTTP POST request where accountId is the ID of the authenticating account for the request. If you omit the folderName field, you must include the folderId field — and vice versa.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	object (ProcessingGroupDefaultRouting)
	object (ProcessingGroupDocumentBasedRouting)
	object (ProcessingGroupPartnerBasedRouting)
	object (ProcessingGroupTradingPartners)
branchId	string
branchName	string
componentId	string
componentName	string
deleted	boolean
description	string
folderId	integer <int64>
folderName	string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (ProcessingGroupDefaultRouting)
	object (ProcessingGroupDocumentBasedRouting)
	object (ProcessingGroupPartnerBasedRouting)
	object (ProcessingGroupTradingPartners)
branchId	string
branchName	string
componentId	string
componentName	string
deleted	boolean
description	string
folderId	integer <int64>
folderName	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/TradingPartnerProcessingGroup

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "TradingPartners": {

  • "TradingPartner": [

    • {

      • "id": "12345678-9abc-def0-1234-56789abcdef0"

      },
    • {

      • "id": "0fedcba9-8765-4321-0fed-cba987654321"

      }

    ]

  },
• "DocumentRouting": {

  • "StandardRoute": [

    • {

      • "DocumentTypeRoute": [

        • {

          • "PartnerRoute": [ ],
          • "documentType": "AUTHOR",
          • "processId": "56789abc-def0-1234-5678-9abcdef01234"

          }

        ],
      • "standard": "edifact"

      },
    • {

      • "DocumentTypeRoute": [

        • {

          • "PartnerRoute": [ ],
          • "documentType": "107",
          • "processId": "43210fed-cba9-8765-4321-0fedcba98765"

          }

        ],
      • "standard": "x12"

      }

    ],
  • "processId": "543210fe-dcba-9876-5432-10fedcba9876"

  },
• "componentName": "East Coast partners",
• "folderName": "Home:TPs:PGs:Domestic"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "TradingPartnerComponent",
• "folderName": "Home:TPs",
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1",
• "componentName": "Best Wholesaling",
• "standard": "x12",
• "classification": "tradingpartner",
• "ContactInfo": {

  • "contactName": "Tom Miller",
  • "address1": "127 Comstock Ave.",
  • "address2": null,
  • "city": "Philadelphia",
  • "state": "PA",
  • "postalcode": "19100",
  • "country": "US",
  • "email": "tombestwholesaling.biz",
  • "phone": "311 555-3579",
  • "fax": "311 555-9753"

  },
• "PartnerInfo": {

  • "X12PartnerInfo": {

    • "X12Options": {

      • "envelopeoption": "groupall",
      • "acknowledgementoption": "donotackitem",
      • "filteracknowledgements": "false",
      • "rejectDuplicateInterchange": "false",
      • "outboundInterchangeValidation": "true",
      • "outboundValidationOption": "filterError",
      • "elementDelimiter": {

        • "delimiterValue": "stardelimited"

        },
      • "segmentTerminator": {

        • "segmentTerminatorValue": "newline"

        }

      },
    • "X12ControlInfo": {

      • "ISAControlInfo": {

        • "testindicator": "P",
        • "ackrequested": "false",
        • "authorizationInformationQualifier": "X12AUTHQUAL_00",
        • "securityInformationQualifier": "X12SECQUAL_00",
        • "interchangeIdQualifier": "X12IDQUAL_01"

        },
      • "GSControlInfo": {

        • "respagencycode": "T"

        }

      }

    }

  },
• "PartnerCommunication": {

  • "FTPCommunicationOptions": {

    • "CommunicationSetting": "custom",
    • "SharedCommunicationChannel": null,
    • "FTPSettings": {

      • "connectionMode": "active",
      • "useDefaultSettings": "false",
      • "host": "ftp.bestwholesaling.com",
      • "port": "1010",
      • "user": "tom.miller",
      • "FTPSSLOptions": {

        • "sslmode": "none",
        • "useClientAuthentication": "false"

        }

      },
    • "FTPGetOptions": {

      • "transferType": "ascii",
      • "ftpAction": "actionget",
      • "useDefaultGetOptions": "false",
      • "remoteDirectory": "/usr/local/bestwholesaling/outbox",
      • "fileToMove": "*.xml",
      • "maxFileCount": "200"

      },
    • "FTPSendOptions": {

      • "transferType": "ascii",
      • "ftpAction": "actionputappend",
      • "useDefaultSendOptions": "false",
      • "remoteDirectory": "/home/tommiller/new",
      • "moveToDirectory": "/home/tommiller/inbox"

      }

    }

  },
• "PartnerDocumentTypes": {

  • "PartnerDocumentType": [

    • {

      • "typeId": "101",
      • "profileId": "23456789-abcd-ef01-2345-6789abcdef01",
      • "use999Ack": "false",
      • "useTA1Ack": "false",
      • "expectAckForOutbound": "false",
      • "validateOutboundTransactionSets": "false",
      • "qualifierValidation": "true"

      },
    • {

      • "typeId": "810",
      • "profileId": "3456789a-bcde-4012-3456-789abcdef012",
      • "use999Ack": "false",
      • "useTA1Ack": "false",
      • "expectAckForOutbound": "false",
      • "validateOutboundTransactionSets": "false",
      • "qualifierValidation": "true"

      }

    ]

  }

}

Retrieves an instance of a TradingPartnerProcessingGroup object

The ordinary GET operation returns a single Trading Partner Processing Group object based on the supplied ID. The bulk GET operation returns multiple Trading Partner Processing Group objects based on the supplied IDs, to a maximum of 100. A GET operation specifying the ID of a deleted processing group component retrieves the component. In the component, the deleted field’s value is true.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (ProcessingGroupDefaultRouting)
	object (ProcessingGroupDocumentBasedRouting)
	object (ProcessingGroupPartnerBasedRouting)
	object (ProcessingGroupTradingPartners)
branchId	string
branchName	string
componentId	string
componentName	string
deleted	boolean
description	string
folderId	integer <int64>
folderName	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/TradingPartnerProcessingGroup/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "TradingPartnerProcessingGroup": {

  • "componentName": "East Coast partners",
  • "componentId": "3456789a-bcde-f012-34-56789abcdef012",
  • "folderName": "Home:TPs:PGs:Domestic",
  • "folderId": "11669",
  • "branchId": "QjoxNDMxNg",
  • "branchName": "branch-1",
  • "TradingPartners": {

    • "TradingPartner": [

      • {

        • "id": "12345678-9abc-def0-1234-56789abcdef0"

        },
      • {

        • "id": "0fedcba9-8765-4321-0fed-cba987654321"

        }

      ]

    },
  • "DocumentRouting": {

    • "processId": "543210fe-dcba-9876-5432-10fedcba9876",
    • "StandardRoute": [

      • {

        • "standard": "edifact",
        • "processId": "456789ab-cdef-0123-4567-89abcdef0123",
        • "DocumentTypeRoute": {

          • "documentType": "AUTHOR",
          • "processId": "56789abc-def0-1234-5678-9abcdef01234"

          }

        },
      • {

        • "standard": "x12",
        • "processId": "3210fedc-ba98-7654-3210-fedcba987654",
        • "DocumentTypeRoute": {

          • "documentType": "107",
          • "processId": "43210fed-cba9-8765-4321-0fedcba98765"

          }

        }

      ]

    }

  }

}

Modifies or updates a TradingPartnerProcessingGroup object

An UPDATE operation specifying the ID of a deleted processing group component restores the component to a non-deleted state, assuming the request is otherwise valid. It also overwrites the entire processing group component.

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	object (ProcessingGroupDefaultRouting)
	object (ProcessingGroupDocumentBasedRouting)
	object (ProcessingGroupPartnerBasedRouting)
	object (ProcessingGroupTradingPartners)
branchId	string
branchName	string
componentId	string
componentName	string
deleted	boolean
description	string
folderId	integer <int64>
folderName	string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (ProcessingGroupDefaultRouting)
	object (ProcessingGroupDocumentBasedRouting)
	object (ProcessingGroupPartnerBasedRouting)
	object (ProcessingGroupTradingPartners)
branchId	string
branchName	string
componentId	string
componentName	string
deleted	boolean
description	string
folderId	integer <int64>
folderName	string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/TradingPartnerProcessingGroup/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "TradingPartners": {

  • "TradingPartner": [

    • {

      • "id": "12345678-9abc-def0-1234-56789abcdef0"

      },
    • {

      • "id": "0fedcba9-8765-4321-0fed-cba987654321"

      }

    ]

  },
• "DocumentRouting": {

  • "StandardRoute": [

    • {

      • "DocumentTypeRoute": [

        • {

          • "PartnerRoute": [ ],
          • "documentType": "AUTHOR",
          • "processId": "56789abc-def0-1234-5678-9abcdef01234"

          }

        ],
      • "standard": "edifact"

      },
    • {

      • "DocumentTypeRoute": [

        • {

          • "PartnerRoute": [ ],
          • "documentType": "107",
          • "processId": "43210fed-cba9-8765-4321-0fedcba98765"

          }

        ],
      • "standard": "x12"

      }

    ],
  • "processId": "543210fe-dcba-9876-5432-10fedcba9876"

  },
• "componentName": "Atlantic Seaboard partners",
• "componentId": "3456789a-bcde-f012-34-56789abcdef012",
• "folderName": "Home:TPs:PGs:Domestic",
• "folderId": "11669",
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "TradingPartnerProcessingGroup",
• "componentName": "Atlantic Seaboard partners",
• "componentId": "3456789a-bcde-f012-34-56789abcdef012",
• "folderName": "Home:TPs:PGs:Domestic",
• "folderId": "11669",
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1",
• "TradingPartners": {

  • "TradingPartner": [

    • {

      • "id": "12345678-9abc-def0-1234-56789abcdef0"

      },
    • {

      • "id": "0fedcba9-8765-4321-0fed-cba987654321"

      }

    ]

  },
• "DocumentRouting": {

  • "processId": "543210fe-dcba-9876-5432-10fedcba9876",
  • "StandardRoute": [

    • {

      • "standard": "edifact",
      • "processId": "456789ab-cdef-0123-4567-89abcdef0123",
      • "DocumentTypeRoute": {

        • "documentType": "AUTHOR",
        • "processId": "56789abc-def0-1234-5678-9abcdef01234"

        }

      },
    • {

      • "standard": "x12",
      • "processId": "3210fedc-ba98-7654-3210-fedcba987654",
      • "DocumentTypeRoute": {

        • "documentType": "107",
        • "processId": "43210fed-cba9-8765-4321-0fedcba98765"

        }

      }

    ]

  }

}

Deletes a TradingPartnerProcessingGroup object

A DELETE operation specifying the ID of a deleted processing group component returns a false response. If you deleted the component successfully, the response is "true".

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/TradingPartnerProcessingGroup/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieves multiple TradingPartnerProcessingGroup objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (TradingPartnerProcessingGroup) index integer <int32> id string statusCode integer <int32> errorMessage string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/TradingPartnerProcessingGroup/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "response": [

  • {

    • "Result": {

      • "DefaultRouting": {

        • "processId": "string"

        },
      • "DocumentRouting": {

        • "StandardRoute": [

          • {

            • "DocumentTypeRoute": [

              • {

                • "PartnerRoute": [

                  • null

                  ],
                • "documentType": "string",
                • "processId": "string"

                }

              ],
            • "processId": "string",
            • "standard": "x12"

            }

          ],
        • "processId": "string"

        },
      • "PartnerRouting": {

        • "PartnerRoute": [

          • {

            • "StandardRoute": [

              • {

                • "DocumentTypeRoute": [

                  • null

                  ],
                • "processId": "string",
                • "standard": "x12"

                }

              ],
            • "processId": "string",
            • "tradingPartnerId": "string"

            }

          ],
        • "processId": "string"

        },
      • "TradingPartners": {

        • "TradingPartner": [

          • {

            • "id": "string"

            }

          ]

        },
      • "branchId": "string",
      • "branchName": "string",
      • "componentId": "3456789a-bcde-f012-34-56789abcdef012",
      • "componentName": "East Coast partners",
      • "deleted": true,
      • "description": "string",
      • "folderId": "11669",
      • "folderName": "Home:TPs:PGs:Domestic"

      },
    • "index": 0,
    • "id": "string",
    • "statusCode": 0,
    • "errorMessage": "string"

    }

  ]

}

Queries for a TradingPartnerProcessingGroup object(s)

The QUERY operation returns all of the authenticating account’s processing group components. The operation does not return full component representations; it returns, for each result, the component’s name, ID, and folder ID.

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

required

object

required TradingPartnerProcessingGroupSimpleExpression (object) or TradingPartnerProcessingGroupGroupingExpression (object) (TradingPartnerProcessingGroupExpression) One of operator required string Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" property required string argument Array of strings

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (TradingPartnerProcessingGroup)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/TradingPartnerProcessingGroup/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "QueryFilter": {

  • "expression": {

    • "argument": [

      • "string"

      ],
    • "operator": "EQUALS",
    • "property": "string"

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "TradingPartnerProcessingGroup",
    • "componentName": "East Coast partners",
    • "componentId": "3456789a-bcde-f012-34-56789abcdef012",
    • "folderId": 11669,
    • "branchId": "QjoxNDMxNg",
    • "branchName": "branch-1"

    },
  • {

    • "@type": "TradingPartnerProcessingGroup",
    • "componentName": "European partners",
    • "componentId": "210fedcb-a987-6543-210f-edcba9876543",
    • "folderId": 11670,
    • "branchId": "QjoxNDMxNg",
    • "branchName": "branch-1"

    }

  ],
• "numberOfResults": 102

}

Retrieves additional results for a TradingPartnerProcessingGroup query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:

basicAuth

Request Body schema: text/plain

required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (TradingPartnerProcessingGroup)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/TradingPartnerProcessingGroup/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "TradingPartnerProcessingGroup",
    • "componentName": "East Coast partners",
    • "componentId": "3456789a-bcde-f012-34-56789abcdef012",
    • "folderId": 11669,
    • "branchId": "QjoxNDMxNg",
    • "branchName": "branch-1"

    },
  • {

    • "@type": "TradingPartnerProcessingGroup",
    • "componentName": "European partners",
    • "componentId": "210fedcb-a987-6543-210f-edcba9876543",
    • "folderId": 11670,
    • "branchId": "QjoxNDMxNg",
    • "branchName": "branch-1"

    }

  ],
• "numberOfResults": 102

}