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 Definitions Management RESTful Web Services

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

    Get a SyncE Service Definition By Service Definition ID

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

    URI

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

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects the details of a specific SyncE service definition.

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
     		<Timing href="/api/space/nsas/sync-e/service-management/service-definitions/65536" uri="/api/space/nsas/sync-e/service-management/service-definitions/65536" key="65536">
     		<SyncEDefinition>
     			<Common>
     				<Name>TestSyncE-SD</Name>
     				<Identity>65536</Identity>
     				<State>Published</State>
     				<CreatedDate>2013-04-10T21:45:50.000+05:30</CreatedDate>
     				<LastUpdatedDate>2013-04-10T21:45:50.000+05:30</LastUpdatedDate>
     				<CreatedBy>super</CreatedBy>
     			</Common>
     		<ServiceType>SyncE</ServiceType>
     		<SyncESetting>
     			<NetworkOption editable="true">Option-1</NetworkOption>
     			<ClockMode editable="false">Auto</ClockMode>
     			<EnableQualityMode editable="true">false</EnableQualityMode>
     			<SourceSelectionMode editable="true">Configured Quality</SourceSelectionMode>
     			<HoldIntervalSettings>
     				<ChangeConfig editable="true">15</ChangeConfig>
     				<Restart editable="true">120</Restart>
     				<Switchover editable="true">30</Switchover>
     				<SwitchoverMode editable="true">Revertive</SwitchoverMode>
     			</HoldIntervalSettings>
     			<InputSourceSettings>
     				<QualityLevel editable="true">PRC</QualityLevel>
     				<Priority editable="true">1</Priority>
     				<WaittoRestore editable="true">5</WaittoRestore>
     				<Override editable="true">Default</Override>
     			</InputSourceSettings>
     		</SyncESetting>
     		</SyncEDefinition>
     		</Timing>
     	</ServiceResource>
    </Data>
    

    Get All SyncE Service Definitions

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

    URI

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

    HTTP Method

    GET

    Consumes

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

    Produces

    Collects all the configured SyncE service definitions.

    Output

    Sample XML Output

    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
     	<ServiceResource size="1">
     		<Timing href="/api/space/nsas/sync-e/service-management/service-definitions/65536" uri="/api/space/nsas/sync-e/service-management/service-definitions/65536" key="65536">
      		<SyncEDefinition>
     			<Common>
     				<Name>TestSyncE-SD</Name>
     				<Identity>65536</Identity>
     				<State>Published</State>
     				<CreatedDate>2013-04-10T21:45:50.000+05:30</CreatedDate>
     				<LastUpdatedDate>2013-04-10T21:45:50.000+05:30</LastUpdatedDate>
     				<CreatedBy>super</CreatedBy>
     			</Common>
     			<ServiceType>SyncE</ServiceType>
     		<SyncESetting/>
     		</SyncEDefinition>
     	</Timing>
     	</ServiceResource>
    </Data>
    
    				

    Create a SyncE Service Definition

    This request is used to create a SyncE service definition.

    URI

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

    HTTP Method

    POST

    Content Type

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

    Consumes

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

    Produces

    Creates a SyncE service definition.

    Input

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <ServiceResource>
    		<TimingServiceDefinition>
     			<Common>
     				<Name>TestSyncE-SD</Name>
     				<Comments>this is a sample comment</Comments>
     			</Common>
    <ServiceType>SyncE</ServiceType>
     	 		<SyncESetting>
     			<NetworkOption editable="true">Option-1</NetworkOption>
     			<ClockMode editable="false">Auto</ClockMode>
     			<EnableQualityMode editable="true">false</EnableQualityMode>
     			<SourceSelectionMode editable="true">Configured Quality</SourceSelectionMode>
     			<HoldIntervalSettings>
     				<ChangeConfig editable="true">15</ChangeConfig>
     				<Restart editable="true">120</Restart>
     				<Switchover editable="true">30</Switchover>
     				<SwitchoverMode editable="true">Revertive</SwitchoverMode>
     			</HoldIntervalSettings>
     			<InputSourceSettings>
     				<QualityLevel editable="true">PRC</QualityLevel>
     				<Priority editable="true">1</Priority>
     				<WaittoRestore editable="true">5</WaittoRestore>
     				<Override editable="true">Default</Override>
     			</InputSourceSettings>
     		</SyncESetting>
     		</TimingServiceDefinition>
      	</ServiceResource>
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceDefinitionCustomActionType">
    	<Action>Publish</Action>
    </CustomAction>
    </Data>
    
    
    
    				

    Output

    Sample XML Output

    
        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <Data xmlns="services.schema.networkapi.jmp.juniper.net">
        <Status>
        <Identity>
        <Type>SyncEServiceDefinition</Type>
        <Value>557056</Value>
        </Identity>
        <Code>200</Code>
        <Message>ServiceDefinition Created and Published Successfully</Message>
        </Status>
        </Data>
    
    
    
    
    

    Publish and Unpublish a SyncE Service Definition

    This request is used to publish or unpublish a SyncE service definition.

    URI

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

    HTTP Method

    POST

    Content-Type

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

    Consumes

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

    Action types are Publish and Unpublish.

    Produces

    Publishes or unpublishes a SyncE service.

    Input (Publishing a Service Definition)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceDefinitionCustomActionType">
    	<Action>Publish</Action>
    </CustomAction>
    </Data>
    				

    Output

    Sample XML Output

    <para><user-typing>Input</user-typing></para><example>
    <title>Sample XML Input</title>
    <code></code>
    </example><para><user-typing>Output</user-typing></para><example>
    <title>Sample XML Output</title>
    <code></code>
    </example>

    Input (Unpublishing a Service Definition)

    Sample XML Input

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Data xmlns="services.schema.networkapi.jmp.juniper.net">
    <CustomAction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ServiceDefinitionCustomActionType">
    	<Action>Unpublish</Action>
    </CustomAction>
    </Data>
    				

    Output

    Sample XML Output

    <Data>
    <Status>
    <Identity>
    <Type>ServiceDefinition</Type>
    <Value>65586</Value>
    </Identity>
    <Code>200</Code>
    <Message>ServiceDefinition UnPublished Successfully</Message>
    </Status>
    </Data>
    

    Modified: 2015-10-13