Boomi Platform API Reference (1.0.0) - ComponentDiffRequest

Toggle Pane

• ComponentDiffRequest
  • postCreates a ComponentDiffRequest object
  • getRetrieves an instance of a ComponentDiffRequest object
  • postRetrieves multiple ComponentDiffRequest objects

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ComponentDiffRequest

You can use the Component Diff object to programmatically compare two different versions of Boomi Integration components, such as processes and maps. A comparative diff can provide:

• Insights for auditing and change management
• Better understanding of changes across component versions
• Component version insights into external DevOps processes.

Creates a ComponentDiffRequest object

Contains a diff visualization option to help understand the differences between component versions. For more information, refer to the Postman article Visualize request responses using Postman Visualizer.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

componentId required	string The ID of the component for which you want to compare versions.
sourceVersion required	integer <int32> The source version of the component.
targetVersion required	integer <int32> The target version which you want to compare to the source version.
	object (CompDiffConfig)

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object
message string Message providing details about the diffed components object

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}/ComponentDiffRequest

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "folderFullPath": "Boomi/Admin",
• "version": "1",
• "name": "Process A",
• "type": "process",
• "createdDate": "2023-07-05T14:06:28Z",
• "createdBy": "adminboomi.com",
• "modifiedDate": "2023-07-05T14:06:28Z",
• "modifiedBy": "adminboomi.com",
• "deleted": "false",
• "currentVersion": "true",
• "folderName": "Admin",
• "folderId": "RjozMDk2OQ",
• "encryptedValues": null,
• "description": null,
• "object": {

  • "process": {

    • "xmlns": "",
    • "allowSimultaneous": "false",
    • "enableUserLog": "false",
    • "processLogOnErrorOnly": "false",
    • "purgeDataImmediately": "false",
    • "updateRunDates": "true",
    • "workload": "general",
    • "shapes": {

      • "shape": [

        • {

          • "image": "start",
          • "name": "shape1",
          • "shapetype": "start",
          • "userlabel": "",
          • "x": "96.0",
          • "y": "94.0",
          • "configuration": {

            • "noaction": null

            },
          • "dragpoints": {

            • "dragpoint": {

              • "name": "shape1.dragpoint1",
              • "toShape": "shape2",
              • "x": "240.0",
              • "y": "120.0"

              }

            }

          },
        • {

          • "image": "map_icon",
          • "name": "shape2",
          • "shapetype": "map",
          • "userlabel": "",
          • "x": "256.0",
          • "y": "112.0",
          • "configuration": {

            • "map": null

            },
          • "dragpoints": {

            • "dragpoint": {

              • "name": "shape2.dragpoint1",
              • "toShape": "shape3",
              • "x": "368.0",
              • "y": "120.0"

              }

            }

          },
        • {

          • "image": "stop_icon",
          • "name": "shape3",
          • "shapetype": "stop",
          • "userlabel": "",
          • "x": "384.0",
          • "y": "112.0",
          • "configuration": {

            • "stop": {

              • "continue": "true"

              }

            },
          • "dragpoints": null

          }

        ]

      }

    }

  },
• "processOverrides": null

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Component",
• "folderFullPath": "Boomi/Admin",
• "componentId": "bb302dbb-2e30-41a8-9e59-035f491e6da6",
• "version": "1",
• "name": "Process A",
• "type": "process",
• "createdDate": "2023-07-05T15:43:18Z",
• "createdBy": "adminboomi.com",
• "modifiedDate": "2023-07-05T15:43:18Z",
• "modifiedBy": "adminboomi.com",
• "deleted": "false",
• "currentVersion": "true",
• "folderName": "Admin",
• "folderId": "RjozMDk2OQ",
• "encryptedValues": null,
• "object": {

  • "process": {

    • "xmlns": "",
    • "allowSimultaneous": "false",
    • "enableUserLog": "false",
    • "processLogOnErrorOnly": "false",
    • "purgeDataImmediately": "false",
    • "updateRunDates": "true",
    • "workload": "general",
    • "shapes": {

      • "shape": [

        • {

          • "image": "start",
          • "name": "shape1",
          • "shapetype": "start",
          • "userlabel": "",
          • "x": "96.0",
          • "y": "94.0",
          • "configuration": {

            • "noaction": null

            },
          • "dragpoints": {

            • "dragpoint": {

              • "name": "shape1.dragpoint1",
              • "toShape": "shape2",
              • "x": "240.0",
              • "y": "120.0"

              }

            }

          },
        • {

          • "image": "map_icon",
          • "name": "shape2",
          • "shapetype": "map",
          • "userlabel": "",
          • "x": "256.0",
          • "y": "112.0",
          • "configuration": {

            • "map": null

            },
          • "dragpoints": {

            • "dragpoint": {

              • "name": "shape2.dragpoint1",
              • "toShape": "shape3",
              • "x": "368.0",
              • "y": "120.0"

              }

            }

          },
        • {

          • "image": "stop_icon",
          • "name": "shape3",
          • "shapetype": "stop",
          • "userlabel": "",
          • "x": "384.0",
          • "y": "112.0",
          • "configuration": {

            • "stop": {

              • "continue": "true"

              }

            },
          • "dragpoints": null

          }

        ]

      }

    }

  },
• "processOverrides": null

}

Retrieves an instance of a ComponentDiffRequest object

If you use Postman to make API calls, the GET response contains a diff visualization option to help understand the differences between component versions. For more information, refer to the Postman article Visualize request responses using Postman Visualizer. The Postman visualization feature currently supports only JSON responses.

Authorizations:

basicAuth

path Parameters

componentId required

string The ID of the component for which you want to compare versions.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

componentId required	string The ID of the component for which you want to compare versions.
sourceVersion required	integer <int32> The source version of the component.
targetVersion required	integer <int32> The target version which you want to compare to the source version.
	object (CompDiffConfig)

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}/ComponentDiffRequest/{componentId}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ComponentDiffResponse",
• "GenericDiff": {

  • "@type": "GenericDiff",
  • "addition": {

    • "@type": "ChangeAggregation",
    • "change": [

      • {

        • "@type": "Change",
        • "elementKey": {

          • "@type": "ChangeKey",
          • "key-part": [

            • {

              • "@type": "KeyPair",
              • "attribute": "name",
              • "value": "shape5"

              }

            ],
          • "elementName": "shape"

          },
        • "newValue": {

          • "@type": "ChangeValue",
          • "value": "<shape image=\"documentproperties_icon\" name=\"shape5\" shapetype=\"documentproperties\" x=\"368.0\" y=\"96.0\"><configuration><documentproperties/></configuration><dragpoints><dragpoint name=\"shape5.dragpoint1\" toShape=\"shape6\" x=\"496.0\" y=\"104.0\"/></dragpoints></shape>",
          • "xpath": "/Component[1]/object[1]/process[1]/shapes[1]/shape[3]"

          },
        • "type": "element",
        • "changedParticleName": "shape"

        },
      • {

        • "@type": "Change",
        • "elementKey": {

          • "@type": "ChangeKey",
          • "key-part": [

            • {

              • "@type": "KeyPair",
              • "attribute": "name",
              • "value": "shape6"

              }

            ],
          • "elementName": "shape"

          },
        • "newValue": {

          • "@type": "ChangeValue",
          • "value": "<shape image=\"returndocuments_icon\" name=\"shape6\" shapetype=\"returndocuments\" x=\"512.0\" y=\"96.0\"><configuration><returndocuments/></configuration><dragpoints/></shape>",
          • "xpath": "/Component[1]/object[1]/process[1]/shapes[1]/shape[4]"

          },
        • "type": "element",
        • "changedParticleName": "shape"

        }

      ],
    • "total": 2

    },
  • "deletion": {

    • "@type": "ChangeAggregation",
    • "change": [

      • {

        • "@type": "Change",
        • "elementKey": {

          • "@type": "ChangeKey",
          • "key-part": [

            • {

              • "@type": "KeyPair",
              • "attribute": "name",
              • "value": "shape3"

              }

            ],
          • "elementName": "shape"

          },
        • "oldValue": {

          • "@type": "ChangeValue",
          • "value": "<shape image=\"message_icon\" name=\"shape3\" shapetype=\"message\" x=\"400.0\" y=\"96.0\"><configuration><message/></configuration><dragpoints><dragpoint name=\"shape3.dragpoint1\" toShape=\"shape4\" x=\"528.0\" y=\"104.0\"/></dragpoints></shape>",
          • "xpath": "/Component[1]/object[1]/process[1]/shapes[1]/shape[3]"

          },
        • "type": "element",
        • "changedParticleName": "shape"

        },
      • {

        • "@type": "Change",
        • "elementKey": {

          • "@type": "ChangeKey",
          • "key-part": [

            • {

              • "@type": "KeyPair",
              • "attribute": "name",
              • "value": "shape4"

              }

            ],
          • "elementName": "shape"

          },
        • "oldValue": {

          • "@type": "ChangeValue",
          • "value": "<shape image=\"stop_icon\" name=\"shape4\" shapetype=\"stop\" x=\"544.0\" y=\"96.0\"><configuration><stop continue=\"true\"/></configuration><dragpoints/></shape>",
          • "xpath": "/Component[1]/object[1]/process[1]/shapes[1]/shape[4]"

          },
        • "type": "element",
        • "changedParticleName": "shape"

        }

      ],
    • "total": 2

    },
  • "modification": {

    • "@type": "ChangeAggregation",
    • "change": [

      • {

        • "@type": "Change",
        • "elementKey": {

          • "@type": "ChangeKey",
          • "key-part": [ ],
          • "elementName": "dragpoint"

          },
        • "newValue": {

          • "@type": "ChangeValue",
          • "value": "shape5",
          • "xpath": "/Component[1]/object[1]/process[1]/shapes[1]/shape[2]/dragpoints[1]/dragpoint[1]/@toShape"

          },
        • "oldValue": {

          • "@type": "ChangeValue",
          • "value": "shape3",
          • "xpath": "/Component[1]/object[1]/process[1]/shapes[1]/shape[2]/dragpoints[1]/dragpoint[1]/@toShape"

          },
        • "type": "attribute",
        • "changedParticleName": "toShape"

        }

      ],
    • "total": 1

    }

  },
• "message": "Diffed Versions 1 and 2 of Component: New Process 39 (Type = process, ID = cdb127f1-3eaa-49c7-85ef-0e79a68a84e7)"

}

Retrieves multiple ComponentDiffRequest objects

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" Read only. The type of component. Refer to the section Component Types later in this topic for a complete list of component type values

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (ComponentDiffRequest) 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}/ComponentDiffRequest/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": {

      • "CompDiffConfig": {

        • "CompDiffElement": [

          • {

            • "CompDiffAttribute": [

              • {

                • "idpart": true,
                • "ignored": true,
                • "name": "string"

                }

              ],
            • "ignored": true,
            • "name": "string",
            • "ordered": true,
            • "parent": "string"

            }

          ],
        • "componentType": "certificate"

        },
      • "componentId": "string",
      • "sourceVersion": 0,
      • "targetVersion": 0

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

    }

  ]

}