Get Unassigned Objects (RESERVED)

RESERVED: The keyword RESERVED annotation means that the API is available for use but is not yet part of the officially supported specification. Its behavior, interface, or output may change in future releases without backward compatibility guarantees.

Overview

Get a paginated list of the application objects represented by an enabled Unassigned node. An object is unassigned when it is not matched by any regular custom node in the view.

This operation is supported for Dynamic and Architecture custom views. Static custom views return a client error.

For a published view, this operation is available only to the view owner and collaborators. Other users receive HTTP 403.

URI

GET /rest/applications/{name}/custom-views/{viewId}/unassigned

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

Parameter	Type	Required	Description
offset	integer	Yes	Zero-based number of matching objects to skip. Must be non-negative.
limit	integer	Yes	Maximum number of matching objects to return. Must be positive.
sortKey	string	No	Object property used for sorting: `Name`, `FullName`, or `Type`. Defaults to `Name`; other values return HTTP `400`.
sortOrder	string	No	Sort direction: `asc` or `desc`. Defaults to `asc`; other values return HTTP `400`.

Responses

application/json

Example:

{
    "success": {
        "count": 2,
        "objects": [
            {
                "id": "obj-12345",
                "data": {
                    "Name": "processPayment",
                    "FullName": "com.example.payment.PaymentService.processPayment",
                    "Type": "Java Method"
                }
            }
        ],
        "documents": []
    }
}

JSON representation

Property	Type	Description
success.count	integer	Total number of unassigned objects before pagination.
success.objects	[]object	The requested page of unassigned objects.
success.objects[].id	string	Internal element identifier of the object.
success.objects[].data	object	Object properties returned by the aggregation service.
success.documents	[]object	Documents returned with the matching objects, when applicable.