getEditIssueMeta
Get edit issue metadata
Details
- Method:
GET - Path:
/rest/api/3/issue/{issueIdOrKey}/editmeta - Operation ID:
getEditIssueMeta
Parameters
{
"issueIdOrKey": {
"description": "The ID or key of the issue.",
"required": true,
"location": "path",
"type": "string"
},
"overrideScreenSecurity": {
"description": "Whether hidden fields are returned. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).",
"required": false,
"location": "query",
"type": "boolean"
},
"overrideEditableFlag": {
"description": "Whether non-editable fields are returned. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).",
"required": false,
"location": "query",
"type": "boolean"
}
}Response Schema
{
"description": "A list of editable field details.",
"properties": {
"fields": {
"additionalProperties": {
"additionalProperties": false,
"description": "The metadata describing an issue field.",
"properties": {
"allowedValues": {
"description": "The list of values allowed in the field.",
"items": {
"readOnly": true
},
"readOnly": true,
"type": "array"
},
"autoCompleteUrl": {
"description": "The URL that can be used to automatically complete the field.",
"readOnly": true,
"type": "string"
},
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "The configuration properties.",
"readOnly": true,
"type": "object"
},
"defaultValue": {
"description": "The default value of the field.",
"readOnly": true
},
"hasDefaultValue": {
"description": "Whether the field has a default value.",
"readOnly": true,
"type": "boolean"
},
"key": {
"description": "The key of the field.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the field.",
"readOnly": true,
"type": "string"
},
"operations": {
"description": "The list of operations that can be performed on the field.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"required": {
"description": "Whether the field is required.",
"readOnly": true,
"type": "boolean"
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/JsonTypeBean"
}
],
"description": "The data type of the field.",
"readOnly": true
}
},
"required": [
"key",
"name",
"operations",
"required",
"schema"
],
"type": "object",
"xml": {
"name": "availableField"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getEditIssueMeta', {
# Add required parameters here
})