Query (Trace Configurations) | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TraceNetworkServer/traceConfigurations/query
Methods:: GET
Version Introduced:: 10.9

Description

The query operation returns all properties from one or more named trace configurations in a trace network.

Request parameters

Parameter Details

Parameter	Details
`f`	The output format of the response. The default response format is `html`. Values: `html` \| `json` \| `pjson`
`globalIds` (Optional)	Specifies the global IDs of the named trace configurations to be queried; this is provided as an array of strings. Syntax: Use dark colors for code blocksCopy `1 2 globalIds=[<guid>]` Example: Use dark colors for code blocksCopy `1 2 globalIds= ["{K66AC850-832E-42E3-LE5E-ACEE122F1G6B9}", "{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"]`
`creators` (Optional)	Specifies the creators of the named trace configurations to be queried; this is provided as an array of strings. Syntax: Use dark colors for code blocksCopy `1 2 creators=[<string>]`
`tags` (Optional)	Specifies the user tags of the named trace configurations to be queried; this is provided as an array of strings. Syntax: Use dark colors for code blocksCopy `1 2 tags=[<string>]`
`names` (Optional)	Specifies the names of the named trace configurations to be queried; this is provided as an array of strings. Syntax: Use dark colors for code blocksCopy `1 2 names=[<string>]`

f

The output format of the response. The default response format is html.

Values: html | json | pjson

globalIds

(Optional)

Specifies the global IDs of the named trace configurations to be queried; this is provided as an array of strings.

Syntax:

Use dark colors for code blocksCopy

globalIds=[<guid>]

Example:

Use dark colors for code blocksCopy

globalIds= ["{K66AC850-832E-42E3-LE5E-ACEE122F1G6B9}", "{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"]

creators

(Optional)

Specifies the creators of the named trace configurations to be queried; this is provided as an array of strings.

Syntax:

Use dark colors for code blocksCopy

creators=[<string>]

tags

(Optional)

Specifies the user tags of the named trace configurations to be queried; this is provided as an array of strings.

Syntax:

Use dark colors for code blocksCopy

tags=[<string>]

names

(Optional)

Specifies the names of the named trace configurations to be queried; this is provided as an array of strings.

Syntax:

Use dark colors for code blocksCopy

names=[<string>]

JSON Response syntax

Use dark colors for code blocksCopy
{
  "traceConfigurations" : [
    {
      "name" : <string>,
      "description" : <string>,
      "traceType" : "connected" |"upstream" | "downstream" | "shortestPath",
      "traceConfiguration" : <traceConfiguration>,
      "resultTypes" :     [
      {
       "type" : "elements" | "aggregatedGeometry",
       "includeGeometry" : true | false,
       "includePropagatedValues": true | false,
       "networkAttributeNames" :["attribute1Name","attribute2Name",...],
       "diagramTemplateName": <value>,
       "resultTypeFields":[{"networkSourceId":<long>,"fieldname":<value>},...]
      }
     ],
      "minNumStartingPoints" : "none" | "one" | "many",
      "tags" : [ <string> ],
      "creator" : <string>,
      "globalId" : <guid>
    }
  ],
  "success" : <boolean>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}

Example usage

In this example, the query operation is used to return information for a named trace configuration by providing a global ID.

Request URL and parameters:

Use dark colors for code blocksCopy

https://myserver.esri.com/server/rest/services/Landbase/TraceNetworkServer/traceConfigurations/query

Use dark colors for code blocksCopy
{
f=json
globalIds=["{D3DA5377-2755-4CCC-87E7-3D1D6E102766}"]

JSON response:

Use dark colors for code blocksCopy
{
  "traceConfigurations": [
    {
      "name": "Connected_Basic",
      "description": "Connected trace example",
      "traceType": "connected",
      "traceConfiguration": {
        "includeBarriers": true,
        "validateConsistency": true,
        "ignoreBarriersAtStartingPoints": false,
        "allowIndeterminateFlow": false,
        "shortestPathNetworkAttributeName": "",
        "traversabilityScope": "junctionsAndEdges",
        "conditionBarriers": [],
        "functionBarriers": [],
        "functions": [],
        "outputFilters": [],
        "outputConditions": [],
        "pathDirection": "noDirection"
      },
      "resultTypes": [
        {
          "type": "elements",
          "includeGeometry": false,
          "includePropagatedValues": false,
          "networkAttributeNames": [],
          "diagramTemplateName": "",
          "resultTypeFields": []
        }
      ],
      "minNumStartingPoints": "one",
      "creationDate": 1737578234000,
      "tags": [
        "tag1",
        "tag2"
      ],
      "creator": "tnadmin",
      "globalId": "{D3DA5377-2755-4CCC-87E7-3D1D6E102766}"
    }
  ],
  "success": true
}