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

    SyncE Service Orders Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Synchronous Ethernet (SyncE) Service Orders Management RESTful Web Services.

    Get a SyncE Service Order By Service Order ID

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

    URI

    /api/space/nsas/sync-e/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 SyncE service order.

    Output

    Sample XML Output

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder
    			href="/api/space/nsas/sync-e/service-management/service-orders/163841"
    			uri="/api/space/nsas/sync-e/service-management/service-orders/163841"
    			key="163841">
    			<Common>
    				<Name>TestSyncEOS</Name>
    				<Identity>163841</Identity>
    				<State>Completed</State>
    				<Comments>TestSyncEOS</Comments>
    				<CreatedDate>2013-05-15T18:24:43.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-05-15T18:24:59.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>SyncE</ServiceType>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						key="861">
    						<DeviceName>junos-space2</DeviceName>
    						<DeviceID>861</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>ge-0/1/7</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel> PRP </QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>ge-0/1/2</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel> PRP </QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>ge-0/1/0</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel> PRP </QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>xe-0/3/1</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel> PRP </QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceOrderParameter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="SyncEConfigParameterOrderType">
    				<GeneralSettings>
    					<NetworkOption>Option-1</NetworkOption>
    					<ClockMode>Auto</ClockMode>
    					<EnableQualityMode>false</EnableQualityMode>
    					<SourceSelectionMode>Configured Quality</SourceSelectionMode>
    					<HoldIntervalSettings>
    						<ChangeConfig>15</ChangeConfig>
    						<Restart>120</Restart>
    						<Switchover>30</Switchover>
    						<SwitchoverMode>Revertive</SwitchoverMode>
    					</HoldIntervalSettings>
    				</GeneralSettings>
    			</ServiceOrderParameter>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="32782"
    						href="/api/space/nsas/sync-e/service-management/service-definitions/32782"
    						uri="/api/space/nsas/sync-e/service-management/service-definitions/32782">
    						<ServiceDefinitionName>TestSynce</ServiceDefinitionName>
    					</ServiceDefinitionID>
    				</ServiceDefinition>
    			</Reference>
    			<TimingDeviceESMCGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						key="861">
    						<DeviceName>junos-space2</DeviceName>
    						<DeviceID>861</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ESMCInterfaces>
    					<ESMCInterface>ge-0/1/0</ESMCInterface>
    					<ESMCInterface>ge-0/1/1</ESMCInterface>
    					<ESMCInterface>ge-0/1/2</ESMCInterface>
    				</ESMCInterfaces>
    			</TimingDeviceESMCGroup>
    			<TimingDeviceESMCGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ESMCInterfaces>
    					<ESMCInterface>ge-0/1/3</ESMCInterface>
    					<ESMCInterface>ge-0/1/4</ESMCInterface>
    					<ESMCInterface>ge-0/2/1</ESMCInterface>
    					<ESMCInterface>ge-0/2/0</ESMCInterface>
    				</ESMCInterfaces>
    			</TimingDeviceESMCGroup>
    		</ServiceOrder>
    	</ServiceResource>
    </Data>
    
    
    				

    Get All SyncE Service Orders

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

    URI

    /api/space/nsas/sync-e/service-management/service-orders/

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects all the configured SyncE service orders.

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder
    			href="/api/space/nsas/sync-e/service-management/service-orders/163841"
    			uri="/api/space/nsas/sync-e/service-management/service-orders/163841"
    			key="163841">
    			<Common>
    				<Name>TestSyncEOS</Name>
    				<Identity>163841</Identity>
    				<State>Completed</State>
    				<Comments>TestSyncEOS</Comments>
    				<CreatedDate>2013-05-15T18:24:43.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-05-15T18:24:59.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>SyncE</ServiceType>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="32782"
    						href="/api/space/nsas/sync-e/service-management/service-definitions/32782"
    						uri="/api/space/nsas/sync-e/service-management/service-definitions/32782">
    						<ServiceDefinitionName>TestSynce</ServiceDefinitionName>
    					</ServiceDefinitionID>
    				</ServiceDefinition>
    			</Reference>
    		</ServiceOrder>
    		<ServiceOrder
    			href="/api/space/nsas/sync-e/service-management/service-orders/98318"
    			uri="/api/space/nsas/sync-e/service-management/service-orders/98318"
    			key="98318">
    			<Common>
    				<Name>sfddsfa</Name>
    				<Identity>98318</Identity>
    				<State>Completed</State>
    				<Comments>fdsds</Comments>
    				<CreatedDate>2013-05-10T14:31:47.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-05-10T14:31:53.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>SyncE</ServiceType>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="32782"
    						href="/api/space/nsas/sync-e/service-management/service-definitions/32782"
    						uri="/api/space/nsas/sync-e/service-management/service-definitions/32782">
    						<ServiceDefinitionName>TestSynce</ServiceDefinitionName>
    					</ServiceDefinitionID>
    				</ServiceDefinition>
    			</Reference>
    		</ServiceOrder>
    		<ServiceOrder
    			href="/api/space/nsas/sync-e/service-management/service-orders/98305"
    			uri="/api/space/nsas/sync-e/service-management/service-orders/98305"
    			key="98305">
    			<Common>
    				<Name>SyncESO_modify_1368173940739</Name>
    				<Identity>98305</Identity>
    				<State>Completed</State>
    				<Comments>AThisjjfdsThis is for modification</Comments>
    				<CreatedDate>2013-05-10T13:50:38.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-05-10T13:50:47.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>SyncE</ServiceType>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="32782"
    						href="/api/space/nsas/sync-e/service-management/service-definitions/32782"
    						uri="/api/space/nsas/sync-e/service-management/service-definitions/32782">
    						<ServiceDefinitionName>TestSynce</ServiceDefinitionName>
    					</ServiceDefinitionID>
    				</ServiceDefinition>
    			</Reference>
    		</ServiceOrder>
    		<ServiceOrder
    			href="/api/space/nsas/sync-e/service-management/service-orders/32797"
    			uri="/api/space/nsas/sync-e/service-management/service-orders/32797"
    			key="32797">
    			<Common>
    				<Name>SyncESO</Name>
    				<Identity>32797</Identity>
    				<State>Completed</State>
    				<Comments>SyncESO</Comments>
    				<CreatedDate>2013-05-07T15:22:38.000+05:30</CreatedDate>
    				<LastUpdatedDate>2013-05-07T15:23:01.000+05:30</LastUpdatedDate>
    				<CreatedBy>super</CreatedBy>
    			</Common>
    			<ServiceType>SyncE</ServiceType>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="32782"
    						href="/api/space/nsas/sync-e/service-management/service-definitions/32782"
    						uri="/api/space/nsas/sync-e/service-management/service-definitions/32782">
    						<ServiceDefinitionName>TestSynce</ServiceDefinitionName>
    					</ServiceDefinitionID>
    				</ServiceDefinition>
    			</Reference>
    		</ServiceOrder>
    	</ServiceResource>
    </Data>
    
    				

    Delete an OAM Service Order

    This request is used to delete an OAM service order.

    URI

    api/space/nsas/sync-e/service-management/service-
    orders/<id>

    HTTP Method

    DELETE

    Consumes

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

    Produces

    Deletes an OAM service order.

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Status>
     		<Identity>
     			<Type>ServiceOrder</Type>
     			<Value>65729</Value>
     		</Identity>
     	<Code>200</Code>
     		<Message>Service order Deleted Successfully.</Message>
     	</Status>
    </Data>
    

    Create a SyncE Service Order

    This request is used to create a SyncE service order.

    URI

    /api/space/nsas/sync-e/service-management/service-orders/

    HTTP Method

    POST

    Content Type

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

    Produces

    Creates a SyncE service order.

    Input

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    	<ServiceResource>
    		<ServiceOrder>
    			
    			<Common>
    				<Name>TestSyncEOS</Name>				
    				<Comments>TestSyncEOS</Comments>				
    			</Common>
    			<ServiceType>SyncE</ServiceType>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						key="861">
    						<DeviceName>junos-space2</DeviceName>
    						<DeviceID>861</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>ge-0/1/7</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel> PRP </QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>ge-0/1/2</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel> PRP </QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>ge-0/1/0</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel> PRP </QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceEndPointGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ServiceEndPoint>
    					<InterfaceName>xe-0/3/1</InterfaceName>
    					<ServiceEndpointConfiguration
    						xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TimingSyncEEndPointConfigParameterOrderType">
    						<QualityLevel>PRP</QualityLevel>
    						<Override>0</Override>
    						<Priority>1</Priority>
    						<WRT>5</WRT>
    					</ServiceEndpointConfiguration>
    				</ServiceEndPoint>
    			</ServiceEndPointGroup>
    			<ServiceOrderParameter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    				xsi:type="SyncEConfigParameterOrderType">
    				<GeneralSettings>
    					<NetworkOption>Option-1</NetworkOption>
    					<ClockMode>Auto</ClockMode>
    					<EnableQualityMode>false</EnableQualityMode>
    					<SourceSelectionMode>Configured Quality</SourceSelectionMode>
    					<HoldIntervalSettings>
    						<ChangeConfig>15</ChangeConfig>
    						<Restart>120</Restart>
    						<Switchover>30</Switchover>
    						<SwitchoverMode>Revertive</SwitchoverMode>
    					</HoldIntervalSettings>
    				</GeneralSettings>
    			</ServiceOrderParameter>
    			<Reference>
    				<ServiceDefinition>
    					<ServiceDefinitionID key="32782"
    						href="/api/space/nsas/sync-e/service-management/service-definitions/32782"
    						uri="/api/space/nsas/sync-e/service-management/service-definitions/32782">
    						<ServiceDefinitionName>TestSynce</ServiceDefinitionName>
    					</ServiceDefinitionID>
    				</ServiceDefinition>
    			</Reference>
    			<TimingDeviceESMCGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/861"
    						key="861">
    						<DeviceName>junos-space2</DeviceName>
    						<DeviceID>861</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ESMCInterfaces>
    					<ESMCInterface>ge-0/1/0</ESMCInterface>
    					<ESMCInterface>ge-0/1/1</ESMCInterface>
    					<ESMCInterface>ge-0/1/2</ESMCInterface>
    				</ESMCInterfaces>
    			</TimingDeviceESMCGroup>
    			<TimingDeviceESMCGroup>
    				<DeviceInfo>
    					<Timing
    						href="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						uri="/api/space/nsas/prestage-synce-device/manage-devices/devices/755"
    						key="755">
    						<DeviceName>junos-space5</DeviceName>
    						<DeviceID>755</DeviceID>
    					</Timing>
    				</DeviceInfo>
    				<ESMCInterfaces>
    					<ESMCInterface>ge-0/1/3</ESMCInterface>
    					<ESMCInterface>ge-0/1/4</ESMCInterface>
    					<ESMCInterface>ge-0/2/1</ESMCInterface>
    					<ESMCInterface>ge-0/2/0</ESMCInterface>
    				</ESMCInterfaces>
    			</TimingDeviceESMCGroup>
    		</ServiceOrder>
    	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceOrderCustomActionType">
    <Action>SaveAndDeployNow</Action>
    <ScheduledDateTime>2012-04-09T19:07:18.000+05:30</ScheduledDateTime>
    </Data>
    
    	

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <Status>
    <Identity>
     		<Type>ServiceOrder</Type>
     		<Value>6553609</Value>
    </Identity>
     	<Job>
     		<ID>1998898</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>
    
    	

    Modified: 2015-10-13