Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

RFC 2544 Tests Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director RFC 2544-Based Benchmarking Tests Management RESTful Web Services.

Get an RFC 2544 Service Order By Order ID

This request is used to retrieve the details of a particular RFC 2544-based service order, based on the service order ID.

URI

api/space/nsas/rfc2544/service-management/service-orders/<id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.service-order+xml

Produces

Collects the details of a specific RFC 2544 service order.

Output

Sample XML Output

Get All RFC 2544 Service Orders

This request is used to retrieve the all of the configured RFC 2544-based service orders.

URI

api/space/nsas/rfc2544/service-management/service-orders

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.service-orders+xml

Produces

Collects all of the configured RFC 2544 service orders.

Output

Sample XML Output

Get All RFC 2544 Services

This request is used to retrieve the details of a particular RFC 2544-based service based on the service ID.

URI

api/space/nsas/rfc2544/service-management/services/<id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.service+xml

Produces

Collects the details of all configured RFC 2544 services.

Output

Sample XML Output

Get an RFC 2544 Service By Service ID

This request is used to retrieve the details of a particular RFC 2544-based service based on the service ID.

URI

api/space/nsas/rfc2544/service-management/services/<id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.service+xml

Produces

Collects the details of a specific RFC 2544 service.

Output

Sample XML Output

Modify an RFC 2544 Service

This request is used to modify an RFC 2544-based service.

URI

api/space/nsas/rfc2544/service-management/services/<service-id>

HTTP Method

POST

Consumes

application/vnd.net.juniper.space.service-management.service-modify+xml

Produces

Modifies an RFC 2544 service.

Input

Sample XML Input

Output

Sample XML Output

Create an RFC 2544 Test

This request is used to create an RFC 2544 test.

URI

api/space/nsas/rfc2544/service-management/service-orders

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-order+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-order-status+xml

Produces

Creates an RFC 2544 test.

Input (CCC Family)

Sample XML Input

Input (INET Family)

Sample XML Input

Delete an RFC 2544 Service Order

This request is used to delete an RFC 2544 service order.

URI

api/space/nsas/rfc2544/service-management/service-orders/

<order-id>

HTTP Method

DELETE

Content Type

application/vnd.net.juniper.space.service-management.

service-order+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-order-status+xml

Produces

Deletes an RFC 2544 test service order.

Output

Sample XML Output

Validate an RFC 2544 Service Order

This request is used to validate an RFC 2544 service order.

URI

api/space/nsas/rfc2544/service-management/service-orders/

<order-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-order+xml

The options must be specified in the ‘Action’ Element inside OperationSpecificData. The various options are as follows:

ValidateNow (Validate now an already created SO)

ValidateLater (Validate later an already created SO)

Consumes

application/vnd.net.juniper.space.service-management.

service-order-status+xml

Produces

Validates an RFC 2544 test service order.

Input

Sample XML Input

Deploy an RFC 2544 Service Order

This request is used to deploy an RFC 2544 service order.

URI

api/space/nsas/rfc2544/service-management/service-orders/

<order-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-order+xml

The options must be specified in the ‘Action’ Element inside OperationSpecificData. The various options are as follows:

DeployNow (Deploy an already created SO)

DeployLater (Deploy Later an already created SO)

Consumes

application/vnd.net.juniper.space.service-management.

service-order-status+xml

Produces

Deploys an RFC 2544 test service order.

Input

Sample XML Input

Start an RFC 2544 Test

This request is used to commence an RFC 2544 test.

URI

/api/space/nsas/rfc2544/service-management/

services/137073//start-test

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

start-test+xml

Produces

Starts an RFC 2544 test.

Output

Sample XML Output

Stop an RFC 2544 Test

This request is used to stop an RFC 2544 test.

URI

/api/space/nsas/rfc2544/service-management/

services/137073/stop-test

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

stop-test+xml

Produces

Stops an RFC 2544 service.

Output

Sample XML Output

Modify an RFC 2544 Service to Add Methodology

This request is used to modify an RFC 2544 service to add methodology.

URI

/api/space/nsas/rfc2544/service-management/

services/137073/add-methodology

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-modify+xml

Produces

Modifies an RFC 2544 service.

Input

Sample XML Input

Decommission an RFC 2544 Service

This request is used to decommission a previously created RFC 2544 service.

URI

api/space/rfc2544/service-management/

services/{serviceId}

HTTP Method

DELETE

Content-Type

application/vnd.net.juniper.space.service-management.

service+xml

Produces

Decommissions a previously created RFC 2544 service.

Output

Sample XML Output

View the Results of an RFC 2544 Test

This request is used to display the results of an RFC 2544 test.

URI

/api/space/nsas/rfc2544/service-management/

services/137073/view-result

HTTP Method

GET

Content Type

application/vnd.net.juniper.space.

service-management.services+xml

Produces

Displays the results of an RFC 2544 test.

Output

Sample XML Output

View the MOS of an RFC 2544 Test

This request is used to display the mean opinion score (MOS) of an RFC 2544 test.

URI

/api/space/nsas/rfc2544/service-management/

services/137073/view-mos

HTTP Method

GET

Content Type

application/vnd.net.juniper.space.service-management.

services+xml

Produces

Displays the MOS of an RFC 2544 test.

Output

Sample XML Output

Calculate the MOS of an RFC 2544 Test

This request is used to calculate the mean opinion score (MOS) of an RFC 2544 test. Mean Opinion Score (MOS) is a metric used within the telecommunications industry to assess voice quality.

URI

/api/space/nsas/rfc2544/service-management/

services/137073/calculate-mos

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

mos-calculate+xml

Produces

Displays the MOS of an RFC 2544 test.

Input

Sample XML Input

Output

Sample XML Output

Create an RFC 2544 Service from Network Activate Services

This request is used to create an RFC 2544 service from an NA service.

URI

api/space/nsas/eline-ptp/service-management/

services/rfc2544/<servId>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.service+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Creates an RFC 2544 service from NA service.

Input (Default)

Sample XML Input

Input (User-Defined)

Sample XML Input

Output

Sample XML Output