Not Supported Yet

Aspire 5.0 does not currently support services

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

Get all services

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

GET /aspire/_api/services

Pagination query string parameters

Sorting query string parameters

Get all services, filtered

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

Response

{
  "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: 200




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.

GET /aspire/_api/services/:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the service to return

Response

{
  "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: 200, 404




Add service(s)

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

POST /aspire/_api/services

Request Body Parameters

NameTypeRequiredDescription
coordsstringRequiredThe maven coordinates of bundle to use for this service
descriptionstringOptionalAn optional description of the service

Examples

Add a single service

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

Add multiple services

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

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

Status: 201, 406




Update service(s)

Update one or more service in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

PUT /aspire/_api/services/:id

PUT /aspire/_api/services



Path Parameter

NameTypeRequiredDescription
idstringRequiredThe identifier of the connector to update


Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the service to update
...
x

x - at least one field must be present


Examples

Update a single service

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

Update multiple services

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

Response

{"service":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}

Status: 200, 404, 406



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.

POST /aspire/_api/services/updateAll

Common filter

Update body parameter


Response

{
  "message": "update result response message"
}

Status: 200, 406

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.

POST /aspire/_api/services/deleteAll

Common filter

Response

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

Status: 200



Delete service(s)

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

DELETE /aspire/_api/services/:id

DELETE /aspire/_api/services

POST /aspire/_api/services/delete


Path Parameters and Query parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the service(s) to delete


Body Parameter

NameTypeRequiredDescription
idsstringRequiredThe identifier(s) of the service(s) to delete


Examples

DELETE /aspire/_api/services/AAABcID5GBc

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

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


Response

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

Status: 200, 404, 406





Control services

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

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

POST /aspire/_api/services/control

QueryString, Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequired

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

actionstringOptional

The action to perform

  • start
  • stop

Examples

Start a single service

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

Start multiple services

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

Start multiple services (alternative form)

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

Response

{
  "message": "optional response message"
}

Status: 200, 404, 406



  • No labels