WorkZappy
  1. Task Module(task)
WorkZappy
  • Authorize Module(authorize)
    • Get Permanent Token
    • Get Access Token
    • Refresh Access Token
  • User Module(user)
    • Get project member list (without pagination)
    • Get Project member list (with pagination)
    • Add Project Members
    • Remove Project Members
  • Organization Module(org)
    • Get Organization Users (with pagination)
    • Enable Organization User
    • Disable Organization User
    • Remove Organization User
  • Project Module(project)
    • Get Project Template List
    • Get Project List
    • Get Project Overview Template
    • New Project
    • Update Project
    • Get Project Information By Project Key
    • Get Project Information
    • Change Project Members Role
    • Get Project Roles
    • Get Project Roles
  • Task Module(task)
    • Get Task Type List
      GET
    • Get Task Scheme
      GET
    • Get Task Fields
      GET
    • Get Task Field Detail
      GET
    • Batch Add Task
      POST
    • New Task
      POST
    • Batch Update Task
      PATCH
    • Update Task
      PATCH
    • Get Task Detail V2
      GET
    • Get Task Detail
      GET
    • Get Task Detail By Task Number
      GET
    • Remove Task
      DELETE
    • Batch Remove Task
      DELETE
    • Query Task List
      POST
    • Query Task List V2
      POST
    • Get Project Task Filter Fields
      POST
    • Get Task Select Options
      POST
    • Get Task Relations
      GET
    • Add Task Relation
      POST
    • Remove Task Relation
      POST
    • Batch Add Subtasks
      POST
    • Remove Subtask
      DELETE
    • Update Subtask
      PATCH
    • Get Subtask List
      POST
    • Update Subtask Status
      PATCH
    • Get Subtask Field List
      POST
    • Add Labour Record
      POST
    • Update Labour Record
      PATCH
    • Remove Labour Record
      DELETE
    • Labour Record List
      POST
    • Get Trash Select Option List(The free version does not support)
      POST
    • Get Trash List(The free version does not support)
      POST
    • Restore Task(The free version does not support)
      POST
    • Get Finished Task List
      POST
  • Phase Module(phase)
    • New Phase
    • Update Phase
    • Remove Phase
    • Get Phase Detail
    • Get Project Phase List
  • Workflow Module(workflow)
    • Query Project Workflow List
    • Get State Transition List
  • Tag Module(tag)
    • New Tag
    • Update Tag
    • Remove Tag
    • Get Tag List
  • Webhook Module(webhook)
    • Get Webhook Type List
    • Get Webhook Event List
    • New Webhook
    • Remove Webhook
    • Update Webhook
    • Get Webhook Detail
    • Query Webhook List
  • Comment Module(comment)
    • New Comment
    • Update Comment
    • Remove Comment
    • Get Comment List
    • Update Comment Sticker
    • List Comment Sticker
  • File Module(file)
    • Upload File
    • Download File
    • Remove File
    • Get File List
    • Bind File
  • Personal Message Module(msg)
    • Get Personal Message List
  1. Task Module(task)

Get Task Scheme

GET
/issue/issue-scheme
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.workzappy.com/openapi/api/issue/issue-scheme?issueTypeId=1&projectId=1' \
--header 'accessToken: {{accessToken}}' \
--header 'Content-Type: application/json'
Response Response Example
{
    "code": "0",
    "data": {
        "issueTypeId": 1,
        "fields": [
            {
                "controlCode": "xxx",
                "isDefault": true,
                "fieldCode": "xxx",
                "options": [
                    {
                        "name": "xxx",
                        "value": 1
                    }
                ],
                "customFieldId": 1,
                "fieldDescription": "xxx",
                "multipleChoice": true,
                "customFieldName": "xxx",
                "fieldType": "xxx",
                "requiredFlag": true
            }
        ],
        "projectId": 1
    }
}

Request

Query Params
issueTypeId
integer <int64>
required
Issue Type ID
Example:
1
projectId
integer <int64>
required
Project ID
Example:
1
Header Params
Content-Type
string 
required
Example:
application/json
accessToken
string 
required
Example:
{{accessToken}}

Responses

🟢200OK
application/json
Body
issueTypeId
integer <int64>
optional
Issue Type ID
fields
array [object {11}] 
optional
Field List
controlCode
string 
optional
Field Control Code
isDefault
boolean 
optional
Is Default Value
childFields
array [object] 
optional
子字段
fieldCode
string 
optional
Field Code
options
array [object {2}] 
optional
Field Options
customFieldId
integer <int64>
optional
Custom Field ID
fieldDescription
string 
optional
Field Description
multipleChoice
boolean 
optional
Is Multiple Choice
customFieldName
string 
optional
Field Name
fieldType
string 
optional
Field Type
requiredFlag
boolean 
optional
Required
projectId
integer <int64>
optional
Project ID
Modified at 2025-03-21 12:08:36
Previous
Get Task Type List
Next
Get Task Fields
Built with