Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Modified and New REST APIs for Migrating from Services Activation Director to Connectivity Services Director

 

If you have already deployed Services Activation Director in your network for configuring, managing, and administering a large number of devices, and if you migrate to Connectivity Services Director, it is essential to be familiar with the different REST Web Services that are enhanced or newly introduced in Connectivity Services Director. This topic contains the following sections that describe the REST API calls that are modified or newly added in Connectivity Services Director. For the REST APIs that are modified from Services Activation Director, the parameters that are added are highlighted and their significance is also mentioned. Examples of request and response XML calls are also included.

Modified REST APIs in Connectivity Services Director

This section describes the REST APIs that were present in Services Activation Director and are modified in Connectivity Services Director. The parameters that are updated or newly added in the APIs are listed.

Modify an LSP Service Order

This request is used to modify a particular LSP service order.

New Parameters

"RSVPLSPConfigOrderParameterType

SetupPriority (Integer)

HoldPriority (Integer)

ClassOfService (Integer) "

Description of the Changes

The three new parameters are sent in request payload to configure them at root LSP level. In Services Activation Director, you could configure these parameters at Primary and Secondary LSP paths only. In the old version of API, these parameters are not used and therefore, they are not sent in the request payload). A value of -1 indicates that parameter must be deleted from the service order

URI

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

orders/{service_order_id})

HTTP Method

POST

Consumes

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

management.modify-service-order+xml

Content Type

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

management.modify-service-order+xml

Produces

Modifies an existing LSP service order.

Mandatory Parameters

"<?xml version=""1.0"" encoding=""UTF-8""?>
<Data xmlns=""services.schema.networkapi.jmp.juniper.net"">
  <ServiceResource>
    <ServiceOrder>
      <Common>
        <Name>lsp2</Name>
      </Common>
      <LSPPattern key=""134""/>
      <ServiceEndPointGroup>
        <DeviceInfo>
          <TA>
            <Source>
              <DeviceName>960R1_EN_Alok_re</DeviceName>
              <DeviceID>65560</DeviceID>
            </Source>
            <Destination>
              <DeviceName>960R2_EN_Alok_re</DeviceName>
              <DeviceID>65539</DeviceID>
            </Destination>
          </TA>
        </DeviceInfo>
        <ServiceEndPoint>
          <ServiceEndpointConfiguration xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""RSVPLSPBFDEndPointParameterOrderType"">
            <PrimaryPath>
              <PathName>primary</PathName>
              <SetupPriority>7</SetupPriority>
              <Adaptive>Disabled</Adaptive>
              <HoldPriority>0</HoldPriority>
              <ClassOfService>0</ClassOfService>
              <HopLimit>255</HopLimit>
              <Bandwidth>-1</Bandwidth>
              <Paths>
                <Path>
                  <PathName>primary</PathName>
                  <IPAddress>40.1.3.2</IPAddress>
                  <Connection>Strict</Connection>
                </Path>
                <Path>
                  <PathName>primary</PathName>
                  <IPAddress>40.3.4.1</IPAddress>
                  <Connection>Strict</Connection>
                </Path>
              </Paths>
            </PrimaryPath>
            <SecondaryPath>
              <PathName>secondary</PathName>
              <SetupPriority>7</SetupPriority>
              <Adaptive>Disabled</Adaptive>
              <HoldPriority>0</HoldPriority>
              <ClassOfService>1</ClassOfService>
              <HopLimit>255</HopLimit>
              <Bandwidth>-1</Bandwidth>
              <StandBy>undefined</StandBy>
              <Paths>
                <Path>
                  <PathName>secondary</PathName>
                  <IPAddress>40.1.2.2</IPAddress>
                  <Connection>Loose</Connection>
                </Path>
                <Path>
                  <PathName>secondary</PathName>
                  <IPAddress>40.2.4.2</IPAddress>
                  <Connection>Loose</Connection>
                </Path>
              </Paths>
            </SecondaryPath>
          </ServiceEndpointConfiguration>
        </ServiceEndPoint>
      </ServiceEndPointGroup>
      <ServiceOrderParameter xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""RSVPLSPBFDConfigParameterOrderType"">
        <ClassOfService>-1</ClassOfService>
        <HopLimit>255</HopLimit>
        <HoldPriority>0</HoldPriority>
        <SetupPriority>7</SetupPriority>
        <StandBy>false</StandBy>
        <Adaptive>Disabled</Adaptive>
        <RetryLimit>0</RetryLimit>
        <RetryTimer>30</RetryTimer>
        <BandWidth>-1</BandWidth>
        <LDPTunneling>Disabled</LDPTunneling>
        <ProtectionSetting>
          <LSPProtectionType>Path Protection</LSPProtectionType>
          <EnableFR>Disabled</EnableFR>
        </ProtectionSetting>
        <BFD>
          <BFDdetection>This LSP</BFDdetection>
          <MinInterval>300</MinInterval>
          <MinReceiveInterval>50</MinReceiveInterval>
          <Multiplier>3</Multiplier>
          <NoAdaption>false</NoAdaption>
          <TransmitMinInterval>50</TransmitMinInterval>
          <FailureAction>Teardown</FailureAction>
        </BFD>
      </ServiceOrderParameter>
    </ServiceOrder>
  </ServiceResource>
  <CustomAction xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""ServiceOrderCustomActionType"">
    <Action>SaveAndValidate</Action>
  </CustomAction>
</Data>
"

Input

Sample XML Input

Output

Sample XML Output

Get an LSP Service Order By Order ID

This request is used to retrieve a particular LSP service order

New Parameters

"RSVPLSPConfigOrderParameterType

SetupPriority (Integer)

HoldPriority (Integer)

ClassOfService (Integer) "

Description of the Changes

The three new parameters are returned in the response XML under parent tag RSVPLSPConfigOrderParameterType. These are the values configured at root level for LSP which will be inherited at primary and secondary path. If required, they can be overridden in the primary and secondary paths.

URI

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

service-orders/{service_order_id}

HTTP Method

GET

Consumes

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

management.service-order+xml

Produces

Collects a particular LSP service order.

Output

Sample XML Output

Get All E-LAN Service Definitions

This request is used to retrieve all the configured E-LAN service definitions.

New Parameters

ServiceType

Signalling (String)

Description of the Changes

The Signalling value ( LDP or BGP) was being shown wrongly in the UI for E-LAN Service Definitions. Therefore, this attribute is added to the xsd file to enable the appropriate values to be populated and sent to the REST layer.

URI

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

HTTP Method

GET

Consumes

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

management.service-definitions+xml;version=2

Content Type

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

management.service-definitions+xml;version="2"

Produces

Collects all configured E-LAN service definitions.

Output

Sample XML Output

Create an IP Service Definition

This request is used to create an IP service definition.

New Parameters

"ServiceDefinitionType

IsStandard (Boolean)

DecoupleStatus (Boolean)"



"L3VPNEndPointParameterDefType

MTU (L3VPNCommonDefType)

EnableRateLimiting (L3VPNCommonDefType)

DefaultBandwidth (L3VPNCommonDefType)

MinBandwidth (L3VPNCommonDefType)

MaxBandwidth (L3VPNCommonDefType)

Increment (L3VPNCommonDefType)

CalculateBurstSizeType (String)

BurstPeriod (L3VPNCommonDefType)

MTUFactor (L3VPNCommonDefType)"

Description of the Changes

The IsStandard parameter enables you to identify whether the definition is created by a user or already existing in the system. Previously, DecoupleStatus was not handled as part of the REST API call.

Note: You cannot create a service definition with 'isStandard' as true. The 'isStandard' parameter is set as true only for service definitions that are already present in the database. The other service definitions that are user-created contain the 'isStandard' parameter as false.

All the parameters of L3VPNEndPointParameterDefType enable in allocation of bandwidth and rate limit the service. Rate-limiting parameters were already available in other service definitions except L3VPN.

Note: MTUFactor and Burst Period are mutually exclusive.

URI

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

service-definitions

HTTP Method

POST

Consumes

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

management.service-definition-status+xml;version=2

Content Type

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

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

Produces

Creates an IP service definition.

Input

Sample XML Input (With ServiceDefinitionType)

Sample XML Input (With L3VPNEndPointParameterDefType)

Get All IP Service Definitions

This request is used to retrieve all the configured IP service definitions.

New Parameters

"ServiceDefinitionType

IsStandard (Boolean)

DecoupleStatus (Boolean)"

Description of the Changes

The IsStandard parameter enables you to identify whether the definition is created by a user or already existing in the system. Previously, DecoupleStatus was not handled as part of the REST API call.

URI

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

HTTP Method

GET

Consumes

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

management.service-definitions+xml;version=2

Content Type

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

management.service-definitions+xml;version="2"

Produces

Collects all the IP service definitions.

Mandatory Parameters

Output

Sample XML Output

Get an IP Service Definition By Definition ID

This request is used to retrieve the details of a configured IP service definition, based on the service definition ID.

New Parameters

"ServiceDefinitionType

IsStandard (Boolean)

DecoupleStatus (Boolean)"

Description of the Changes

The IsStandard parameter enables you to identify whether the definition is created by a user or already existing in the system. Previously, DecoupleStatus was not handled as part of the REST API call

URI

api/space/nsas/service-management/service-definitions/<definitionID>

HTTP Method

GET

Consumes

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

management.service-definition+xml;version=2

Content Type

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

management.service-definition+xml;version="2"

Produces

Retrieves a specific IP service definition.

Output

Sample XML Output

Create an IP Service Order

This request is used to configure an IP service order.

New Parameters

"L3VPNEndPointParameterOrderType

MTURangeValues

BandwidthParamRangeType

COSProfileId (Integer)

ShapingRate (Integer)"



"L3VPNConfigParameterOrderType

MTUFactor (Integer)

BurstPeriod (Integer)"

Description of the Changes

The parameters enable you to rate limit the service and also help user to enable quality of service.

URI

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

service-orders

HTTP Method

POST

Consumes

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

management.service-order-status+xml;version=2

Content Type

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

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

Produces

Creates an IP service order.

Input (With L3VPNEndPointParameterOrderType and L3VPNConfigParameterOrderType)

Sample XML Input

Get an IP Service Order By Order ID

This request is used to retrieve a specific IP service order.

New Parameters

"L3VPNEndPointParameterOrderType

MTURangeValues

BandwidthParamRangeType

COSProfileId (Integer)

ShapingRate (Integer)"



"L3VPNConfigParameterOrderType

MTUFactor (Integer)

BurstPeriod (Integer)"

Description of the Changes

The parameters enable you to rate limit the service and also help user to enable quality of service.

URI

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

orders/4128932

HTTP Method

GET

Consumes

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

Produces

Retrieves the details of a particular IP service order.

Output (With L3VPNEndPointParameterOrderType and L3VPNConfigParameterOrderType)

Sample XML Output

Get All RSVP LSP Services

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

New Parameters

"RSVPLSPConfigParameterServiceType

SetupPriority (Integer)

HoldPriority (Integer)

ClassOfService (Integer)"

Description of the Changes

The new parameters are returned in the response XML under the parent tag ServiceParameters. These are the values configured at root level for LSP that are inherited at primary and secondary path. If required, they can be overridden in the primary and secondary paths.

URI

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

HTTP Method

GET

Consumes

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

Produces

Collects all the configures RSVP LSP services.

Mandatory Parameters

Output

Sample XML Output

Get an RSVP LSP Service By Service ID

This request is used to retrieve a particular RSVP LSP service.

New Parameters

"RSVPLSPConfigParameterServiceType

SetupPriority (Integer)

HoldPriority (Integer)

ClassOfService (Integer)"

Description of the Changes

The new parameters are returned in the response XML under the parent tag ServiceParameters. These are the values configured at root level for LSP that are inherited at primary and secondary path. If required, they can be overridden in the primary and secondary paths.

URI

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

management/services/{Service-Id}

HTTP Method

GET

Consumes

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

Produces

Obtains a particular RSVP LSP service.

Output

Sample XML Output

Modify an RSVP LSP Service

This request is used to modify an RSVP LSP service.

New Parameters

"RSVPLSPConfigParameterServiceType

SetupPriority (Integer)

HoldPriority (Integer)

ClassOfService (Integer)"

Description of the Changes

The new parameters are returned in the response XML under the parent tag ServiceParameters. These are the values configured at root level for LSP that are inherited at primary and secondary path. If required, they can be overridden in the primary and secondary paths.

URI

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

services/{Service-Id}

HTTP Method

POST

Consumes

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

Content Type

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

management.modify-service+xml

Produces

Modifies an RSVP LSP service.

Mandatory Parameters

"<?xml version=""1.0"" encoding=""UTF-8""?>
<Data xmlns=""services.schema.networkapi.jmp.juniper.net"">
  <ServiceResource>
    <ServiceOrder>
      <Common>
        <Name>p2p_cspf_pathprot_Modify_2015-11-27_11-39-35</Name>
      </Common>
      <ServiceEndPointGroup>
        <DeviceInfo>
          <TA>
            <Source>
              <DeviceName>MAC15re</DeviceName>
              <DeviceID>65548</DeviceID>
            </Source>
            <Destination>
              <DeviceName>MAC13re</DeviceName>
              <DeviceID>65541</DeviceID>
            </Destination>
          </TA>
        </DeviceInfo>
        <ServiceEndPoint>
          <ServiceEndpointConfiguration xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""RSVPLSPBFDEndPointParameterOrderType"">
            <PrimaryPath>
              <PathName>Path1</PathName>
              <SetupPriority>7</SetupPriority>
              <Adaptive>Disabled</Adaptive>
              <HoldPriority>0</HoldPriority>
              <ClassOfService>0</ClassOfService>
              <HopLimit>255</HopLimit>
              <Bandwidth>-1</Bandwidth>
              <Paths>
                <Path>
                  <PathName>Path1</PathName>
                  <Connection>Loose</Connection>
                </Path>
              </Paths>
            </PrimaryPath>
            <SecondaryPath>
              <PathName>Path2</PathName>
              <SetupPriority>7</SetupPriority>
              <Adaptive>Disabled</Adaptive>
              <HoldPriority>0</HoldPriority>
              <ClassOfService>0</ClassOfService>
              <HopLimit>255</HopLimit>
              <Bandwidth>-1</Bandwidth>
              <StandBy>false</StandBy>
              <Paths>
                <Path>
                  <PathName>Path2</PathName>
                  <Connection>Loose</Connection>
                </Path>
              </Paths>
            </SecondaryPath>
          </ServiceEndpointConfiguration>
        </ServiceEndPoint>
      </ServiceEndPointGroup>
      <ServiceOrderParameter xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""RSVPLSPBFDConfigParameterOrderType"">
        <ClassOfService>1</ClassOfService>
        <HopLimit>255</HopLimit>
        <HoldPriority>1</HoldPriority>
        <SetupPriority>5</SetupPriority>
        <StandBy>false</StandBy>
        <Adaptive>Disabled</Adaptive>
        <RetryLimit>0</RetryLimit>
        <RetryTimer>30</RetryTimer>
        <BandWidth>-1</BandWidth>
        <LDPTunneling>Disabled</LDPTunneling>
        <ProtectionSetting>
          <EnableFR>Disabled</EnableFR>
        </ProtectionSetting>
        <BFD>
          <BFDdetection>None</BFDdetection>
        </BFD>
      </ServiceOrderParameter>
    </ServiceOrder>
  </ServiceResource>
  <CustomAction xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""ServiceCustomActionType"">
    <Action>SaveAndValidate</Action>
  </CustomAction>
</Data>
"

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line Service Order with Ethernet Interfaces

This request is used to create an E-Line service order with Ethernet interfaces.

New Parameters

"PTPElineLDPEndPointConfigParameterOrderType

EnableSendOam (String)

OutgoingLabelRes (Integer)

IncomingLabelRes (String)"

Description of the Changes

For P2PLDP-Ethernet ServiceOrder, the SendOEM option is provided. Also, if the static pseudowire option is enabled, , you must provide OutgoingLabel for BackupEndpoint in P2P Resillency.

URI

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

HTTP Method

POST

Consumes

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

management.service-order-status+xml;version=2

Content Type

application/vnd.net.juniper.space.servicemanagement.

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

Produces

Creates an E-Line service order with Ethernet interfaces

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line Service Order with TDM Interfaces

This request is used to create an E-Line service order with TDM interfaces.

New Parameters

"PTPTDMEndPointConfigParameterOrderType

EnableSendOam (String)

OutgoingLabelRes (Integer)

IncomingLabelRes (String)"

Description of the Changes

For P2PLDP-TDM ServiceOrder, the SendOEM option is provided. Also, if the static pseudowire option is enabled, , you must provide OutgoingLabel for BackupEndpoint in P2P Resillency.

URI

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

HTTP Method

POST

Consumes

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

management.service-order-status+xml;version=2

Content Type

application/vnd.net.juniper.space.servicemanagement.

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

Produces

Creates an E-Line service order with TDM interfaces

Input

Sample XML Input

Output

Sample XML Output

Create an E-Line Service Order with ATM Interfaces

This request is used to create an E-Line service order with ATM interfaces.

New Parameters

"PTPATMEndPointConfigParameterOrderType

EnableSendOam (String)

OutgoingLabelRes (Integer)

IncomingLabelRes (String)"

Description of the Changes

For P2PLDP-ATM ServiceOrder, the SendOEM option is provided. Also, if the static pseudowire option is enabled, , you must provide OutgoingLabel for BackupEndpoint in P2P Resillency.

URI

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

HTTP Method

POST

Consumes

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

management.service-order-status+xml;version=2

Content Type

application/vnd.net.juniper.space.servicemanagement.

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

Produces

Creates an E-Line service order with ATM interfaces

Input

Sample XML Input

Output

Sample XML Output

Get an E-Line Service Order with Ethernet Interfaces

This request is used to retrieve E-line service orders configured with Ethernet interfaces.

New Parameters

"PTPElineLDPEndPointConfigParameterServiceType

EnableSendOam (String)"

Description of the Changes

For Get P2P-ElineLDP service orders, you can retrieve the value of EnableSendOam tag.

URI

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

HTTP Method

GET

Consumes

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

management.service-orders+xml

Produces

Retrieves E-Line service orders with Ethernet interfaces.

Output

Sample XML Output

Get an E-Line Service Order with TDM Interfaces

This request is used to retrieve E-Line service orders configured with TDM interfaces.

New Parameters

"PTPTDMEndPointConfigParameterServiceType

EnableSendOam (String)"

Description of the Changes

For Get P2P-TDM service orders, you can retrieve the value of EnableSendOam tag.

URI

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

HTTP Method

GET

Consumes

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

management.service-orders+xml

Produces

Retrieves E-Line service orders with TDM interfaces.

Output

Sample XML Output

Get an E-Line Service Order with ATM Interfaces

This request is used to retrieve E-Line service orders configured with ATM interfaces.

New Parameters

"PTPATMEndPointConfigParameterServiceType

EnableSendOam (String)"

Description of the Changes

For Get P2P-ATM service orders, you can retrieve the value of EnableSendOam tag.

URI

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

HTTP Method

GET

Consumes

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

management.service-orders+xml

Produces

Retrieves E-Line service orders with ATM interfaces.

Output

Sample XML Output

Create an E-LAN BGP Service Definition

This request is used to create an E-LAN BGP service definition.

New Parameters

"VPLSHSEndPointParameterOrderType

AutoPickVCID (Boolean)"

Description of the Changes

If PWExtension is Enabled, for VCId, Edit in Service Order option is provided.

URI

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

service-definitions

HTTP Method

POST

Consumes

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

management.service-definition-status+xml

Content Type

application/vnd.net.juniper.space.

service-management.service-definition+xml

Produces

Creates an E-LAN BGP service definition.

Input

Sample XML Input

Output

Sample XML Output

Create an E-LAN BGP Service Order

This request is used to create an E-LAN BGP service order.

New Parameters

"VPLSHSEndPointParameterOrderType

AutoPickVCID (Boolean)"

Description of the Changes

For VCID, if ‘Edit in SO’ is enabled in the service definition, user can edit VCID in the service order with the help of <AutoPickVCID> tag based on requirement.

URI

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

HTTP Method

POST

Consumes

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

management.service-order-status+xml;version=2

Content Type

application/vnd.net.juniper.space.servicemanagement.

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

Produces

Creates an E-LAN BGP service order.

Input

Sample XML Input

Output

Sample XML Output

Get E-Line Service Template Details of a Service Definition

This request is used to retrieve the template details associated with a passed service definition.

New Parameters

"ServiceTemplateType DynamicAttributesPresent (Boolean)

ConfigParamType DynamicAttribute (Boolean)"

Description of the Changes

Under ServiceTemplate, <Default>false</Default> indicates if this template is marked as default for this service definition.

<DynamicAttributesPresent>true</DynamicAttributesPresent> denotes if this templates has at least one config param that has dynamic attributes

The presence of the User <ConfigParams> <DynamicAttribute>true</DynamicAttribute> tag, with a value of true, indicates this parameter is a dynamic attribute, and value may be fetched from associated device at runtime.

URI

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

definitions/2162688/serviceTemplates?_dc=1448974490650&

page=1&start=0&limit=25

HTTP Method

GET

Consumes

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

management.service-template+xml;version=2;

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

template+json;version=2

Produces

Retrieves the template details associated with a service definition.

Output

Sample XML Output

Get a Service Definition With a Default Service Template

This request is used to retrieve all the service definitions that contain a service template as the default template.

New Parameters

"ServiceTemplateType

Default (Boolean)"

Description of the Changes

The <Default> tag under <ServiceTemplate> indicates if this template is marked as a default template in the service definition.

URI

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

definitions/2162688?_dc=1448973954913&id=2162688

HTTP Method

GET

Consumes

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

management.service-definition+xml;version=2;

Content Type

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

management.service-definition+xml;version=2;

charset=UTF-8;

Produces

Retrieves service definitions that are attached with service templates labeled as the default template.

Output

Sample XML Output

Create Service Order with a Service Definition Attached with Default Templates

This request is used to create a service order that contains a service definition attached with default service templates.

New Parameters

"ServiceEndPointGroupType

DonotApplyDefaultTemplatesOfSD"

Description of the Changes

During the service order creation, as a rule, all default templates of service definition are applied to all end points of a service order. If you want to skip all default templates for specific service endpoints, per ServiceEndPointGroupType, use the tag DonotApplyDefaultTemplatesOfSD with a value of true <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>

In the following example, for the endpoint 1, the default templates are skipped, because of <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>

URI

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

HTTP Method

POST

Consumes

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

management.service-order-status+xml;version=2

Content Type

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

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

Produces

Creates a service order with a service definition that contains default service templates.

Input

Sample XML Input

Get All Services

This request is used to retrieve all the services.

New Parameters

"ServiceType

OverallStatus (String)"

Description of the Changes

The new parameter is returned in the response XML under parent tag basic-service.

URI

api/space/nsas/basic-services/?_dc=1448982057002

&srvNodeType=serviceType&srvNodeValue

=&orderby=[{”property”:”activationDate”,”direction”:”DESC”}]

&page=1&start=0&limit=25

HTTP Method

GET

Consumes

application/vnd.juniper.api.space.nsas.basic-

services+xml;version=2;q=0.02;

Content Type

application/vnd.juniper.api.space.nsas.basic-

services+xml;charset=UTF-8"

Produces

Retrieves all the services.

Output

Sample XML Output

Get All Service Orders

This request is used to retrieve all the service orders.

New Parameters

"CommonType

ScheduledState (String)"

<ScheduledState>Deployment Scheduled</ScheduledState>

<ScheduledState>Validation Scheduled</ScheduledState>

<ScheduledState>DeActivate Scheduled</ScheduledState>

<ScheduledState>ReActivate Scheduled</ScheduledState>

<ScheduledState>Decommissioned Scheduled</ScheduledState>

<ScheduledState>Force Deployment Scheduled</ScheduledState>

Description of the Changes

The new parameter is returned in the response XML under parent tag ServiceResource -> ServiceOrder -> Common.

URI

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

service-orders/ordersforservice?_dc=1448983779127

&serviceId=4685837&page=1&start=0&limit=25

HTTP Method

GET

Consumes

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

management.service-orders+xml

Content Type

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

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

Produces

Retrieves all of the service orders.

Output

Sample XML Output

Get Service Order by ID (For All Services Types)

This request is used to retrieve a particular service order by the order ID.

New Parameters

"ServiceOrderType

JobIdsList"

Description of the Changes

This parameter is added to check job history of the service order.

URI

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

service-orders/{orderID}

HTTP Method

GET

Consumes

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;"

Produces

Retrieve a particular service order by the order ID.

Output

Sample XML Output

Get CFM Profiles with Attached SLA Profile and Action Profile

This request is used to retrieve all the CFM profile details together with SLA profiles and action profiles.

New Parameters

"ActionProfile

Name

SLAProfileDetails

SLAProfile

Name

DataTlvSize

IterationCount

Priority"

Description of the Changes

If the CFM profile has Action Profile/SLA profile associated, the tags ActionProfile, and SLAProfileDetails under RemoteMEPSettings/IteratorProfileSettings show the assoociated pofile details

URI

/api/space/nsas/cfm-profiles/service-management/service-

definitions/163861?_dc=1449054951793

HTTP Method

GET

Consumes

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

Produces

Retrieves all the CFM profile details together with SLA profiles and action profiles.

Output

Sample XML Output

Get TA Device Details by Device Name

This request is used to retrieve all the details of a particular TA device.

New Parameters

"DeviceType

Version (String)

Platform (String)

Connection (String)"

Description of the Changes

URI

/api/space/nsas/prestage-ta-device/manage-devices/devices/by-

device-name/{peDeviceName}

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.manage-devices.ta-

device-by-name+xml

Produces

Retrieves a specific TA device configuration.

Output

Sample XML Output

Get an NNI Interface Details by Device Name

This request is used to retrieve the details of a particular network-to-network (NNI) or egress interface.

New Parameters

"PortsType size

(Integer)"

Description of the Changes

This API is used to get all NNI details by device name.

URI

/api/space/nsas/prestage-ta-device/manage-devices/devices/nni/{peDeviceName}

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.manage-devices.ta-device-nni+xml

Produces

Retrieves all NNI details by device name.

Output

Sample XML Output

New REST APIs in Connectivity Services Director

This section describes the REST APIs that are newly introduced in Connectivity Services Director.

Create an LSP Service Order

This request is used to create an LSP service order.

New Parameters

"RSVPLSPConfigOrderParameterType

SetupPriority (Integer)

HoldPriority (Integer)

ClassOfService (Integer) "

Description of the Changes

The three new parameters are sent in request payload to configure them at root LSP level. In Services Activation Director, you could configure these parameters at Primary and Secondary LSP paths only. In the old version of API, these parameters are not used and therefore, they are not sent in the request payload). A value of -1 indicates that parameter must be deleted from the service order

URI

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

service-orders)

HTTP Method

POST

Consumes

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

management.service-order-status+xml;version=2

Content Type

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

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

Produces

Creates an LSP service order.

Mandatory Parameters

"<?xml version=""1.0"" encoding=""UTF-8""?>
<Data xmlns=""services.schema.networkapi.jmp.juniper.net"">
  <ServiceResource>
    <ServiceDefinition>
      <Common>
        <Name>p2p32</Name>
      </Common>
      <ServiceType>RSVP</ServiceType>
      <ServiceElementConfigurationDefinition xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""PTPServiceEndpointGroupParameterDefType""/>
      <ServiceEndPointConfigurationDefinition xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""PTPEndPointParameterDefType""/>
      <TransportActivate xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""RSVPLSPType"">
        <Topology>P2P</Topology>
        <PathSelectionType>CSPF</PathSelectionType>
        <LSPProtectionType Editable=""true"">Path Protection</LSPProtectionType>
        <Advanced>
          <HopLimit Editable=""true"">255</HopLimit>
          <ClassofService Editable=""true"">0</ClassofService>
          <Bandwidth Editable=""true"">222</Bandwidth>
          <HoldPriority Editable=""true"">0</HoldPriority>
          <SetupPriority Editable=""true"">7</SetupPriority>
          <RetryLimit Editable=""true"">2</RetryLimit>
          <RetryTimer Editable=""true"">22</RetryTimer>
          <FastReroute Editable=""true"">true</FastReroute>
          <LDPTunneling Editable=""true"">true</LDPTunneling>
          <Standby Editable=""true"">false</Standby>
          <Adaptive Editable=""true"">false</Adaptive>
        </Advanced>
        <Autobandwidth>
          <AutoBWidth Editable=""true"">false</AutoBWidth>
        </Autobandwidth>
        <BFD>
          <BFDdetection>Primary Path</BFDdetection>
          <MinimumInterval Editable=""true"">300</MinimumInterval>
          <MiniRecieveInterval Editable=""true"">50</MiniRecieveInterval>
          <Multiplier Editable=""true"">3</Multiplier>
          <TransmitMinInterval Editable=""true"">50</TransmitMinInterval>
          <TransmitThreshold Editable=""true""/>
          <DetectionThreshold Editable=""true""/>
          <NoAdaption Editable=""true"">false</NoAdaption>
          <FailureAction Editable=""true"">Teardown</FailureAction>
        </BFD>
      </TransportActivate>
    </ServiceDefinition>
    <ServiceOrder>
      <Common>
        <Name>p2p32</Name>
      </Common>
      <LSPPattern key=""196902""/>
      <ServiceEndPointGroup>
        <DeviceInfo>
          <TA>
            <Source>
              <DeviceName>960R1_EN_Alok_re</DeviceName>
              <DeviceID>65565</DeviceID>
            </Source>
            <Destination>
              <DeviceName>960R2_EN_Alok_re</DeviceName>
              <DeviceID>65540</DeviceID>
            </Destination>
          </TA>
        </DeviceInfo>
        <ServiceEndPoint>
          <ServiceEndpointConfiguration xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""RSVPLSPBFDEndPointParameterOrderType"">
            <PrimaryPath>
              <PathName>My1</PathName>
              <SetupPriority>7</SetupPriority>
              <Adaptive>Disabled</Adaptive>
              <HoldPriority>0</HoldPriority>
              <ClassOfService>0</ClassOfService>
              <HopLimit>255</HopLimit>
              <Bandwidth>222</Bandwidth>
              <Paths>
                <Path>
                  <PathName>My1</PathName>
                  <IPAddress>40.1.3.2</IPAddress>
                  <Connection>Strict</Connection>
                </Path>
                <Path>
                  <PathName>My1</PathName>
                  <IPAddress>40.3.4.1</IPAddress>
                  <Connection>Strict</Connection>
                </Path>
              </Paths>
            </PrimaryPath>
            <SecondaryPath>
              <PathName>My2</PathName>
              <SetupPriority>7</SetupPriority>
              <Adaptive>Disabled</Adaptive>
              <HoldPriority>0</HoldPriority>
              <ClassOfService>0</ClassOfService>
              <HopLimit>255</HopLimit>
              <Bandwidth>222</Bandwidth>
              <StandBy>undefined</StandBy>
              <Paths>
                <Path>
                  <PathName>My2</PathName>
                  <IPAddress>40.1.2.2</IPAddress>
                  <Connection>Loose</Connection>
                </Path>
                <Path>
                  <PathName>My2</PathName>
                  <IPAddress>40.2.4.2</IPAddress>
                  <Connection>Loose</Connection>
                </Path>
              </Paths>
            </SecondaryPath>
          </ServiceEndpointConfiguration>
        </ServiceEndPoint>
      </ServiceEndPointGroup>
      <ServiceOrderParameter xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""RSVPLSPBFDConfigParameterOrderType"">
        <ClassOfService>0</ClassOfService>
        <HopLimit>255</HopLimit>
        <HoldPriority>0</HoldPriority>
        <SetupPriority>7</SetupPriority>
        <StandBy>false</StandBy>
        <Adaptive>Disabled</Adaptive>
        <RetryLimit>2</RetryLimit>
        <RetryTimer>22</RetryTimer>
        <BandWidth>222</BandWidth>
        <LDPTunneling>Enabled</LDPTunneling>
        <ProtectionSetting>
          <LSPProtectionType>Path Protection</LSPProtectionType>
          <EnableFR>Enabled</EnableFR>
        </ProtectionSetting>
        <BFD>
          <BFDdetection>Primary Path</BFDdetection>
          <MinInterval>300</MinInterval>
          <MinReceiveInterval>50</MinReceiveInterval>
          <Multiplier>3</Multiplier>
          <NoAdaption>false</NoAdaption>
          <TransmitMinInterval>50</TransmitMinInterval>
          <FailureAction>Teardown</FailureAction>
        </BFD>
      </ServiceOrderParameter>
    </ServiceOrder>
  </ServiceResource>
  <CustomAction xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xsi:type=""ServiceOrderCustomActionType"">
    <Action>SaveAndValidate</Action>
  </CustomAction>
</Data>
"

Input

Sample XML Input

Output

Sample XML Output

Get All Resource Pools Available in Junos Space

This request is used to retrieve the configured resource pool details.

New Parameters

"DataType

ResourcePools (ResourcePoolsType)"

Description of the Changes

This request retrieves all the resource pools available in Junos Space.

URI

api/space/nsas/resource-utilization/resource-pools

HTTP Method

GET

Consumes

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

utilization.resource-pools+xml

Produces

Collects all the resource pool details available in Junos Space.

Output

Sample XML Output

Get Allocated Resources for a Pool By Pool ID

This request is used to retrieve all the allocated resources for a particular pool.

New Parameters

"DataType

ResourcePools (ResourcePoolsType)"

Description of the Changes

This request fetches allocated resources for the pool requested. For UNIT and VLAN, if the resources are allocated from this Space, the Service details to which the resource is allocated is also displayed.

URI

api/space/nsas/resource-utilization/resource-pools

/pool-id

HTTP Method

GET

Consumes

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

utilization.resource-pools+xml

Produces

Collects all the allocated resources for a particular pool.

Output

Sample XML Output

Get Job Details By Job ID

This request is used to obtain the details of a specific job, based on its unique identifier.

New Parameters

"getJobDetailsForRequest”

Description of the Changes

This API is to display the job details as a device view. Previously, the job summary was shown when you double-clicked the link in a job ID. With this new REST API call, job details are filtered on the basis of each device.

HTTP Method

GET

GET

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

management/service-orders/jobId

Consumes

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

management.service-orders+json;version=2

Produces

Retrieves the details of a particular job.

Mandatory Parameters

jobID

Output

Sample JSONOutput

Get All Basic Services

This request is used to retrieve details of all the configured basic services..

New Parameters

api/space/nsas/basic-services

Description of the Changes

This API call is used to retrieve all the services.

URI

api/space/nsas/basic-services

HTTP Method

GET

Consumes

application/vnd.juniper.api.space.nsas.basic-

services+xml;version=2

Content Type

application/vnd.juniper.api.space.nsas.basic-

services+json;version=2

Produces

Retrieves all the basic services.

Output

Sample XML Output

Perform an MPLS Ping for E-Line, IP, and E-LAN Services

This request is used to perform an MPLS ping operation for E-Line, IP, and E-LAN services.

New Parameters

/api/space/nsas/perform-mpls-ping

Description of the Changes

This API is used to perform an MPLS ping process.

URI

/api/space/nsas/perform-mpls-ping

HTTP Method

POST

Consumes

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+xml;version=2

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+json;version=2"

Content Type

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+xml;version=2;charset=UTF-8

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+json;version=2;charset=UTF-8

Produces

Performs an MPLS ping operation for E-Line, IP, and E-LAN services.

Input

Sample XML Input

Output

Sample XML Output

Perform an MPLS Ping for LSPs

This request is used to perform an MPLS ping operation for LSPs.

New Parameters

/api/space/nsas/tunnels/perform-mpls-ping

Description of the Changes

This API is used to perform an MPLS ping process.

URI

/api/space/nsas/tunnels/perform-mpls-ping

HTTP Method

POST

Consumes

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+xml;version=2

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

response+json;version=2"

Content Type

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+xml;version=2;charset=UTF-8

application/vnd.juniper.api.space.nsas.perform-mpls-ping-

request+json;version=2;charset=UTF-8

Produces

Performs an MPLS ping operation for LSPs.

Input

Sample XML Input

Output

Sample XML Output

Get All Prestaged Devices

This request is used to retrieve a list of prestaged devices.

New Parameters

api/space/nsas/pre-stage-devices

Description of the Changes

This API is used to retrieve a list of prestaged devices.

URI

api/space/nsas/pre-stage-devices

HTTP Method

GET

Consumes

application/vnd.juniper.api.space.nsas.pre-stage-

devices+xml;version=2

application/vnd.juniper.api.space.nsas.pre-stage-

devices+json;version=2

Produces

Retrieves a list of prestaged devices.

Output

Sample XML Output

Unassign Roles of Devices

This request is used to unassign the role of devices passed as a parameter. Multiple device IDs are concatenated with a | (pipe) character.

New Parameters

api/space/nsas//pe-unassign-role?data=<deviceids>

Description of the Changes

This API is used to unassign the role of a specific device.

URI

api/space/nsas//pe-unassign-role?data=<deviceids>

HTTP Method

POST

Consumes

application/vnd.juniper.api.space.nsas.pe-unassign-

roles+xml;version=2

application/vnd.juniper.api.space.nsas.pe-unassign-

roles+json;version=2"

Produces

Unassigns the roles of devices.

Output

Sample XML Output

Clear Interface Statistics

This request is used to clear the statistical information collected for the interfaces.

New Parameters

api/space/nsas/clear-interface-statistics

Description of the Changes

This API clears interface statistics of an interface.

URI

api/space/nsas/clear-interface-statistics

HTTP Method

POST

Consumes

application/vnd.juniper.api.space.nsas.clear-interface-

statistics-response+xml;version=2

application/vnd.juniper.api.space.nsas.clear-interface-statistics-

response+json;version=2

Content Type

application/vnd.juniper.api.space.nsas.clear-interface-

statistics-request+xml;version=2;charset=UTF-8

application/vnd.juniper.api.space.nsas.clear-interface-

statistics-request+json;version=2;charset=UTF-8

Produces

Clears the statistics of interfaces.

Input

Sample XML Input

Output

Sample XML Output

Delete a Service in Deployment Pending Status by Service ID

This request is used to delete a particular service in deployment-pending status.

New Parameters

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

management/services/deploymentpending/{service-id}

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

management/service-orders/{service-id}

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

management/service-orders/{service-id}

For LSP: /api/space/nsas/rsvp-lsp/service-

management/service-orders/{service-id}

Description of the Changes

This API is used to delete a particular service in deployment-pending status

URI

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

management/services/deploymentpending/{service-id}

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

management/service-orders/{service-id}

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

management/service-orders/{service-id}

For LSP: /api/space/nsas/rsvp-lsp/service-

management/service-orders/{service-id}

HTTP Method

DELETE

Consumes

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

services+xml

Produces

Deletes a particular service in deployment-pending status.

Output

Sample XML Output