findComponentsForProjects
Find components for projects
Details
- Method:
GET - Path:
/rest/api/3/component - Operation ID:
findComponentsForProjects
Parameters
{
"projectIdsOrKeys": {
"description": "The project IDs and/or project keys (case sensitive).",
"required": false,
"location": "query",
"type": "array"
},
"startAt": {
"description": "The index of the first item to return in a page of results (page offset).",
"required": false,
"location": "query",
"type": "integer",
"format": "int64"
},
"maxResults": {
"description": "The maximum number of items to return per page.",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
},
"orderBy": {
"description": "[Order](#ordering) the results by a field:\n\n * `description` Sorts by the component description.\n * `name` Sorts by component name.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"description",
"-description",
"+description",
"name",
"-name",
"+name"
]
},
"query": {
"description": "Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive).",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "A page of items.",
"properties": {
"isLast": {
"description": "Whether this is the last page.",
"readOnly": true,
"type": "boolean"
},
"maxResults": {
"description": "The maximum number of items that could be returned.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"nextPage": {
"description": "If there is another page of results, the URL of the next page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"startAt": {
"description": "The index of the first item returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of items returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"values": {
"description": "The list of items.",
"items": {
"additionalProperties": true,
"properties": {
"ari": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"name": {
"type": "string"
},
"self": {
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('findComponentsForProjects', {
# Add required parameters here
})