Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

RSVP LSP Service Orders Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director RSVP LSP Service Orders Management RESTful Web Services.

Get All RSVP LSP Service Orders

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

URI

api/space/nsas/rsvp-lsp/service-management/service-orders

HTTP Method

GET

Consumes

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

service-orders+xml

Produces

Collects all the configured RSVP LSP service orders.

Output

Sample XML Output

Get an RSVP LSP Service Order By Order ID

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

URI

api/space/nsas/rsvp-lsp/service-management/service-orders/

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

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

service-order+xml;version=2

Produces

Collects the details of a specific RSVP LSP service order.

Output (Point-to-Multipoint RSVP LSP Service Order)

Sample XML Output

Output (Point-to-Point RSVP LSP Service Order)

Sample XML Output

Create a Point-to-Point RSVP LSP Service Order

This request is used to create a point-to-point RSVP LSP service order.

URI

api/space/nsas/rsvp-lsp/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 a point-to-point RSVP LSP service order.

Input

Sample XML Input

Create a Point-to-Multipoint RSVP LSP Service Order

This request is used to create a point-to-multipoint RSVP LSP service order.

URI

api/space/nsas/rsvp-lsp/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

For the various options in creating ServiceOrder the options must be specified in the Action Element inside OperationSpecificData. The following values can be entered:

  • Save (Create and only Save a SO)

  • SaveAndValidate (Create, Save, and Validate a SO) Default value when no Custom action is specified.

  • SaveAndDeployNow (Create, Save, and Deploy a SO)

  • SaveAndDeployLater (Create, Save, and Deploy Later a SO)

Produces

Creates an RSVP LSP service order.

Input

Sample XML Input

Create an RSVP LSP Service Order and a Service Definition

This request is used to create an RSVP LSP service order and a service definition in a single REST API call.

URI

api/space/nsas/rsvp-lsp/service-management/service-orders/

HTTP Method

POST

Content-Type

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

service-order+xml;version=2;charset=UTF-8

Consumes

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

service-order-status+xml

Produces

Creates an RSVP LSP service order and a service definition in a single REST API call

Input

Sample XML Input

Output

Sample XML Output

Deploy, Validate, and Partially-Delete an RSVP LSP Service Order

This request is used to deploy, validate, or partially delete a previously created RSVP LSP service order.

URI

api/space/nsas/rsvp-lsp/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

Deploys, validates or, partially-deletes a previously created RSVP LSP service order.

Input

Sample XML Input

Output

Sample XML Output

Delete an RSVP LSP Service Order

This request is used to delete a previously configured RSVP LSP service order.

URI

api/space/nsas/rsvp-lsp/service-management/service-orders/

<serviceOrder-id>

HTTP Method

DELETE

Consumes

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

service-order+xml

Produces

Deletes an RSVP LSP service order.

Output

Sample XML Output

View the Pending Configuration of an RSVP LSP Service Order

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

URI

api/space/nsas/rsvp-lsp/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

Get an RSVP LSP Service Order Without BFD with Admin Groups By Order ID

This request is used to retrieve the details of a particular RSVP LSP service order without BFD with admin groups, based on the service order ID.

URI

api/space/nsas/rsvp-lsp/service-management/service-orders/

<serviceOrderId>

HTTP Method

GET

Consumes

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

service-order+xml

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

service-order+xml;version=2

Produces

Collects the details of a specific RSVP LSP service order without BFD with admin groups.

Output (With Admin Groups

Sample XML Output

Output (Without Admin Groups)

Sample XML Output

Create an RSVP LSP Service Order Without BFD with Admin Groups

This request is used to create an RSVP LSP service order without BFD with admin groups.

URI

api/space/nsas/rsvp-lsp/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 RSVP LSP service order without BFD with admin groups.

Input (Without BFD and Without Admin groups)

Sample XML Input

Input (Without BFD and With Admin Groups)

Sample XML Input

Get Job Details By Job ID for an RSVP LSP Point-to-Point Service Order

This request is used to obtain the details of a specific job, based on its unique identifier, for an RSVP LSP service order.

URI

/api/space/nsas/rsvp-lsp/service-

management/service-orders/jobId /{jobID}

HTTP Method

GET

Consumes

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

management.service-orders+xml

Produces

Retrieves the details of a particular job.

Mandatory Parameters

jobID

Output

Sample XML Output

Create LSP Service Order

This request is used to create an LSP Service Order.

URL

/api/space/nsas/csd/service-order

HTTP Method

POST

Sample URL

https://192.0.2.10/api/space/nsas/csd/service-order

Accept Header

application/xml

Content Type

application/xml

Request

Response

GET LSP Service Order

This request is used to retrieve previously configured LSP service orders.

URL

/api/space/nsas/rsvp-lsp/service-management/services/paging/<id>

HTTP Method

GET

Sample URL

https://192.0.2.10/api/space/nsas/rsvp-lsp/service-management/services/paging/98304

Accept

application/vnd.net.juniper.space.service-management.service-order+xml;version=2;

Content Type

application/vnd.net.juniper.space.service-management.service-order+xml;version=2;charset=UTF-8;

Request

Not Applicable

Response

Get Decommissioned Service Orders for LSP Service Definitions

This request is used to retrieve decommissioned service orders for LSP service definitions.

URL

/api/space/nsas/rsvp-lsp/service-management/service-orders/decomserviceorders?defnId=<defnID>

HTTP Method

GET

Sample URL

https://192.0.2.10:8443/api/space/nsas/rsvp-lsp/service-management/service-orders/decomserviceorders?defnId=4

Accept Header

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

Content Type

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

Request

Not Applicable

Response