Leiga
  1. Project Module(project)
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
    • Get Issue Scheme
      GET
    • Get Issue Fields
      GET
    • Get Issue Field Detail
      GET
    • Batch Add Issue
      POST
    • New Issue
      POST
    • Batch Update Issue
      PATCH
    • Update Issue
      PATCH
    • Get Issue Detail V2
      GET
    • Get Issue Detail
      GET
    • Get Issue Detail By Issue Number
      GET
    • Remove Issue
      DELETE
    • Batch Remove Issue
      DELETE
    • Query Issue List
      POST
    • Query Issue List V2
      POST
    • Get Project Issue Filter Fields
      POST
    • Get Issue Select Options
      POST
    • Get Issue Relations
      GET
    • Add Issue Relation
      POST
    • Remove Issue 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 Issue(The free version does not support)
      POST
    • Get Finished Issue List
      POST
  • 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 Epic List
    • Epic Related Issue List
    • Get Epic Field List
    • Get Epic Field Detail
    • New Epic
    • Update Epic
    • Remove Epic
    • Get Epic Detail
    • Add Issues To Epic
  • 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. Project Module(project)

Get Project Overview Template

GET
https://app.leiga.com/openapi/api/project/project-overview-scheme
Project Module(project)

Request

Query Params
projectId
integer <int64>
required
Project ID
Example:
1
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/project/project-overview-scheme?projectId=1' \
--header 'accessToken: ' \
--header 'Content-Type: application/json'

Responses

🟢200OK
application/json
Body
fields
array [object {11}] 
optional
Project Fields 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
Example
{
  "code": "0",
  "data": {
    "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
  }
}
Modified at 2024-06-12 06:46:49
Previous
Get Project List
Next
New Project
Built with