Plugins
Operations related to the plugins
Get plugins by organization user
Authorizations
Query parameters
limitintegerOptionalDefault:
The limit of per page
10
pageintegerOptionalDefault:
The current page
1
textstringOptional
The text to search
organizationstringOptional
The organization ID to filter
Responses
200
OK
application/json
Responseall of
and
401
Unauthorized
application/json
403
Forbidden
application/json
get
/pluginsGET /api/plugins HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalDocs": 100,
"limit": 10,
"page": 1,
"totalPages": 10,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": 1,
"nextPage": 3,
"docs": [
{
"isPrivate": true,
"readme": "This is a readme",
"isVisible": true,
"_id": "63ea10b94a472e003305232b",
"name": "akinon-cli",
"organization": "6131198510b4640b303ebf1b",
"createdAt": "2020-07-23T12:00:00.000Z",
"updatedAt": "2020-07-23T12:00:00.000Z",
"lastDependencyPackage": {
"assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
"isPrivate": true,
"readme": "This is a readme",
"_id": "63ea10b94a472e003305232b",
"versionNumber": "1.0.0",
"publisher": {
"_id": "63ea10b94a472e003305232b",
"firstName": "Buğrahan",
"lastName": "Öztürk"
},
"dependency": "63ea10b94a472e003305232b",
"checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
"rank": 81001623508.4455,
"envVersionNumber": "1.0.1",
"createdAt": "2020-07-23T12:00:00.000Z",
"updatedAt": "2020-07-23T12:00:00.000Z"
}
},
{
"organization": {
"_id": "63ea10b94a472e003305232b",
"name": "Akinon",
"slug": "hello-world",
"description": "Akinon is a software company",
"owner": "63ea10b94a472e003305232b",
"isExecutive": false,
"status": 1,
"privileges": [
"project:read",
"project:write"
],
"imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
"createdAt": "2020-07-23T12:00:00.000Z",
"updatedAt": "2020-07-23T12:00:00.000Z"
}
}
]
}
Get plugins owners by organization user
Authorizations
Responses
200
OK
application/json
Responseall of
and
401
Unauthorized
application/json
403
Forbidden
application/json
get
/plugins/ownersGET /api/plugins/owners HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalDocs": 100,
"limit": 10,
"page": 1,
"totalPages": 10,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": 1,
"nextPage": 3,
"docs": [
{
"_id": "63ea10b94a472e003305232b",
"name": "Akinon"
}
]
}
Get a plugin by organization user
Authorizations
Path parameters
pluginIdstringRequiredExample:
The MongoDB ID
63ea10b94a472e003305232b
Pattern: ^[0-9a-fA-F]{24}$
Responses
200
OK
application/json
Responseall of
and
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
/plugins/{pluginId}GET /api/plugins/{pluginId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"isPrivate": true,
"readme": "This is a readme",
"isVisible": true,
"_id": "63ea10b94a472e003305232b",
"name": "akinon-cli",
"organization": "6131198510b4640b303ebf1b",
"createdAt": "2020-07-23T12:00:00.000Z",
"updatedAt": "2020-07-23T12:00:00.000Z",
"lastDependencyPackage": {
"assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
"isPrivate": true,
"readme": "This is a readme",
"_id": "63ea10b94a472e003305232b",
"versionNumber": "1.0.0",
"publisher": {
"_id": "63ea10b94a472e003305232b",
"firstName": "Buğrahan",
"lastName": "Öztürk"
},
"dependency": "63ea10b94a472e003305232b",
"checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
"rank": 81001623508.4455,
"envVersionNumber": "1.0.1",
"createdAt": "2020-07-23T12:00:00.000Z",
"updatedAt": "2020-07-23T12:00:00.000Z"
}
}
Get plugin packages by organization user
Authorizations
Path parameters
dependencyIdstringRequiredExample:
The MongoDB ID
63ea10b94a472e003305232b
Pattern: ^[0-9a-fA-F]{24}$
Query parameters
limitintegerOptionalDefault:
The limit of per page
10
pageintegerOptionalDefault:
The current page
1
sortstringOptionalExample:
The sort by field
{"value":"createdAt"}
versionNumberstringOptional
The version number to filter
envVersionNumberstringOptional
The env version number to filter
Responses
200
OK
application/json
Responseall of
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
/plugins/{dependencyId}/packagesGET /api/plugins/{dependencyId}/packages HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalDocs": 100,
"limit": 10,
"page": 1,
"totalPages": 10,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": 1,
"nextPage": 3,
"docs": [
{
"assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
"isPrivate": true,
"readme": "This is a readme",
"_id": "63ea10b94a472e003305232b",
"versionNumber": "1.0.0",
"publisher": {
"_id": "63ea10b94a472e003305232b",
"firstName": "Buğrahan",
"lastName": "Öztürk"
},
"dependency": "63ea10b94a472e003305232b",
"checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
"rank": 81001623508.4455,
"envVersionNumber": "1.0.1",
"createdAt": "2020-07-23T12:00:00.000Z",
"updatedAt": "2020-07-23T12:00:00.000Z"
}
]
}
Last updated
Was this helpful?