Apply (Operation)

URL	`http://<schematicalgorithm-url>/apply`
Parent Resource	Schematic Algorithm

Description

The Apply operation is performed on a Schematic Algorithm resource. The result of this operation is a Diagram Content Object.

It operates from a Schematic Diagram Content Object and the schematic algorithm parameters specified as input parameters, and returns results as schematic features.

It works as follows:

All the schematic features of the diagram (diagram content object) are sent to the server,
The server object extension instantiates an in-memory diagram with the input schematic features,
The algorithm is applied on the in-memory diagram selection (or all the diagram if no selection),
The server object extension returns all the schematic features of the resulting diagram to the client,
The server object extension deletes the in-memory diagram.

You can provide arguments to the Apply operation as query parameters defined in the parameters table below.

Parameters

Parameter	Details
f	Description: The response format. The default response format is html. Values: html \| json
parameters	Description: The parameters of the algorithm to apply Syntax and Examples: JSON Structures: Syntax: parameters={ "<AlgoParam1Name>" : <AlgoParam1Value>, ... "<AlgoParamNName>" : <AlgoParamNValue> } Example: //Syntax sample for the Hierarchical - Compact Tree schematic algorithm parameters={ "Direction" : 2, "SpacingAlongDirection" : 2, "SpacingPerpendicularToDirection" : 2, "BreakPoint" : 0.5, "OrthogonalDisplay" : False, "AbsoluteUnits" : True }
diagram	Required Description: The Diagram Content Object on which the schematic algorithm applies Syntax: diagram=<diagramContentSyntax> Example: diagram=<diagramContentExample>

Parameter

Details

Description: The response format. The default response format is html.

Values: html | json

parameters

Description: The parameters of the algorithm to apply

Syntax and Examples:

JSON Structures:

Syntax:

parameters={

  "<AlgoParam1Name>" : <AlgoParam1Value>,

  ...

  "<AlgoParamNName>" : <AlgoParamNValue>

}

Example:
//Syntax sample for the Hierarchical - Compact Tree schematic algorithm

parameters={

  "Direction" : 2,

  "SpacingAlongDirection" : 2,

  "SpacingPerpendicularToDirection" : 2,

  "BreakPoint" : 0.5,

  "OrthogonalDisplay" : False,

  "AbsoluteUnits" : True

}

diagram

Required
Description: The Diagram Content Object on which the schematic algorithm applies

Syntax:

diagram=<diagramContentSyntax>

Example:

diagram=<diagramContentExample>

JSON Response Syntax

<diagramContentSyntax>

JSON Response Example

<diagramContentExample>