Leiga
  1. Epic Module(epic)
Leiga
  • Authorize Module(authorize)
    • Get Permanent Token
      POST
    • Get Access Token
      POST
    • Refresh Access Token
      POST
  • User Module(user)
    • Get project member list (without pagination)
      GET
    • Get Project member list (with pagination)
      GET
    • Add Project Members
      POST
    • Remove Project Members
      DELETE
  • Organization Module(org)
    • Get Organization Users (with pagination)
      GET
    • Enable Organization User
      POST
    • Disable Organization User
      POST
    • Remove Organization User
      DELETE
  • Project Module(project)
    • Get Project Template List
      GET
    • Get Project List
      GET
    • Get Project Overview Template
      GET
    • New Project
      POST
    • Update Project
      PATCH
    • Get Project Information By Project Key
      GET
    • Get Project Information
      GET
    • Change Project Members Role
      POST
    • Get Project Roles
      GET
    • Get Project Roles
      POST
  • Issue Module(issue)
    • Get Issue Type List
    • Get Issue Scheme
    • Get Issue Fields
    • Get Issue Field Detail
    • Batch Add Issue
    • New Issue
    • Batch Update Issue
    • Update Issue
    • Get Issue Detail V2
    • Get Issue Detail
    • Get Issue Detail By Issue Number
    • Remove Issue
    • Batch Remove Issue
    • Query Issue List
    • Query Issue List V2
    • Get Project Issue Filter Fields
    • Get Issue Select Options
    • Get Issue Relations
    • Add Issue Relation
    • Remove Issue Relation
    • Batch Add Subtasks
    • Remove Subtask
    • Update Subtask
    • Get Subtask List
    • Update Subtask Status
    • Get Subtask Field List
    • Add Labour Record
    • Update Labour Record
    • Remove Labour Record
    • Labour Record List
    • Get Trash Select Option List(The free version does not support)
    • Get Trash List(The free version does not support)
    • Restore Issue(The free version does not support)
    • Get Finished Issue List
  • Sprint Module(sprint)
    • New Sprint
    • Update Sprint
    • Remove Sprint
    • Get Sprint Detail
    • Get Project Sprint List
  • Workflow Module(workflow)
    • Query Project Workflow List
    • Get State Transition List
  • Tag Module(tag)
    • New Tag
    • Update Tag
    • Remove Tag
    • Get Tag List
  • Epic Module(epic)
    • Epic Filter Options
      GET
    • Get Epic List
      POST
    • Epic Related Issue List
      POST
    • Get Epic Field List
      GET
    • Get Epic Field Detail
      GET
    • New Epic
      POST
    • Update Epic
      POST
    • Remove Epic
      POST
    • Get Epic Detail
      GET
    • Add Issues To Epic
      POST
  • Version Module(version)
    • Get Version Status List
    • Get Version Owner Options
    • Get Version List
    • New Version
    • Update Version
    • Remove Version
    • Release Version
    • Cancel Release Version
    • Archive Version
    • Cancel Archive Version
    • Get Version Details
    • Add Issue To Version
    • Remove Issue From Version
    • Version Related Issue 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. Epic Module(epic)

Get Epic Field Detail

GET
https://app.leiga.com/openapi/api/epic/epic-field-info
Epic Module(epic)

Request

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

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.leiga.com/openapi/api/epic/epic-field-info?projectId=1&fieldCode=xxx' \
--header 'accessToken: ' \
--header 'Content-Type: application/json'

Responses

🟢200OK
application/json
Body
controlCode
string 
optional
Field Control Code
isDefault
boolean 
optional
Is Default Value
childFields
array [object] 
optional
Child Field List
fieldCode
string 
optional
Field Code
options
array [object {2}] 
optional
Field Options
name
string 
optional
Option Name
value
object 
optional
Option Value
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
Example
{
  "code": "0",
  "data": {
    "controlCode": "xxx",
    "isDefault": true,
    "fieldCode": "xxx",
    "options": [
      {
        "name": "xxx",
        "value": 1
      }
    ],
    "customFieldId": 1,
    "fieldDescription": "xxx",
    "multipleChoice": true,
    "customFieldName": "xxx",
    "fieldType": "xxx",
    "requiredFlag": true
  }
}
Modified at 2024-06-12 06:46:49
Previous
Get Epic Field List
Next
New Epic
Built with