Plugins API - GET all endpoints of a plugin
Lists all endpoints of the specified plugin.
The request produces an application/json payload.
| GET |
|
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string |
The ID of the required plugin. |
path | required |
Response format
The StubList object
An ordered list of short representations of DESK entities.
| Element | Type | Description |
|---|---|---|
| values | EntityShortRepresentation[] | An ordered list of short representations of DESK entities. |
The EntityShortRepresentation object
The short representation of a DESK entity.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the DESK entity. |
| name | string | The name of the DESK entity. |
| description | string | A short description of the DESK entity. |
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "DESK entity 1",
"description": "DESK entity 1 for the REST API example\n"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "DESK entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Example
In this example, the request inquires for endpoints of the SAP plugin, which has the ID of custom.remote.python.sap.
The API token is passed in the Authorization header.
The request lists these endpoints:
Curl
curl -X GET \
https://mySampleEnv.live.dexp.ae/api/config/v1/plugins/custom.remote.python.sap/endpoints \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dexp.ae/api/config/v1/plugins/custom.remote.python.sap/endpoints
Response body
{
"values": [
{
"id": "5677163660730843402",
"name": "SAPacceptance"
},
{
"id": "3369768960632214848",
"name": "SAPdevel"
}
]
}
Response code
200