Generate Diagram

f

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

Values: html | json

name

Required

Description: The diagram name.

Syntax:name=<diagramName>

Example:name=MyTestDiagram

user

Required

Description: The diagram creator.

Syntax:user=<diagramCreator>

Example:user=NCA3885

folderID

Description: The ID of the folder in which the generated diagram will be stored.

This parameter is optional. If it is not specified, the generated diagram is stored at the schematic dataset root.

Syntax:folderID=<diagramFolderID>

Example:folderID=1

builderContext

Required

Description: The context for the builder which updates the diagram.

This parameter syntax depends on the diagram builder:

• Diagrams based on the Standard builder that are generated from a set of GIS features/objects

  In that case, the operation expects the lists of the input GIS feature/object IDs per feature class/object table, and those features/objects version:

  Syntax:

  Use dark colors for code blocksCopy

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  builderContext={
    //The lists of the input GIS feature/object IDs per feature class/object table from which the diagram must be generated
    "initialObjects": [
      {
        "objectClassName" : "<objectClass1Name>",
        "objectIDs" : [ID11, ..., IDN]
      },
      ...,
      {
        "objectClassName" : "<objectClassNName>",
        "objectIDs" : [ID1, ..., IDM]
      }
    ],
    //The SDE database reference version for those input GIS features/objects
    "version": "<version>"
  }

  Example:

  builderContext={"initialObjects": [{"objectClassName": "PipelinesDatabase.SDE.pug_PUG_gas_plants", "objectIDs": [3]}], "version":"sde.DEFAULT"}

• Diagrams based on the Standard builder that are entirely built from custom queries

  In that case, the operation expects an empty list of initial objects:

  Syntax:

  builderContext={"initialObjects": []}

  Example:

  builderContext={"initialObjects": []}

• Diagrams based on the XML builder

  In that case, the operation expects the input XML data directly as a string.

  Syntax: builderContext=<XMLData>

  Example:

  Use dark colors for code blocksCopy

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  builderContext=<Diagrams>
  	<Diagram DiagramTemplateName="SimpleXML">
  	<Features>
  	<NodeFeature>
  	<FeatureClassName>StationsFeeder1</FeatureClassName>
  	<ExternalUniqueID>NS1</ExternalUniqueID>
  	<InitialX>120067.5</InitialX>
  	<InitialY>4070755.8</InitialY>
  	</NodeFeature>
  	<NodeFeature>
  	<FeatureClassName>StationsFeeder1</FeatureClassName>
  	<ExternalUniqueID>NS2</ExternalUniqueID>
  	<InitialX>120090.5</InitialX>
  	<InitialY>4070788.8</InitialY>
  	</NodeFeature>
  	<LinkFeature>
  	<FeatureClassName>LV_Lines</FeatureClassName>
  	<ExternalUniqueID>LV1</ExternalUniqueID>
  	<FromNode>NS1</FromNode>
  	<ToNode>NS2</ToNode>
  	</LinkFeature>
  	</Features>
  	</Diagram>
  	</Diagrams>