JSON Structure

The returned JSON is structured into four main sections.

{
  "metadata": {
    ...
  },
  "data": {
    ...
  },
  "relations": {
    ...
  },
  "references": {
    ...
  }
}

metadata

metadata contains information about build, license and requested data.

The main intention is to provide information as to how squid by arc46 understood and executed the query it was given. This is of limited value for proven production queries but has proven useful when building and testing queries.

{
  "metadata": {
    "powered_by": "arc46.io",
    "git": "squid-0.10.0+0-17ae770",
    "build": "2024-08-24T12:04:26.650Z",
    "license_max_entities": "Unlimited",
    "license_valid_till": "2050-12-31T23:59:59.000Z",
    "config": "cmdb_ci_server",
    "limit_request": 10,
    "requested_by": "arc46_dev",
    "request_received": "2024-08-31T12:15:13.050Z",
    "parse_config": "296ms",
    "query_start": "2024-08-31T12:15:13.346Z",
    "query_duration": "4ms",
    "query_returned": "2024-08-31T12:15:13.350Z",
    "row_count": 1,
    "requested_relations": {
      "cmdb_ci_server": [
        "ci_to_asset"
      ]
    },
    "sys_ids": [
      "5f9b83bfc0a8010e005a2b3212c9dc07"
    ],
    "combined_filter": "base_sys_idIN5f9b83bfc0a8010e005a2b3212c9dc07"
  }
}

• powered_by - arc46.io
• git - Git commit of the squid by arc46 version processing the request.
• build - Build timestamp of squid by arc46 version processing the request.
• licensed_max_entities - See Pricing.
• license_valid_till - See License.
• config - the configuration you have requested.
• limit_request - see HTTP Query Param Limit
• requested_by - the authenticated user calling squid by arc46.
• request_received - timestamp when squid by arc46 was first invoked.
• parse_config - the time required to parse the requested configuration. squid by arc46 retrieves and parses all expected configurations from the database before retrieving data.
• query_start - timestamp of the moment the base database query was executed. This value may be used in future requests as query parameter updatedSince.
• query_duration - amount of time elapsed between executing the base database query and first result returning.
• query_returned - timestamp of when the database query call returned.
• row_count - the amount of entities returned by the base query.
• requested_relations
• updatedBefore
• updatedSince
• lastDiscoveredBefore
• lastDiscoveredSince
• sys_ids
• provided_filter
• combined_filter
• warnings

data

{
  ...,
  "data": [
    {
      "asset_tag": "P1000182",
      ...
    },
    {
      "asset_tag": "P1000183",
    }
  ],
  ...
}

relations

referenced

warnings