Update 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 login of the user who updates the diagram.

_Syntax: _user=<diagramLastUpdateBy>

Example:user=NCA3885

builderProperties

Description: The builder property which specifies how the diagram has to be updated. This parameter is required only for diagrams based on the Standard builder.

Syntax: //For a diagram based on the Standard builder, the operation expects the update action that will be used:

builderProperties={"action" : "synchronize" | "refresh" | "appendWithFullSynchronization" | "appendWithPartialSynchronization" | "overwrite"}

_Example: _builderProperties={"action" : "synchronize"}

builderContext

Required

Description: The context for the builder that 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, and you want to update using the "appendWithFullSynchronization", "appendWithPartialSynchronization" or "overwrite" action.

  In that case, the operation expects the lists of the input feature/object IDs per feature class/object table to append to the diagram/to use to overwrite the diagram, 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 to append to the diagram, or to use to overwrite the diagram
    "initialObjects": [
      {
        "objectClassName" : "<objectClass1Name>",
        "objectIDs" : [ID11, ..., IDN]
      },
      ...,
      {
        "objectClassName" : "<objectClassNName>",
        "objectIDs" : [ID11, ..., 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 or generated from a set of GIS features/objects that you want to update using the "synchronize", or "refresh" action. 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>

persistOption

Required

Description: The persistence option to specify whether the removed/reduced schematic features are restored after update and the schematic feature links whose connections have been modified are reconnected to be in exact coherence with their associated real features after update.

Value:True | False