Skip to main content
API Explorer|API Explorer
Infrastructure/OTA Upgrade Plans
POSTOTASince 1.0SynchronousAuth Required

TopologySort

Calculate the topological ordering of component dependencies for upgrade

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • planIdStringRequired

    ID of the upgrade plan this topology sort applies to

Body Fields

  • nodesListRequired

    Nodes for this resource

    Example: (nested array)

    • nameString

      Name of this component node

      Example: zcf-core

    • dependenciesList

      Dependencies for this resource

      Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • orderList

    Order for this resource

    Example: item1,item2

  • hasCycleBoolean

    Whether a circular dependency cycle was detected in the graph

    Example: false

  • cycleList

    Cycle for this resource

    Example: item1,item2

Endpoint

POST/api/v1/lifecycle/upgrade-plans/{planId}/topology-sort

/api/v1/lifecycle/upgrade-plans/{planId}/topology-sort

Operation ID

TopologySort

Permalink

Request Example

curl -X POST '{host}/api/v1/lifecycle/upgrade-plans/{planId}/topology-sort' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"nodes":"(nested array)"}'

Response Example

200
{"order": ["value"], "hasCycle": false, "cycle": ["value"]}

Change History

This API has no change history records yet.

View all change history