Leiga

Get Epic Field Detail

GET

https://app.leiga.com/openapi/api/epic/epic-field-info

Epic Module(epic)

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'

Response 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
  }
}

Request

Query Params

projectId

integer <int64>

required

Project ID

Example:

fieldCode

string

required

Field Code

Example:

xxx

Header Params

Content-Type

string

required

Example:

application/json

accessToken

string

required

Example:

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

Modified at 2024-06-12 06:46:49

Get Epic Field List

New Epic