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
Lists all the services configured in the Aspire
GET /aspire/_api/services
Query String Parameters
Name | Type | Required | Description |
---|---|---|---|
description | string | Optional | Filter returned services to only those whose description matches the given expression |
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
Response code | Description |
---|---|
200 | Success |
Get information about a single service configured in Aspire
GET /aspire/_api/services/:id
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The 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
Response code | Description |
---|---|
200 | Success |
404 | The given service id was not found |
Add one or more services to Aspire
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
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
Response code | Description |
---|---|
201 | Created |
406 | Not acceptable - there was an issue validating the input |
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
PUT /aspire/_api/services/:id
PUT /aspire/_api/services
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
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": [{ "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 |
Delete one or more services from Aspire.
DELETE /aspire/_api/services/:id
DELETE /aspire/_api/services
Path and Query String Body Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | Required | The identifier(s) of the service(s) to delete |
Examples
Delete a single service
DELETE /aspire/_api/services/AAABcID5GBc%3D
Delete multiple services
DELETE /aspire/_api/services { "id": [ "AAABcID5GBc=", "AAABcIueWUc=" ] }
Response
{ "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 |
Control one or more services from Aspire.
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
|
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
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 |