Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Service Templates Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Service Templates Management RESTful Web Services for E-line, IP, and E-LAN services.

Get All Service Templates with Dynamic Attribute Values

This request is used to retrieve all the configured service templates with dynamic attribute values.

URI

For E-Line: /api/space/nsas/eline-ptp/service-management/

service-templates/{ST-ID}?deviceName={deviceName}

For E-LAN: /api/space/nsas/elan-vpls/service-management/

service-templates/{ST-ID}?deviceName={deviceName}

For IP: /api/space/nsas/l3vpn/service-management/

service-templates/{ST-ID}?deviceName={deviceName}

HTTP Method

GET

Consumes

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

service-template+xml;version=2;

Produces

Collects all the configured service templates with dynamic attribute values.

Output

Sample XML Output

Get All Service Templates with XPath Tags

This request is used to retrieve all the configured service templates with XPath attributes.

URI

For E-Line: /api/space/nsas/eline-ptp/service-management/

service-templates/{ST-ID}

For E-LAN: /api/space/nsas/elan-vpls/service-management/

service-templates/{ST-ID}

For IP: /api/space/nsas/l3vpn/service-management/

service-templates/{ST-ID}

HTTP Method

GET

Consumes

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

service-template+xml;version=2;

Produces

Collects all the configured service templates with XPath attributes.

Output

Sample XML Output

Get All E-Line Service Templates

This request is used to retrieve all the configured Layer 2 Ethernet Private Line (EPL, also called E-Line) service templates.

URI

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

HTTP Method

GET

Consumes

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

service-templates+xml

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

service-templates+json

Produces

Collects all the configured E-Line service templates.

Output

Sample XML Output

Get an E-Line Service Template by Template ID

This request is used to retrieve a specific Layer 2 Ethernet Private Line (EPL, also called E-Line) service template, based on the template ID.

URI

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

service-templates/<templateId>

HTTP Method

GET

Consumes

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

service-templates+xml

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

service-templates+json

Produces

Retrieves the details of a specific configured E-Line service template.

Output

Sample XML Output

Get an E-Line Service Template by Service Definition ID

This request is used to retrieve a specific Layer 2 Ethernet Private Line (EPL, also called E-Line) service template, based on the service definition ID.

URI

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

295160/serviceTemplates

HTTP Method

GET

Consumes

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

service-templates+xml

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

service-templates+json

Produces

Retrieves the details of a specific configured E-Line service template based on a service definition ID.

Output

Sample XML Output

Get an E-Line Service Order Associated with a Service Template by Service Order ID

This request is used to retrieve a specific Layer 2 Ethernet Private Line (EPL, also called E-Line) service order that is attached to a service template, based on the service order ID.

URI

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

<ServiceOrderID>

api/space/nsas/elan-vpls/service-management/service-orders/

<ServiceOrderID>

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

<ServiceOrderID>

HTTP Method

GET

Consumes

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

Produces

Retrieves the details of a specific configured E-Line service order that contains a service template based on a service order ID.

Output (E-Line LDP)

Sample XML Output

Output (E-Line BGP)

Sample XML Output

Output (E-LAN LDP)

Sample XML Output

Output (E-LAN BGP)

Sample XML Output

Output (IP)

Sample XML Output

Get an E-Line Service Definition Associated with a Service Template by Service Definition ID

This request is used to retrieve a specific Layer 2 Ethernet Private Line (EPL, also called E-Line) service definition that is attached to a service template, based on the service definition ID.

URI

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

<ServiceDefinitionID>

HTTP Method

GET

Consumes

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

service-definition+xml

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

service-definition+json

Produces

Retrieves the details of a specific configured E-Line service definition that contains a service template based on a service definition ID.

Output

Sample XML Output

Create a Service Definition Associated with a Service Template

This request is used to create a service definition configured with a service template.

URI

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

api/space/nsas/elan-vpls/service-management/service-definitions/

api/space/nsas/l3vpn/service-management/service-definitions/

HTTP Method

POST

Content-Type

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

management.service-definition+xml;version=2;charset=UTF-8

Consumes

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

service-definition-status+xml;version=2

The following values are not correct and they are predefined as false.

<Decommission>false</Decommission>

<SvcSpecificValue>false</SvcSpecificValue>

The Xpath parameter is used in the following format:

<ConfigPageName>cp1</ConfigPageName>

Here, cp1 represents the configuration page in template. If more than one config page is present, all the values, such as cp1, cp2, and so on, are fetched correspondingly.

Produces

Creates a service definition configured with a service template

Input ( E-Line)

Sample XML Input

Input (E-Line TDM)

Sample XML Input

Input (Full-Mesh IP)

Sample XML Input

Input (Hub-and-Spoke IP)

Sample XML Input

Create a Service Order Associated with a Service Template

This request is used to create a service order configured with a service template.

URI

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

service-orders/

api/space/nsas/l3vpn/service-management/

service-orders/

api/space/nsas/elan-vpls/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;version=2

Produces

Creates a service order configured with a service template

Input (E-Line LDP)

Sample XML Input

Input (E-Line BGP)

Sample XML Input

Output (E-Line BGP)

Sample XML Output

Input (E-LAN Full-Mesh BGP)

Sample XML Input

Input (E-LAN Hub-and-Spoke BGP)

Sample XML Input

Input (E-LAN LDP)

Sample XML Input

Input (Full-Mesh IP OSPF)

Sample XML Input

Input (Full-Mesh IP BGP)

Sample XML Input

Input (Hub-and-Spoke IP OSPF)

Sample XML Input

Input (Hub-and-Spoke IP BGP)

Sample XML Input

Get an E-Line Service Associated with a Service Template By Service ID

This request is used to retrieve the details of a particular E-Line service that is configured with a service template, based on the service identifier.

URI

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

services/<serviceId>

HTTP Method

GET

Consumes

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

Produces

Collects the details of a specific E-Line service that contains a service template.

Output

Sample XML Output

Modify an E-Line Service Associated with a Service Template

This request is used to modify an E-Line service that contains a service template.

URI

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

services/{service-Id}

HTTP Method

POST

Content-Type

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

management.modify-service+xml;version=2;charset=UTF-8

Consumes

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

service-status+xml;version=2

Produces

Modifies an E-Line service that contains a service template.

Input

Sample XML Input