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": "<string>",
"component": {
"id": "<string>",
"name": "<string>",
"description": null,
"typeId": "<string>",
"ownerId": "<string>",
"fields": [
{
"definition": {
"id": "<string>"
},
"value": [
"<string>"
]
},
{
"definition": {
"id": "<string>"
}
}
],
"scorecardScores": [
{
"totalScore": 2,
"maxTotalScore": 128
}
]
}
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": null
},
"totalCount": 1
}
}
},
"extensions": {
"gateway": {
"request_id": "<string>",
"crossRegion": false,
"edgeCrossRegion": false
}
}
}
Workflow Library Example
List Components with Compass and Send Results Via Email