APIComponents
Preview a component relationship change
Preview descendant-scoped notification and automation impact for a topology change.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/components/relationships/preview" \ -H "Content-Type: application/json" \ -d '{ "sourceComponentId": "34a8b2bc-e610-4f3a-97af-c95ca8a0231c", "targetComponentId": "f827f33c-a57f-4a69-918c-db5700f83e84", "relationshipType": "part_of", "action": "add" }'{ "preview": { "sourceComponentId": "34a8b2bc-e610-4f3a-97af-c95ca8a0231c", "targetComponentId": "f827f33c-a57f-4a69-918c-db5700f83e84", "relationshipType": "part_of", "action": "add", "organizationId": "string", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "relationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d", "componentRevisions": { "property1": 0, "property2": 0 }, "policyImpact": { "notificationRules": [ { "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "ruleGroupId": "58d9894d-7691-4577-9156-a6153851df91", "ownerComponentId": "db915343-6cc1-4b17-8ede-c183c413c205", "destinationIds": [ "31dc64b4-c492-4487-8989-c766bc35e76d" ], "beforeComponentIds": [ "dda38f46-aab6-4206-900d-d152405dd1da" ], "afterComponentIds": [ "3fc69601-ea16-4048-bdd7-eb640d7bb9b5" ] } ], "automationBindings": [ { "bindingId": "5fecb7b6-229e-4247-b81d-92842fd7d9b7", "automationId": "de580a02-68f2-4f04-b675-19968bf358e1", "ownerComponentId": "db915343-6cc1-4b17-8ede-c183c413c205", "beforeComponentIds": [ "dda38f46-aab6-4206-900d-d152405dd1da" ], "afterComponentIds": [ "3fc69601-ea16-4048-bdd7-eb640d7bb9b5" ] } ] }, "confirmationRequired": true }}