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 service 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

Section

List

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/service

Query String Parameters

Name Type Required Description

type string Optional Filter returned services to only those with the given type

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

services

Pagination query string parameters

Sorting query string parameters

Section

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.

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": "AAABcID5GBc=5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
       "type": {
          "id": "ldap-cache",
          "name": "filesystem"LDAP cache"
        },
        "description": "America "NetApp service",
    ...
  LDAP",
        "created": 1596707252548,
        "properties": { This is a dynamic JSON object }
     },
    {
      "id": "AAABcIueWUc=5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
      "type": "shareoint-online",
{
        "id": "group-expansion",
        "name": "Group expansion service"
      },
      "description": "SharePoint Online",
    ...
  }],
  "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/service?id=:idGET /aspire_api/serviceservices/:id

Query String and Path Parameters

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

Response

Code Block

language	js

{
  "service": {
    "id": "AAABcID5GBc=5d0b35d5-c946-44e7-9be5-97c9ad9036a3",
    "type": {
       "id": "ldap-cache",
 "filesystem"      "name": "LDAP cache"
     },
     "description": "NetApp service",
    ...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 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/connectorservices

Request Body Parameters

Name	Type	Required	Description
typecoords	string	Required	The type maven coordinates of service bundle to use for this service (may be omitted if service is specified)
description	string	Optional	An optional description of the service

Examples

Add a single service

Code Block

language	js

POST /aspire/_api/services
{
  "typecoords": "filesystemcom.accenture.aspire:app-ge-manager",
  "description": "NetAppGroup expansion service"
  ...
}

Add multiple services

Code Block

language	js

POST /aspire/_api/services
[{
  "typecoords": "filesystemcom.accenture.aspire:app-ge-manager",
  "description": "NetAppGroup expansion service"
  ...
},
{
  "typecoords": "sharepointcom.accenture.aspire:app-ldap-cache",
  "description": "SharePoint OnlineLDAP"
  ...
}]

Response

Code Block

language	js

{
  "connectorservice": [{
    "id": "AAABcID5GBc=",
    "type": "filesystem",
    "description": "NetApp"
Group    ...
  },
  {
    "type": "sharepoint",
    "description": "SharePoint Online"expansion service"
    ...
  }],
  "message": "optional response message"
}

Status

Response code Description

201 Created

406

Section

Update service(s)

Update a 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/

service

services

Path ParameterRequest Body Parameters

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

Request Body Parameters

type type use for this service (may be omitted if service is specified)

Name	Type	Required	Description
id		string	Required	The	identifier of the service to
description	string	Optional	An optional description of the service
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=",
  "servicedescription": "c:\\testdata\\2500Group expansion service",
  "type": "filesystem"...
}

ResponseUpdate multiple services

Code Block

language	js

PUT /aspire/_api/services
{
  "serviceAAABcID5GBc=": {
    "id": "AAABcID5GBc=",
    "Descriptiondescription": "NetGroup expansion Appservice",
    ...
  },
  "type"AAABcID5GBd=": {
    "id": "filesystemAAABcID5GBd=",
    "statusdescription": "NGroup expansion service",
    ...
  }
}

Response

Code Block

language	js

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

Status: 200, 404, 406

Not acceptable - there was an issue validating the input

: 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

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

Section

Delete service(s)

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 parameters

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

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

DELETE /aspire/_api/services?id=

:id

DELETE /aspire_api/service/:id

DELETE /aspire_api/service

AAABcID5GBc&id=AAABcID5GBd

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

Response

Code Block

language	js

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

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

QueryStringQuery String, Path and Request Body Parameters

Name

Type

Required

Description

id

string

Required

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

delete

control

action

string

Optional

The action to perform

start
stop

Examples

Delete Start a single service

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

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

Start Delete multiple services

Code Block

language	js

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

Delete 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 1

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 1

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