Participant Simulator
This can be used for simulation testing purpose when there are no actual frameworks or a full deployment. Participant simulator can edit the states of AutomationCompositionElements and Participants for verification of other clamp-acm components for early testing. All clamp-acm components should be setup, except participant frameworks (for example, no policy framework components are needed) and participant simulator acts as respective participant framework, and state changes can be done with following REST APIs
Participant Simulator API
This API allows a Participant Simulator to be started and run for test purposes.
Download Policy Participant Simulator API Swagger
PUT /onap/participantsim/v2/elements
Updates simulated automation composition elements
Description: Updates simulated automation composition elements, returning the updated automation composition definition IDs
Consumes: [‘application/json’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Body of a automation composition element |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
GET /onap/participantsim/v2/elements/{name}/{version}
Query details of the requested simulated automation composition elements
Description: Queries details of the requested simulated automation composition elements, returning all automation composition element details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
path |
Automation Composition element name |
string |
version |
path |
Automation Composition element version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
PUT /onap/participantsim/v2/participants
Updates simulated participants
Description: Updates simulated participants, returning the updated automation composition definition IDs
Consumes: [‘application/json’]
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
body |
body |
Body of a participant |
|
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
201 - Created
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error
GET /onap/participantsim/v2/participants/{name}/{version}
Query details of the requested simulated participants
Description: Queries details of the requested simulated participants, returning all participant details
Produces: [‘application/json’, ‘application/yaml’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
name |
path |
Participant name |
string |
version |
path |
Participant version |
string |
X-ONAP-RequestID |
header |
RequestID for http transaction |
string |
Responses
200 - OK
401 - Authentication Error
403 - Authorization Error
404 - Not Found
500 - Internal Server Error