Query Associated Schematic Features

Description

The queryAssociatedSchematicFeatures operation returns the schematic features in a diagram that are associated with a set of objects. It 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:

• featureClassID: The schematic feature class ID (Long).
• objectName: An array of schematic feature names (String), each name corresponding to the SCHEMATICID field value for the schematic feature in the schematic feature class.

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

Request Parameters

1
2
3
4
5
6
7
8
9
10
11
selection=[
     {
       "objectClassName" : "<objectClassName1>",
       "objectIDs" : [<objectClassName1_ID1>,..., <objectClassName1_IDN>]
     },
     ...,
     {
       "objectClassName" : "<objectClassNameN>",
       "objectIDs" : [<objectClassNameN_ID1>,..., <objectClassNameN_IDM>]
     }
]

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'.

1
https:/myserver.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.

1
https://myserver.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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "associatedFeatures" : [
    {
      "featureClassID" : <schFeatureClass1ID>,
      "objectNames" : [
        "<schFeatureName1>",
        ...,
        "<schFeatureNameN>";
      ]
    },
    {
      ...
    },
    {
      "featureClassID" : <schFeatureClass2ID>,
      "objectNames" : [
        "<schFeatureName1>",
        ...,
        "<schFeatureNameM>"
      ]
    }
  ]
}

JSON Response example

The following is an example for a given diagram with selection = {"objectClassName" : "PipelinesDatabase.SDE.pug_PUG_gas_plants", "objectIDs" : [3] }

1
2
3
4
5
6
7
8
9
10
{
  "associatedFeatures" : [
    {
      "featureClassID" : 885,
      "objectNames" : [
        "859-3-0"
      ]
    }
  ]
}