Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Services Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Services Management RESTful Web Services.

    Create a Service Order

    This request is used to create a service order.

    URI

    api/space/nsas/csd/service-order

    HTTP Method

    POST

    Consumes

    application/xml

    Produces

    Create a service order

    Validation URL

    api/space/nsas/csd/service-order?validation=true

    Request Body

    <Data
        xmlns="services.schema.networkapi.jmp.juniper.net">
        <ServiceResource>
            <ServiceOrder>
                <Common>
                    <Name>vpls-fm1</Name>
                    <CustomerName>airtel</CustomerName>
                    <CreatedBy>super</CreatedBy>
                </Common>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>960R1_EL_vasut_re</DeviceName>
                            <DeviceID>1245267</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/9</InterfaceName>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>10</Bandwidth>
                        </ServiceEndpointConfiguration>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>960R2_EL_vasut_re</DeviceName>
                            <DeviceID>1245241</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/5</InterfaceName>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>10</Bandwidth>
                        </ServiceEndpointConfiguration>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>480R3_EL_vasut_re</DeviceName>
                            <DeviceID>1245187</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/7</InterfaceName>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>10</Bandwidth>
                        </ServiceEndpointConfiguration>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceOrderParameter
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSConfigParameterOrderType">
                    <RouteDistinguisher AutoPick = "true"></RouteDistinguisher>
                    <RouteTarget AutoPick ="true"></RouteTarget>
                    <MTUFactor>10</MTUFactor>
                </ServiceOrderParameter>
                <Reference>
                    <Customer key="884793"/>
                    <ServiceDefinition>
                        <ServiceDefinitionID key="1540111"/>
                    </ServiceDefinition>
                    <Service key="undefined"/>
                </Reference>
            </ServiceOrder>
        </ServiceResource>
        <CustomAction
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceOrderCustomActionType">
            <Action>SaveAndValidate</Action>
        </CustomAction>
    </Data>
    

    Response Body

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data
        xmlns="services.schema.networkapi.jmp.juniper.net">
        <Status>
            <Identity>
                <Type>ServiceOrder</Type>
                <Value>1540216</Value>
            </Identity>
            <Job>
                <ID>426053</ID>
                <Status>INPROGRESS</Status>
            </Job>
            <Code>200</Code>
            <Message>The Service Order Created Successfully and Validation is in Progress. Please check the status using the JOB ID.</Message>
        </Status>
    </Data>
    

    Modify a Service Order

    This request is used to modify a service order.

    URI

    api/space/nsas/csd/service-order/Service Request ID

    HTTP Method

    POST

    Consumes

    application/xml

    Produces

    Modify a service order

    Validation URL

    api/space/nsas/csd/service-order/Service Request ID?validation=true

    Request Body

    <Data
        xmlns="services.schema.networkapi.jmp.juniper.net">
        <ServiceResource>
            <ServiceOrder>
                <Common>
                    <Name>vpls-fm1</Name>
                    <CustomerName>airtel</CustomerName>
                    <CreatedBy>super</CreatedBy>
                </Common>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>480R4_EL_vasut_re</DeviceName>
                            <DeviceID>1245214</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/5</InterfaceName>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>10</Bandwidth>
                        </ServiceEndpointConfiguration>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>960R2_EL_vasut_re</DeviceName>
                            <DeviceID>1245241</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/5</InterfaceName>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>10</Bandwidth>
                            <UNIDescription>N/A</UNIDescription>
                            <OuterTPID>None</OuterTPID>
                        </ServiceEndpointConfiguration>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>480R3_EL_vasut_re</DeviceName>
                            <DeviceID>1245187</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/7</InterfaceName>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>10</Bandwidth>
                            <UNIDescription>N/A</UNIDescription>
                            <OuterTPID>None</OuterTPID>
                        </ServiceEndpointConfiguration>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceOrderParameter
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSConfigParameterOrderType">
                    <RouteDistinguisher>36000:2</RouteDistinguisher>
                    <RouteDistinguisher>36000:2</RouteDistinguisher>
                    <RouteTarget AutoPick ="true"></RouteTarget>
                    <RouteTarget>36000:2</RouteTarget>
                </ServiceOrderParameter>
                <Reference>
                    <Customer key="884793"/>
                    <ServiceDefinition>
                        <ServiceDefinitionID key="1540111"/>
                    </ServiceDefinition>
                    <Service key="1540232"/>
                </Reference>
            </ServiceOrder>
        </ServiceResource>
        <CustomAction
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceOrderCustomActionType">
            <Action>SaveAndDeployNow</Action>
        </CustomAction>
    </Data>
    

    Response Body

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data
        xmlns="services.schema.networkapi.jmp.juniper.net">
        <Status>
            <Identity>
                <Type>ServiceOrder</Type>
                <Value>1540251</Value>
            </Identity>
            <Job>
                <ID>426057</ID>
                <Status>INPROGRESS</Status>
            </Job>
            <Code>200</Code>
            <Message>Service Order Created Successfully and Deployment is in Progress. Please check the status using the JOB ID.</Message>
        </Status>
    </Data>
    

    Modify a Service

    This request is used to modify a service.

    URI

    api/space/nsas/csd/service/Service ID

    HTTP Method

    PUT

    Consumes

    application/xml

    Produces

    Modify a service

    Validation URL

    api/space/nsas/csd/service/Service ID?validation=true

    Request Body

    <Data
        xmlns="services.schema.networkapi.jmp.juniper.net">
        <ServiceResource>
            <ServiceOrder>
                <Common>
                    <Name>vpls-fm1_modify_Aug-04-2017_11-32</Name>
                    <CreatedBy>super</CreatedBy>
                </Common>
                <DeletedDeviceInfo>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>480R3_EL_vasut_re</DeviceName>
                            <DeviceID>1245187</DeviceID>
                        </NA>
                    </DeviceInfo>
                </DeletedDeviceInfo>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>480R3_EL_vasut_re</DeviceName>
                            <DeviceID>1245187</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/7</InterfaceName>
                        <ServiceEndpointID>1540294</ServiceEndpointID>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>10</Bandwidth>
                            <UNIDescription>N/A</UNIDescription>
                            <OuterTPID>None</OuterTPID>
                        </ServiceEndpointConfiguration>
                        <OppType>DELETE</OppType>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceEndPointGroup>
                    <DonotApplyDefaultTemplatesOfSD>true</DonotApplyDefaultTemplatesOfSD>
                    <DeviceInfo>
                        <NA>
                            <DeviceName>480R4_EL_vasut_re</DeviceName>
                            <DeviceID>1245214</DeviceID>
                        </NA>
                    </DeviceInfo>
                    <ServiceEndPoint>
                        <InterfaceName>ge-0/0/5</InterfaceName>
                        <ServiceEndpointID>1540282</ServiceEndpointID>
                        <ServiceEndpointConfiguration
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSBGPEndPointConfigParameterOrderType">
                            <Hub>false</Hub>
                            <UnitId>24</UnitId>
                            <VlanId>24</VlanId>
                            <Bandwidth>12</Bandwidth>
                            <UNIDescription>N/A</UNIDescription>
                        </ServiceEndpointConfiguration>
                        <OppType>MODIFY-ENDPOINT</OppType>
                    </ServiceEndPoint>
                </ServiceEndPointGroup>
                <ServiceOrderParameter
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="VPLSConfigParameterOrderType">
                    <RouteDistinguisher AutoPick = "true"></RouteDistinguisher>
                    <RouteTarget AutoPick ="true"></RouteTarget>
                    <RouteTarget>36000:2</RouteTarget>
                    <MTUFactor>10</MTUFactor>
                </ServiceOrderParameter>
                <Reference>
                    <Customer key="884793"/>
                    <ServiceDefinition>
                        <ServiceDefinitionID key="1540111"/>
                    </ServiceDefinition>
                    <Service key="1540232"/>
                </Reference>
            </ServiceOrder>
        </ServiceResource>
        <CustomAction
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceCustomActionType">
            <Action>SaveAndDeployNow</Action>
        </CustomAction>
    </Data>
    

    Response Body

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data
        xmlns="services.schema.networkapi.jmp.juniper.net">
        <Status>
            <Identity>
                <Type>ServiceOrder</Type>
                <Value>1540303</Value>
            </Identity>
            <Identity>
                <Type>Service</Type>
                <Value>1540232</Value>
            </Identity>
            <Job>
                <ID>426071</ID>
                <Status>INPROGRESS</Status>
            </Job>
            <Code>200</Code>
            <Message>The Service Order Modified Successfully and Deployment is in Progress. Please check the status using the JOB ID.</Message>
        </Status>
    </Data>
    

    Force Upload a Service Definition

    This request is used to overwrite service definitions that were recovered using the service recovery feature and do not contain the changes made through CLI configuration or through templates.

    URI

    /api/space/nsas/service-management/service-recovery/service-templates

    HTTP Method

    POST

    Consumes

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

    Content Type

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

    Produces

    Modify a service

    Example

    http://IP address/api/space/nsas/service-management/
    service-recovery/service-templates

    Validation URL

    /api/space/nsas/service-management/service-recovery/service-templates?validation=true

    Request Body

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
        <ServiceTemplateRecoveryProfile>
            <ServiceRecoveryProfileTypes>
                <ServiceId>9535539</ServiceId>
                <ServiceRecoveryDevices>
                    <DeviceId>6389817</DeviceId>
                    <Endpoints>
                        <Endpoint>ge-0/0/9.51</Endpoint>
                    </Endpoints>
                    <Endpoints>
                        <Endpoint>ge-0/1/0.55</Endpoint>
                    </Endpoints>
                </ServiceRecoveryDevices>
            </ServiceRecoveryProfileTypes>
        </ServiceTemplateRecoveryProfile>
    </Data>

    Response Body

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
        <Status>
            <Identity>
                <Type>ServiceTemplateRecoveryRequest</Type>
                <Value>3276827</Value>
            </Identity>
            <Job>
                <ID>3276827</ID>
                <Status>INPROGRESS</Status>
            </Job>
            <Code>200</Code>
            <Message>The Service Request Created Successfully. Please check the status using the JOB ID.</Message>
        </Status>
    </Data>

    Modified: 2017-08-10