Open Context Protocol is live! 🚀 Read the launch post
getCreateIssueMetaIssueTypeId

getCreateIssueMetaIssueTypeId

Get create field metadata for a project and issue type id

Details

  • Method: GET
  • Path: /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
  • Operation ID: getCreateIssueMetaIssueTypeId

Parameters

{
  "projectIdOrKey": {
    "description": "The ID or key of the project.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "issueTypeId": {
    "description": "The issuetype ID.",
    "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": "int32"
  },
  "maxResults": {
    "description": "The maximum number of items to return per page.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int32"
  }
}

Response Schema

{
  "additionalProperties": true,
  "description": "A page of CreateMetaIssueType with Field.",
  "properties": {
    "fields": {
      "description": "The collection of FieldCreateMetaBeans.",
      "items": {
        "additionalProperties": false,
        "description": "The metadata describing an issue field for createmeta.",
        "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
          },
          "fieldId": {
            "description": "The field id.",
            "readOnly": true,
            "type": "string"
          },
          "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": [
          "fieldId",
          "key",
          "name",
          "operations",
          "required",
          "schema"
        ],
        "type": "object",
        "xml": {
          "name": "availableField"
        }
      },
      "readOnly": true,
      "type": "array"
    },
    "maxResults": {
      "description": "The maximum number of items to return per page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "results": {
      "items": {
        "additionalProperties": false,
        "description": "The metadata describing an issue field for createmeta.",
        "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
          },
          "fieldId": {
            "description": "The field id.",
            "readOnly": true,
            "type": "string"
          },
          "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": [
          "fieldId",
          "key",
          "name",
          "operations",
          "required",
          "schema"
        ],
        "type": "object",
        "xml": {
          "name": "availableField"
        }
      },
      "type": "array"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "total": {
      "description": "The total number of items in all pages.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('getCreateIssueMetaIssueTypeId', {
    # Add required parameters here
})