deleteWorkflowSchemeIssueType
Delete workflow for issue type in workflow scheme
Details
- Method:
DELETE - Path:
/rest/api/3/workflowscheme/{id}/issuetype/{issueType} - Operation ID:
deleteWorkflowSchemeIssueType
Parameters
{
"id": {
"description": "The ID of the workflow scheme.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"issueType": {
"description": "The ID of the issue type.",
"required": true,
"location": "path",
"type": "string"
},
"updateDraftIfNeeded": {
"description": "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`.",
"required": false,
"location": "query",
"type": "boolean"
}
}Response Schema
{
"additionalProperties": false,
"description": "Details about a workflow scheme.",
"properties": {
"defaultWorkflow": {
"description": "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*.",
"type": "string"
},
"description": {
"description": "The description of the workflow scheme.",
"type": "string"
},
"draft": {
"description": "Whether the workflow scheme is a draft or not.",
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "The ID of the workflow scheme.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"issueTypeMappings": {
"additionalProperties": {
"type": "string"
},
"description": "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
"type": "object"
},
"issueTypes": {
"additionalProperties": {
"additionalProperties": false,
"description": "Details about an issue type.",
"properties": {
"avatarId": {
"description": "The ID of the issue type's avatar.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"description": {
"description": "The description of the issue type.",
"readOnly": true,
"type": "string"
},
"entityId": {
"description": "Unique ID for next-gen projects.",
"format": "uuid",
"readOnly": true,
"type": "string"
},
"hierarchyLevel": {
"description": "Hierarchy level of the issue type.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"iconUrl": {
"description": "The URL of the issue type's avatar.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the issue type.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the issue type.",
"readOnly": true,
"type": "string"
},
"scope": {
"allOf": [
{
"$ref": "#/components/schemas/Scope"
}
],
"description": "Details of the next-gen projects the issue type is available in.",
"readOnly": true
},
"self": {
"description": "The URL of these issue type details.",
"readOnly": true,
"type": "string"
},
"subtask": {
"description": "Whether this issue type is used to create subtasks.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"description": "The issue types available in Jira.",
"readOnly": true,
"type": "object"
},
"lastModified": {
"description": "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.",
"readOnly": true,
"type": "string"
},
"lastModifiedUser": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"description": "The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.",
"readOnly": true
},
"name": {
"description": "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.",
"type": "string"
},
"originalDefaultWorkflow": {
"description": "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.",
"readOnly": true,
"type": "string"
},
"originalIssueTypeMappings": {
"additionalProperties": {
"readOnly": true,
"type": "string"
},
"description": "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
"readOnly": true,
"type": "object"
},
"self": {
"format": "uri",
"readOnly": true,
"type": "string"
},
"updateDraftIfNeeded": {
"description": "Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`.",
"type": "boolean"
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('deleteWorkflowSchemeIssueType', {
# Add required parameters here
})