Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

PTP Service Orders Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Precision Time Protocol (PTP) Service Orders Management RESTful Web Services.

Get a PTP Service Order By Service Order ID

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

URI

/api/space/nsas/timing-ptp/service-management/service-orders/

<service-order-id>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific PTP service order.

Output

Sample XML Output

Get All PTP Service Orders

This request is used to retrieve all the configured PTP service orders.

URI

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

service-orders/

HTTP Method

GET

Consumes

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

service-orders+xml

Produces

Collects all the configured PTP service orders.

Output

Sample XML Output

Delete PTP Service Order

This request is used to delete a PTP service order.

URI

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

service-orders/<id>

HTTP Method

DELETE

Consumes

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

service-order+xml

Produces

Deletes a PTP service order.

Output

Sample XML Output

Create a PTP Service Order

This request is used to create a PTP service order.

URI

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

service-orders/

HTTP Method

POST

Content Type

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

service-order+xml

Produces

Creates a PTP service order.

Input

Sample XML Input

Output

Sample XML Output

Get a PTP Service Order with Boundary Clock By Service Order ID

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

URI

/api/space/nsas/timing-ptp/service-management/service-orders/

<service-order-id>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific PTP service order.

Output

Sample XML Output

Create a PTP Service Order with Boundary Clock

This request is used to create a PTP service order.

URI

/api/space/nsas/timing-ptp/service-management/service-orders/

HTTP Method

POST

Content Type

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

service-order+xml

Produces

Creates a PTP service order.

Input

Sample XML Input

Output

Sample XML Output

Get a PTP Service Order with Hybrid Mode By Service Order ID

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

URI

/api/space/nsas/timing-ptp/service-management/service-orders/

<service-order-id>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific PTP service order.

Output

Sample XML Output

Create a PTP Service Order with Hybrid Mode

This request is used to create a PTP service order.

URI

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

service-orders/

HTTP Method

POST

Content Type

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

service-order+xml

Produces

Creates a PTP service order.

Input

Sample XML Input

Output

Sample XML Output

Get a PTP over Ethernet Service Order By Service Order ID

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

URI

/api/space/nsas/timing-ptp/service-management/service-orders/

<service-order-id>

HTTP Method

GET

Consumes

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

service-order+xml

Produces

Collects the details of a specific PTPoE service order.

Output

Sample XML Output

Create a PTP over Ethernet Service Order

This request is used to create a PTPoE service order.

URI

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

service-orders/

HTTP Method

POST

Content Type

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

service-order+xml

Produces

Creates a PTPoE service order.

Input With Hybrid enabled

Sample XML Input

Input With (Topology: Boundary and Transport Mode :Multicast)

Sample XML Input

Input With (Topology: Ordinary and Transport Mode :Multicast)

Sample XML Input

Output

Sample XML Output

Validate a PTP Service Order

This request is used to validate a previously created PTP service order.

URI

api/space/nsas/timing-ptp/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

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)

  • ValidateNow (Validate now an already created SO)

  • ValidateLater (Validate later an already created SO)

  • PartialDeleteNow (Delete the partially created configuration now)

  • PartialDeleteLater (Delete the partially created configuration Later

Produces

Validates a previously created PTP service order.

Input

Sample XML Input

View the Pending Configuration of a PTP Service Order

This request is used to view the details of a PTP service order that are pending to be applied to a device.

URI

api/space/nsas/timing-ptp/service-management/service-orders/

view-pendingorderconfiguration/<serviceOrder-id>

HTTP Method

GET

Consumes

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

pendingorder-config+xml

Produces

Displays the configuration details of a service order pending to be applied to a device.

Output

Sample XML Output