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 ControlLoopElements and Participants for verification of other controlloop components for early testing. All controlloop 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 control loop elements

• Description: Updates simulated control loop elements, returning the updated control loop definition IDs

• Consumes: [‘application/json’]

• Produces: [‘application/json’, ‘application/yaml’]

Parameters

Name	Position	Description	Type
body	body	Body of a control loop 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 control loop elements

• Description: Queries details of the requested simulated control loop elements, returning all control loop element details

• Produces: [‘application/json’, ‘application/yaml’]

Parameters

Name	Position	Description	Type
name	path	Control loop element name	string
version	path	Control loop 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 control loop 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