List Components

List all components.

Basic Parameters

Parameter	Description
Cloud ID	The unique Cloud ID of your Atlassian site. Can be retrieved using "Get Cloud ID".

Advanced Parameters

Parameter	Description
Filter Name	The name of the field to apply the filter. The valid field names are compass:tier, labels, ownerId, score and type.
Filter Value	The filter value to apply. When using "in" operator, the value need to be in the following format: ["OTHER","SERVICE"] In any other case: "SERVICE"
Operator	The filter operator to apply.
Query	Text query to search against.
Sort By	Sorting parameter for the results to be searched for. The default is by ranked results.
Sort Order	Sorting order for the results to be searched for.

Example Output

{
    "data": {
        "compass": {
            "searchComponents": {
                "nodes": [
                    {
                        "link": "https://{your-subdomain}.atlassian.net/compass/component/f12f34ea-56d7-89ee-98e7-6fcc54f13214",
                        "component": {
                            "id": "ari:cloud:compass:f12f34ea-56d7-89ee-98e7-6fcc54f13214:component/f12f34ea-56d7-89ee-98e7-6fcc54f13214/f12f34ea-56d7-89ee-98e7-6fcc54f13214",
                            "name": "Test Component",
                            "description": null,
                            "typeId": "SERVICE",
                            "ownerId": "ari:cloud:teams::team/f12f34ea-56d7-89ee-98e7-6fcc54f13214"
                        }
                    }
                ],
                "pageInfo": {
                    "hasNextPage": false,
                    "endCursor": null
                },
                "totalCount": 1
            }
        }
    },
    "extensions": {
        "gateway": {
            "request_id": "123aa4a5d6789ada",
            "crossRegion": false,
            "edgeCrossRegion": false,
            "deprecatedFieldsUsed": []
        }
    }
}

Workflow Library Example

List Components with Compass and Send Results Via Email

Preview this Workflow on desktop