Query Associated Schematic Features

Description

The queryAssociatedSchematicFeatures operation is performed on a schematic diagram template resource. The result of this operation is a list of schematic features ID per schematic feature class ID. It is used to retrieve the schematic features contained in a diagram that are associated with a set of objects.

The associatedFeatures object returned by the REST API gives the associated schematic features as a list of schematic features names per schematic feature class ID as follows:

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

Request Parameters

Parameter

Details

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=ESTANCIA

selection

Required

Description: The list of the GIS features/objects IDs per feature class/table name for which the operation has to retrieved the associated schematic features.

Each GIS feature/object ID corresponds to a value of the OBJECTID field in the GIS feature class/table.

Syntax:

selection=[
     {
       "objectClassName" : "<objectClassName1>", 
       "objectIDs" : [<objectClassName1_ID1>,..., <objectClassName1_IDN>]
     },
     ...,
     {
       "objectClassName" : "<objectClassNameN>", 
       "objectIDs" : [<objectClassNameN_ID1>,..., <objectClassNameN_IDM>]
     }
]

Example: selection = [{"objectClassName": "PipelinesDatabase.SDE.pug_PUG_gas_plants", "objectIDs": [3]}]

Example Usage

Example 1: queryAssociatedSchematicFeatures on the MPS_Goldmine diagram, based on the template which ID is 2 under the S1_Schematics Schematics sample service, with [{"objectClassName": "PrimaryLine", "objectIDs": [1554]}] for the selection parameter, returns the only schematic feature link associated with the PrimaryLine GIS feature which OBJECTID is '1554'.

http://servicesbeta6.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/templates/2/queryAssociatedSchematicFeatures?name=MPS_Goldmine&selection=%5B%7B%22objectClassName%22%3A+%22PrimaryLine%22%2C+%22objectIDs%22%3A+%5B1554%5D%7D%5D&f=pjson

Example 2: queryAssociatedSchematicFeatures on the Substation 08 diagram, based on the template which ID is 1, under the S1_Schematics Schematics sample service, with [{"objectClassName": "Substation", "objectIDs": [1]}] for the selection parameter, returns all the schematic features associated with the Substation GIS feature which OBJECTID is '1'. This substation is associated with all the schematic features contained in the Substation 08 diagram.

http://servicesbeta6.esri.com/arcgis/rest/services/S1_Schematics/MapServer/exts/SchematicsServer/templates/1/queryAssociatedSchematicFeatures?name=Substation+08&selection=%5B%7B%22objectClassName%22%3A+%22Substation%22%2C+%22objectIDs%22%3A+%5B1%5D%7D%5D&f=pjson

JSON Response Syntax

{
  "associatedFeatures" : [
    {
      "featureClassID" : <schFeatureClass1ID>,
      "objectNames" : [
        "<schFeatureName1>",
        ...,
        "<schFeatureNameN>";
      ]
    },
    {
      ...
    },
    {
      "featureClassID" : <schFeatureClass2ID>,
      "objectNames" : [
        "<schFeatureName1>",
        ...,
        "<schFeatureNameM>"
      ]
    }
  ]
}

JSON Response Example for a given diagram with selection = {"objectClassName" : "PipelinesDatabase.SDE.pug_PUG_gas_plants", "objectIDs" : [3] }

{
  "associatedFeatures" : [
    {
      "featureClassID" : 885,
      "objectNames" : [
        "859-3-0"
      ]
    }
  ]
}

9/13/2017