Get an Action Library
get
/action/library
Retrieves the action library.
Request
There are no request parameters for this operation.
Back to TopResponse
200 Response
The action library was retrieved successfully.
Examples
The following example shows how to retrieve action library by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
curl -X GET "hostname:port/action/library" -H "accept: */*"
Example of Response Body
If successful, the response code 200 is returned with a response body. For example:
[
{
"actions": [
{
"bdd": "user gets bill items",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/bills/account/",
"expectedStatusCode": "200"
},
"name": "user gets bill items",
"path": "bcws/bills",
"tags": [
"bill",
"items",
"from",
"account",
"id"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "user gets bill items"
},
{
"bdd": "user validates installed assets status in BRM",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/subscriptions/account/",
"expectedStatusCode": "200"
},
"name": "user validates installed assets status in BRM",
"path": "bcws/assets",
"tags": [
"status",
"disconnect",
"installed",
"assets",
"BRM"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "user validates installed assets status in BRM"
},
{
"bdd": "count for sevice type",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/services/account/",
"expectedStatusCode": "200"
},
"name": "count for sevice type",
"path": "bcws/service",
"tags": [
"bcws",
"account"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "count for sevice type"
},
{
"bdd": "get service details by service id",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/subscriptions/service/",
"expectedStatusCode": "200"
},
"name": "get service details by service id",
"path": "bcws/service",
"tags": [
"bcws",
"service"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "get service details by service id"
},
{
"bdd": "get charge offers",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/subscriptions/account/",
"expectedStatusCode": "200"
},
"name": "get charge offers",
"path": "bcws/account",
"tags": [
"bcws",
"account",
"collection"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "get charge offers"
},
{
"bdd": "get account details",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/accounts/",
"expectedStatusCode": "200"
},
"name": "get account details",
"path": "bcws/account",
"tags": [
"account",
"create",
"get",
"id",
"salesorder"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "get account details"
},
{
"bdd": "generate a bill for an account",
"data": {
"method": "POST",
"request": "create-bill-for-account.request.json",
"resource": "bcws/webresources/v1.0/bills/billnow/billunit/",
"requestType": "REQUEST",
"requestString": "{}",
"expectedStatusCode": "201"
},
"name": "generate a bill for an account",
"path": "bcws/bills/generate-a-bill",
"tags": [
"account",
"create",
"new",
"address",
"salesorder"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "generate a bill for an account"
},
{
"bdd": "get adjustments for bill unit",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/adjustments/billunit/",
"expectedStatusCode": "200"
},
"name": "get adjustments for bill unit",
"path": "bcws/adjustments",
"tags": [
"account",
"create",
"get",
"id",
"salesorder",
"adjustments"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "get adjustments for bill unit"
},
{
"bdd": "get details about an adjustment",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/adjustments/",
"expectedStatusCode": "200"
},
"name": "get details about an adjustment",
"path": "bcws/adjustments",
"tags": [
"account",
"create",
"get",
"id",
"salesorder",
"adjustments"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "get details about an adjustment"
},
{
"bdd": "user get bill unit summary",
"data": {
"method": "GET",
"resource": "bcws/webresources/v1.0/billunits/account/",
"expectedStatusCode": "200"
},
"name": "user get bill unit summary",
"path": "bcws/bills",
"tags": [
"bill",
"unit",
"summary",
"by",
"account",
"id"
],
"product": "brm-bcws-service",
"actionType": "REST",
"description": "user get bill unit summary"
}
],
"product": "brm-bcws-service"
},
...
{
"actions": [
{
"bdd": "execute SSH command on BRM",
"data": {
"subType": "SSHCommandAction",
"expectedStatusCode": "0"
},
"name": "Execute SSH command on BRM",
"path": "BRM-SSH/execute-brm-ssh-command",
"tags": [
"brm",
"ssh"
],
"product": "brm-ssh-test",
"actionType": "SSH",
"description": "Execute SSH command on BRM"
}
],
]If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.