Querying the Basic Plug-in List

Updated on 2023-11-28 GMT+08:00

View PDF

Function

URI

GET /v1/{domain_id}/relation/plugin/single

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Indicates the tenant ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
attribution	No	String	Attribute
offset	No	String	Offset
limit	No	String	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).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
offset	Integer	Offset
limit	Integer	Size
total	Integer	Total number.
data	Array of data objects	Viewing execution results

**Table 5** data
Parameter	Type	Description
name	String	Name
display_name	String	Display Name
plugin_attribution	String	Attribute
icon_url	String	Icon URL
description	String	Description
publisher_id	String	Publisher ID
manifest_version	String	Version

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Error Message
error_code	String	Error code.

Example Requests

GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugin/single?limit=10&offset=0&attribution=official&_=1699356895028

Example Responses

Status code: 200

{
  "offset" : 0,
  "limit" : 10,
  "total" : 3,
  "data" : [ {
    "name" : "official_shell_plugin",
    "display_name" : "Executing the Shell",
    "plugin_attribution" : "official",
    "icon_url" : "",
    "description" : "Used to run user shell commands.",
    "publisher_id" : null,
    "manifest_version" : "3"
  }, {
    "name" : "test_plugin_230725",
    "display_name" : "Testing the New Plug-in Process 2307251",
    "plugin_attribution" : "official",
    "icon_url" : "/api/v1/*/common/get-plugin-icon?object_key=test_plugin_230725-b7b10ddbbae14356ab16d649a43d7776-20210811-153521(WeLinkPC).png-ce8df55870164338a72d7e828a966a2a&icon_type=plugin",
    "description" : "Here is the description.",
    "publisher_id" : null,
    "manifest_version" : "3"
  }, {
    "name" : "official_git_clone",
    "display_name" : "official_git_clone",
    "plugin_attribution" : "official",
    "icon_url" : "",
    "description" : "Download the code library configured in the pipeline source.",
    "publisher_id" : null,
    "manifest_version" : null
  } ]
}