getCustomFieldContextsForProjectsAndIssueTypes
Get custom field contexts for projects and issue types
Details
- Method:
POST - Path:
/rest/api/3/field/{fieldId}/context/mapping - Operation ID:
getCustomFieldContextsForProjectsAndIssueTypes
Parameters
{
"fieldId": {
"description": "The ID of the custom field.",
"required": true,
"location": "path",
"type": "string"
},
"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"
},
"mappings": {
"description": "The project and issue type mappings.",
"required": true,
"location": "body",
"type": "array"
}
}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": false,
"description": "The project and issue type mapping with a matching custom field context.",
"properties": {
"contextId": {
"description": "The ID of the custom field context.",
"type": "string"
},
"issueTypeId": {
"description": "The ID of the issue type.",
"type": "string"
},
"projectId": {
"description": "The ID of the project.",
"type": "string"
}
},
"required": [
"contextId",
"issueTypeId",
"projectId"
],
"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('getCustomFieldContextsForProjectsAndIssueTypes', {
# Add required parameters here
})