Help Center/CodeArts Pipeline/API Reference/API/Extension Plug-in Management/Querying the List of Optional Plug-ins in Pagination Mode
Updated on 2023-11-28 GMT+08:00
View PDF

Querying the List of Optional Plug-ins in Pagination Mode

Function

Querying the List of Optional Plug-ins in Pagination Mode

URI

POST /v1/{domain_id}/relation/plugins

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Indicates the tenant ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

Yes

Integer

Offset

limit

Yes

Integer

Size

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

use_condition

No

String

Used to distinguish whether a plug-in can be used by a pipeline or a template.

input_repo_type

No

String

Source code repository type, such as codehub, gitlab, and github.

input_source_type

No

String

Used to distinguish single-source and multi-source scenarios.

business_type

No

String

Service Type

regex_name

No

String

Name

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

offset

Integer

Offset

limit

Integer

Size

total

Integer

Total number.

data

Array of data objects

Result set

Table 6 data

Parameter

Type

Description

business_type

String

Service Type

display_name

String

Display Name

unique_id

String

Unique ID

editable

Boolean

Editable

removable

Boolean

Removable

cloneable

Boolean

Replicability

disabled

Boolean

Disable

conditions

Array of strings

Condition

plugins_list

Array of plugins_list objects

Plug-in

Table 7 plugins_list

Parameter

Type

Description

unique_id

String

Unique ID

display_name

String

Display Name

plugin_name

String

Plug-in

disabled

Boolean

Disable

group_name

String

Group Name

group_type

String

Group type

plugin_attribution

String

Attribute

plugin_composition_type

String

Composite Plug-in

runtime_attribution

String

Operating attributes

all_steps

Array of all_steps objects

Basic Plug-in List

description

String

Description

version_attribution

String

Version Attribute

icon_url

String

Icon URL

multi_step_editable

Integer

Editable

location

String

Address

publisher_unique_id

String

Publisher ID

manifest_version

String

Version

Table 8 all_steps

Parameter

Type

Description

plugin_name

String

Plug-in

display_name

String

Display Name

version

String

Version

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Error Message

error_code

String

Error code.

Example Requests

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugins?limit=4&offset=0

{
  "input_repo_type" : "codehub",
  "input_source_type" : "single",
  "use_condition" : "pipeline",
  "business_type" : "",
  "regex_name" : ""
}

Example Responses

Status code: 200

OK

{
  "offset" : 0,
  "limit" : 4,
  "total" : 246,
  "data" : {
    "plugins_list" : [ {
      "unique_id" : "1bfe2cd6b6f44fe3a918768e0391144f",
      "display_name" : "1030 test",
      "plugin_name" : "132132132231",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "single",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "84b6d96b240644b8a9c529981759a6d2",
      "display_name" : "Release",
      "plugin_name" : "create_test_2",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "multi",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "test",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "816c527f9ba34904b84823718633ecdf",
      "display_name" : "Plug-in Creation Test",
      "plugin_name" : "create_test.plugin_draft",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "multi",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "test",
      "version_attribution" : "draft",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "6e7a5fe5e7214ce6858087357a4bf79b",
      "display_name" : "Plug-in Version Description Test",
      "plugin_name" : "plugin_version_test",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "single",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "Plug-in Version Description Test",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    } ],
    "display_name" : "CodeCheck",
    "business_type" : "Gate",
    "unique_id" : "032ad7e2-5e19-4e90-8517-0958deb89e12",
    "conditions" : null,
    "editable" : false,
    "removable" : false,
    "cloneable" : false,
    "disabled" : false
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.