Skip to main content

Get plugin driven options

POST 
/field/plugin-options

Function Overview

  • Retrieve dynamic option data generated by plugins for specific fields.

  • Provide the plugin with contextual information (issue type, task, project, etc.) to return context-aware options.

  • Support pagination when the option count is large.

Example

{
  "field_uuid": "EGx9jsaH",
  "pagination": {
    "size": 50,
    "page": 1
  },
  "context": {
    "issue_type_uuid": "Cw2nMvjK",
    "task_uuid": "MM3animjQM6WJUdD",
    "project_uuid": "MM3animjuN9YpLGN"
  }
}

Request​

Query Parameters

    teamID stringrequired

    The team ID

Body

    field_uuid stringrequired

    Field UUID

    pagination

    object

    Pagination configuration

    size integer

    Default value: 20

    Page size

    page integer

    Default value: 1

    Page number

    context

    object

    Context information passed to plugins

    issue_type_uuid string

    Issue type UUID

    task_uuid string

    Task UUID

    project_uuid string

    Project UUID

Responses​

Request successful

Response Example

{
  "result": "SUCCESS",
  "data": {
    "options": [
      {
        "uuid": "0000000N",
        "value": "No"
      },
      {
        "uuid": "0000000Y",
        "value": "Yes"
      }
    ],
    "page_result": null
  },
  "error_code": ""
}

Field Description

  • options: Option list returned by the plugin

  • page_result: Pagination result returned by the plugin (nullable)

  • result: Request status, SUCCESS indicates success

  • error_code: Error code when the request fails

Schema

    result stringrequired

    Request status

    data

    object

    required

    Response data returned by the plugin

    options object[]required

    Option list returned by the plugin

    page_result

    object

    nullable

    Pagination metadata returned by the plugin

    property name* anynullable

    Pagination metadata returned by the plugin

    error_code stringrequired

    Error code when the request fails

Loading...