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

List services

Lists all the services configured in the Aspire

Query String Parameters

Response

{
  "service": [{
    "id": "AAABcID5GBc=",
    "typedescription": "filesystem",
    "description": "NetApp Group expansion service",
    ...
  },
  {
    "id": "AAABcIueWUc=",
    "typedescription": "shareoint-online",
    "description": "SharePoint OnlineLDAP cache service",
    ...
  }],
  "message": "optional response message"
}

Status

Get a single service

Get information about a single service configured in Aspire

Query String and Path Parameters

Response

{
  "service": {
    "id": "AAABcID5GBc=",
    "typedescription": "filesystem",
    "description": "NetAppGroup expansion service",
    ...
  },
  "message": "optional response message"
}

Status

Add service

Adds a Add one or more services to Aspire

Panel
borderColor black bgColor #fafafb
POST /aspire_api/connector

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
{ "typecoords": "filesystem", "description": "NetApp" ... }

Add multiple services

Code Block
language js
[{ "type": "filesystemcom.accenture.aspire:app-ge-manager", "description": "NetApp" Group ... }, { "type": "sharepoint", "description": "SharePoint Online" expansion service" ... }]

Response

Code Block
language js
{ "connectorservice": [{ "id": "AAABcID5GBc=", "type": "filesystem", "description": "NetApp" Group ... }, { "type": "sharepoint", "description": "SharePoint Onlineexpansion service" ... }], "message": "optional response message" }

Status

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

---

Update service

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

Request Body Parameters

Examples

Update a single service

{
  "id": "AAABcID5GBc=",
  "servicedescription": "c:\\testdata\\2500Group expansion service",
  "type": "filesystem"...
}

Response

{
  "service": {
    "id": "AAABcID5GBc=",
    "Descriptiondescription": "NetGroup expansion Appservice",
    ...
   },
  "typemessage": "filesystem",
    "status": "N"
   },optional response message"
}

Status

Delete service(s)

Delete one or more services from Aspire.

Query String, Path and Request Body Parameters

Examples

Delete a single service

{
  "id": "AAABcID5GBc="
}

Delete multiple services

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Delete multiple services (alternative form)

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

{
  "message": "optional response message"
}

Status