Warning

title	Page in development

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

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

Table of Contents

Section

List services

Lists all the services configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/service

Query String Parameters

Name	Type	Required	Description
description	string	Optional	Filter returned services to only those whose description matches the given expression

Response

Code Block

language	js

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

Status

Response code	Description
200	Success

Section

Get a single service

Get information about a single service configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/service?id=:id

GET /aspire_api/service/: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=",
    "description": "Group expansion service",
    ...
  },
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	The given service id was not found

Section

Add service

Adds a services to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/connector

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

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

Response

Code Block

language	js

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

Status

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

Section

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/service

Request Body Parameters

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

Examples

Update a single service

Code Block

language	js

{
  "id": "AAABcID5GBc=",
  "description": "Group expansion service",
  ...
}

Response

Code Block

language	js

{
  "service": {
    "id": "AAABcID5GBc=",
    "description": "Group expansion service",
    ...
   },
  "message": "optional 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 service(s)

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/service?id=:id

DELETE /aspire_api/service/:id

DELETE /aspire_api/service

Query String, Path and Request Body Parameters

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

Examples

Delete a single service

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete multiple services

Code Block

language	js

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

Delete multiple services (alternative form)

Code Block

language	js

{
  "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	Not acceptable - there was an issue validating the input

Section

Delete service(s)

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/service?id=:id

DELETE /aspire_api/service/:id

DELETE /aspire_api/service

Query String, Path and Request Body Parameters

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

Examples

Delete a single service

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete multiple services

Code Block

language	js

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

Delete multiple services (alternative form)

Code Block

language	js

{
  "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	Not acceptable - there was an issue validating the input

Page tree

Versions Compared

Old Version 2

New Version 3

Key

List services

Get a single service

Add service

Update service

Delete service(s)

Delete service(s)

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

List services

Get a single service

Add service

Update service

Delete service(s)

Delete service(s)