Validate Architecture Links (RESERVED)

Overview

Compare the authorization links in an architecture custom view against the real object-level relationships between the underlying objects. Each entry in the response is one of:

• allowed: A link between groups (e.g. layers, domains, modules) that complies with the defined rules.
• violated: A link between groups (e.g. layers, domains, modules) that breaks a defined rule.

Rules come from an authorization link you create (via Create Architecture Link).

Use this endpoint only for custom views whose aggregationType is Architecture in the custom view list response.

URI

GET /rest/applications/{name}/custom-views/{viewId}/architecture/validate

Path parameters

name (string)

This parameter identifies the analyzed application. The application name must be properly encoded if required. Character back-quote is not allowed.

viewId (string)

The unique identifier of the custom view.

Query parameters

date (string)

Optional. A valid datetime (e.g. 2024-01-15T00:00:00Z) forwarded to the aggregation service to validate links against the underlying objects as they existed at that point in history.

Notes

• This endpoint is intended for architecture custom views only.
• If the target custom view is not an architecture view, the API returns a client error.

Responses

application/json

Example:

{
    "success": [
        {
            "sourceId": "4:abc:123",
            "targetId": "4:abc:456",
            "validation": "allowed"
        },
        {
            "sourceId": "4:abc:456",
            "targetId": "4:abc:789",
            "validation": "violated"
        }
    ]
}

JSON representation