Warning

title	Not Supported Yet

Aspire 5.0 does not currently support services

Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The services API provides functionality that allows a administrator to perform actions such as adding and configuring services

toc

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Filter returned services to only those whose description matches the given expression

Section

Get all services

Lists all the services configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/services

Pagination query string parameters

Sorting query string parameters

Section

Get all services, filtered

Lists services

Query String Parameters

Name Type Required Description

description string Optional

configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/services/getAll

Pagination query string parameters

Sorting query string parameters

Common filter

Response

Code Block

language	js

{
  "service": [
    {
       "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
       "type": {
          "id": "ldap-cache",
          "name": "LDAP cache"
        },
        "description": "America LDAP",
        "created": 1596707252548,
        "properties": { This is a dynamic JSON object }
     },
    {
      "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type": {
        "id": "group-expansion",
        "name": "Group expansion service"
      },
      "description": "Group Expansion",
      "created": 1596707252548,
      "properties": { This is a dynamic JSON object }
    }
  ],
  "from": 100,
  "size": 10,
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response codeDescription

: 200

Success

: 200, 404

Section

Get a single service

Get information about a single service configured in Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/services/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the service to return

Response

Code Block

language	js

{
  "service": {
    "id": "5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
    "type": {
       "id": "ldap-cache",
       "name": "LDAP cache"
     },
     "description": "America LDAP",
     "created": 1596707252548,
     "properties": { This is a dynamic JSON object }
  },
  "message": "optional response message"
}

Status

Response code Description

200 Success

404 The given service id was not found

Not acceptable - there was an issue validating the input

: 201, 406

Section

Add

services

service(s)

Add one or more services to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/services

Request Body Parameters

Name	Type	Required	Description
coords	string	Required	The maven coordinates of bundle to use for this service
description	string	Optional	An optional description of the service

Examples

Add a single service

Code Block

language	js

POST /aspire/_api/services
{
  "coords": "com.accenture.aspire:app-ge-manager",
  "description": "Group expansion service"
  ...
}

Add multiple services

Code Block

language	js

POST /aspire/_api/services
[{
  "coords": "com.accenture.aspire:app-ge-manager",
  "description": "Group expansion service"
  ...
},
{
  "coords": "com.accenture.aspire:app-ldap-cache",
  "description": "LDAP"
  ...
}]

Response

Code Block

language	js

{
  "service": [{
    "id": "AAABcID5GBc=",
    "description": "Group expansion service"
    ...
  }],
  "message": "optional response message"
}

Status

Response code Description

201 Created

406

Section

Update

services

service(s)

Update one or more service in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/services/:id

PUT /aspire/_api/services

Request Body ParametersPath Parameter

Name	Type	Required	Description
id	string	Required	The identifier of the service connector to update

Request Body Parameters

Name	Type	Required	Description
iddescription	string	Optional	Required	The identifier An optional description of the service to update
...		x

x - at least one field must be present

Examples

Update a single service

Code Block

language	js

PUT /aspire/_api/services/AAABcID5GBc%3D
{
  "id": "AAABcID5GBc=",
  "description": "Group expansion service",
  ...
}

Update multiple services

Code Block

language	js

PUT /aspire/_api/services
{
  "AAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "description": "Group expansion service",
    ...
  },
  "AAABcID5GBd=": {
    "id": "AAABcID5GBd=",
    "description": "Group expansion service",
    ...
  }
}

Response

Code Block

language	js

{
  "service": [{
    "updated":true,"id": "AAABcID5GBc=",
    "description": "Group expansion service",
    ...
   }],},{"updated":true,"id":"AAABcID5GBd="}]}

Status: 200, 404, 406

: 200, 406

Section

Update services, filtered

Update services configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/services/updateAll

Common filter

Update body parameter

Response

Code Block

language	js

{
  "message": "optionalupdate result response message"
}

Status

Response code Description

201 Created

404 Not found - a given service identifier was not found

406 Not acceptable - there was an issue validating the input

Section

Delete multiple services, filtered

Delete multiple services from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/services/deleteAll

Common filter

Response

Code Block

language	js

{
  "message": "delete result response message"
}

Status: 200

Not acceptable - there was an issue validating the input

: 200, 404, 406

Section

Delete service(s)

Section

Delete services

Delete one or more services from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/services/:id

DELETE /aspire/_api/services

POST /aspire/_api/services/delete

Path Parameters and Query String Parametersparameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the service(s) to delete

Examples

Delete a single service

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the service(s) to delete

Examples

Code Block

language	js

DELETE /aspire/_api/services/AAABcID5GBc%3D

Delete multiple services

Code Block

language	js

AAABcID5GBc

DELETE /aspire/_api/services?id=AAABcID5GBc=&id=AAABcIueWUc=AAABcID5GBd

POST /aspire/_api/services/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js

{
  "message": "optionaldelete result response message"
}

Status

Response code Description

200 Success

404 Not found - a given service identifier was not found

406

Not acceptable - there was an issue validating the input

: 200, 404, 406

Section

Control services

Control one or more services from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/services/:id/control

POST /aspire/_api/services/control

QueryString, Path and Request Body Parameters

Name

Type

Required

Description

id

string

Required

The identifier(s) of the service(s) to control

action

string

Optional

The action to perform

start
stop

Examples

Start a single service

Code Block

language	js

POST /aspire/_api/services/AAABcID5GBc%3D

Start multiple services

Code Block

language	js

PUT /aspire/_api/services
[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Start multiple services (alternative form)

Code Block

language	js

PUT /aspire/_api/services
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code Description

200 Success

404 Not found - a given service identifier was not found

406

Page tree

Versions Compared

Old Version 12

New Version Current

Key

Get all services

Get all services, filtered

Get a single service

Add

service(s)

Update

service(s)

Update services, filtered

Delete multiple services, filtered

Delete service(s)

Control services

Page tree

Page History

Versions Compared

Old Version 12

New Version Current

Key

Get all services

Get all services, filtered

Get a single service

Add

service(s)

Update

service(s)

Update services, filtered

Delete multiple services, filtered

Delete service(s)

Control services