openapi: 3.0.0 paths: /api/search/v1/catalog: get: description: Provides information about the site and its catalog of organized resources and collections. operationId: CatalogController_getSiteCatalog_api/search/v1 parameters: - name: token required: false in: query description: ArcGIS token to use when accessing the underlying ArcGIS Item that represents the site. schema: type: string responses: '200': description: A data object describing the site and its catalog. content: application/json: schema: $ref: '#/components/schemas/Catalog' summary: '' tags: - Catalog /api/search/v1/collections: get: description: Lists the collections described in the site's catalog. operationId: CollectionController_getSiteCollections_api/search/v1 parameters: - name: token required: false in: query description: ArcGIS token to use when accessing the underlying ArcGIS Item that represents the site. schema: type: string responses: '200': description: A data object containing a list of site catalog collections. content: application/json: schema: $ref: '#/components/schemas/CollectionsResponseDto' summary: '' tags: - Collection /api/search/v1/collections/{collectionId}: get: description: Retrieves the collection from a site's catalog with a provided id/key operationId: CollectionController_getSiteCollectionFromId_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id for the desired collection. schema: example: dataset type: string - name: token required: false in: query description: ArcGIS token to use when accessing the underlying ArcGIS Item that represents the site. schema: type: string responses: '200': description: A data object describing a site collection. content: application/json: schema: $ref: '#/components/schemas/CollectionWithLinksDto' summary: '' tags: - Collection /api/search/v1/collections/{collectionId}/queryables: get: description: Lists the minimal item properties expected to be returned when searching items in the specified collection. operationId: QueryableController_getSiteCollectionQueryables_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which queryables should be obtained. schema: example: dataset type: string - name: token required: false in: query description: ArcGIS token to use when accessing the underlying ArcGIS Item that represents the site. schema: type: string responses: '200': description: A data object describing the core queryable fields of a site catalog collection. content: application/json: schema: $ref: '#/components/schemas/OgcQueryablesResponseDto' summary: '' tags: - Queryable /api/search/v1/collections/{collectionId}/items: get: description: Returns items from the specified site catalog collection that match specified filters operationId: OgcItemController_getSiteCollectionItems_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string responses: '200': description: A FeatureCollection object describing items (in GeoJSON) returned when searching the provided collection content: application/json: schema: $ref: '#/components/schemas/OgcItemResponseDto' summary: '' tags: - OgcItem /api/search/v1/collections/{collectionId}/items/{itemId}: get: operationId: OgcItemController_getSiteCollectionItemById_api/search/v1 parameters: - name: collectionId required: true in: path schema: example: dataset type: string - name: itemId required: true in: path schema: type: string - name: token required: false in: query description: token for use in authentication/authorization schema: title: token type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OgcItemDto' tags: - OgcItem /api/search/v1/collections/{collectionId}/items/{recordId}/related: get: description: Returns related items to recordId from the specified site catalog collection that match specified filters operationId: OgcItemController_getRelatedOgcItemsById_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string responses: '200': description: A FeatureCollection object describing related items to recordId (in GeoJSON) returned when searching the provided collection content: application/json: schema: $ref: '#/components/schemas/OgcItemResponseDto' summary: '' tags: - OgcItem /api/search/v1/collections/{collectionId}/items/{recordId}/connected: get: description: Returns connected items to recordId from the specified site catalog collection that match specified filters operationId: OgcItemController_getConnectedOgcItemsById_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string responses: '200': description: A FeatureCollection object describing connected items to recordId (in GeoJSON) returned when searching the provided collection content: application/json: schema: $ref: '#/components/schemas/OgcItemResponseDto' summary: '' tags: - OgcItem /api/search/v1/collections/{collectionId}/aggregations: get: description: Returns requested aggregations from the specified site catalog collection operationId: OgcItemAggregationController_getAggregations_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: exampleAggregationName required: false in: query description: This is an EXAMPLE aggregation expression. More aggregation expressions can be specified by adding additional query parameters, where the name of the parameter is an arbitrary alphabetic aggregation name examples: terms: summary: Terms value: terms(fields=(access,tags,source)) description: An aggregation that analyzes matching items by the unique values of the specified fields. Returns buckets by field and unique value. The mandatory "fields" parameter is a comma-separated list of field names to aggregate on. max: summary: Max value: max(fields=(totalReplies, totalReactions)) description: An aggregation that calculates the maximum value of one or more fields across all matching items. The mandatory "fields" parameter is a comma-separated list of field names to aggregate on. min: summary: Min value: min(fields=(totalReplies, totalReactions)) description: An aggregation that calculates the minimum value of one or more fields across all matching items. The mandatory "fields" parameter is a comma-separated list of field names to aggregate on. avg: summary: Avg value: avg(fields=(totalReactions, totalReplies)) description: An aggregation that calculates the averages value of one or more fields across all matching items. The mandatory "fields" parameter is a comma-separated list of field names to aggregate on. histogram: summary: Histogram value: histogram(fields=(totalReplies,totalReactions), interval=5) description: An aggregation that groups items into buckets based on a numeric field. The mandatory "fields" parameter are the numeric fields to aggregate on. The mandatory "interval" parameter is the interval to use for bucketing, and has a minimum value of 0.1. date_histogram: summary: Date Histogram value: date_histogram(fields=(createdAt, updatedAt),interval=month,bycreator=terms(fields=(creator,editor))) description: 'An aggregation that groups items into buckets based on a date field. The mandatory "fields" parameter are the date fields to aggregate on. The mandatory "interval" parameter is the time interval to use for bucketing. Valid intervals are: "year", "month", "week", and "day". You can also specify a number of days from 1-99 inclusive, e.g. "14d" for fourteen days. Finally, sub-aggregations can provided that summate discussion post data on a per-bucket basis. This example aggregates posts based on the createdAt and updatedAt fields and, for each, further sub-aggregating by creator, and editor.' geohash: summary: Geohash value: geohash(fields=(geometry), precision=6, byCreator=terms(fields=(creator)), byCreatedDate=date_histogram(fields=(createdAt), interval=month), avgSentiment=avg(fields=(sentiment))) description: An aggregation that groups items into buckets based on a geohash on a geospatial field. The mandatory "fields" parameter are the geospatial fields for which to aggregate on. "Precision" can be optionally provided (defaults to 5) to allow for hashing with various geospatial precisions (https://en.wikipedia.org/wiki/Geohash#Digits_and_precision_in_km). Finally, sub-aggregations can provided that summate discussion post data on a per-geohash basis. This example geohashes posts based on the geometry field, further sub-aggregating by creator, post creation date, and average sentiment. schema: type: string - name: filter required: false in: query description: CQL filter expression that can be used to refine the aggregation search schema: title: filter type: string readOnly: true examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: Limit the number of results returned for "bucket"-based aggregations schema: title: limit type: integer readOnly: true - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string responses: '200': description: A response describing requested collection aggregations content: application/json: schema: $ref: '#/components/schemas/OgcItemAggregationResponseDto' summary: '' tags: - OgcItemAggregation /api/search/v1: get: description: Provides links to the API definition, the Conformance statements and the metadata about the coverage data in this dataset. operationId: OgcRootController_getSiteRoot_api/search/v1 parameters: - name: token required: false in: query description: ArcGIS token to use when accessing the underlying ArcGIS Item that represents the site. schema: type: string responses: '200': description: A data object describing the site and its API. content: application/json: schema: $ref: '#/components/schemas/OgcApiLandingPageDto' summary: '' tags: - OgcRoot /api/search/v1/conformance: get: description: Returns the conformance specifications the API meets operationId: OgcRootConformanceController_getApiConformance_api/search/v1 parameters: - name: token required: false in: query description: ArcGIS token to use when accessing the underlying ArcGIS Item that represents the site. schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OgcApiConformancePageDto' summary: '' tags: - OgcRootConformance /api/search/v1/rest/info: get: operationId: GeoserviceController_restInfo_api/search/v1 parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RestInfoDto' tags: - Geoservice-Beta /api/search/v1/rest/services/collections/{collectionId}/geoservice/FeatureServer: get: operationId: GeoserviceController_featureServer_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string - name: f required: false in: query description: The available output formats for feature server schema: $ref: '#/components/schemas/FeatureServerFormats' - name: where required: false in: query description: Where clause for feature server querying schema: example: 1=1 - name: geometryType required: false in: query description: Filter by geometry types schema: example: - esriGeometryPoint - esriGeometryMultipoint - esriGeometryPolyline - esriGeometryPolygon - esriGeometryEnvelope - name: groupByFieldsForStatistics required: false in: query description: Attribute to use as key for aggregation schema: example: zipCode - name: outStatistics required: false in: query schema: $ref: '#/components/schemas/OutputStatistics' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FeatureServerDto' tags: - Geoservice-Beta /api/search/v1/rest/services/collections/{collectionId}/geoservice/FeatureServer/layers: get: operationId: GeoserviceController_featureLayers_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string - name: f required: false in: query description: The available output formats for feature server schema: $ref: '#/components/schemas/FeatureServerFormats' - name: where required: false in: query description: Where clause for feature server querying schema: example: 1=1 - name: geometryType required: false in: query description: Filter by geometry types schema: example: - esriGeometryPoint - esriGeometryMultipoint - esriGeometryPolyline - esriGeometryPolygon - esriGeometryEnvelope - name: groupByFieldsForStatistics required: false in: query description: Attribute to use as key for aggregation schema: example: zipCode - name: outStatistics required: false in: query schema: $ref: '#/components/schemas/OutputStatistics' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FeatureLayersDto' tags: - Geoservice-Beta /api/search/v1/rest/services/collections/{collectionId}/geoservice/FeatureServer/{layerIndex}: get: operationId: GeoserviceController_featureLayer_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: layerIndex required: true in: path schema: type: number - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string - name: f required: false in: query description: The available output formats for feature server schema: $ref: '#/components/schemas/FeatureServerFormats' - name: where required: false in: query description: Where clause for feature server querying schema: example: 1=1 - name: geometryType required: false in: query description: Filter by geometry types schema: example: - esriGeometryPoint - esriGeometryMultipoint - esriGeometryPolyline - esriGeometryPolygon - esriGeometryEnvelope - name: groupByFieldsForStatistics required: false in: query description: Attribute to use as key for aggregation schema: example: zipCode - name: outStatistics required: false in: query schema: $ref: '#/components/schemas/OutputStatistics' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FeatureLayerDto' tags: - Geoservice-Beta /api/search/v1/rest/services/collections/{collectionId}/geoservice/FeatureServer/{layerIndex}/info: get: operationId: GeoserviceController_featureLayerInfo_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: layerIndex required: true in: path schema: type: number - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string - name: f required: false in: query description: The available output formats for feature server schema: $ref: '#/components/schemas/FeatureServerFormats' - name: where required: false in: query description: Where clause for feature server querying schema: example: 1=1 - name: geometryType required: false in: query description: Filter by geometry types schema: example: - esriGeometryPoint - esriGeometryMultipoint - esriGeometryPolyline - esriGeometryPolygon - esriGeometryEnvelope - name: groupByFieldsForStatistics required: false in: query description: Attribute to use as key for aggregation schema: example: zipCode - name: outStatistics required: false in: query schema: $ref: '#/components/schemas/OutputStatistics' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FeatureLayerDto' tags: - Geoservice-Beta /api/search/v1/rest/services/collections/{collectionId}/geoservice/FeatureServer/{layerIndex}/query: get: operationId: GeoserviceController_featureLayerQuery_api/search/v1 parameters: - name: collectionId required: true in: path description: Key/id of the collection for which item should be filtered and returned. schema: example: dataset type: string - name: layerIndex required: true in: path schema: type: number - name: q required: false in: query description: A general text search filter. schema: title: q type: string - name: bbox required: false in: query description: A bbox filter, must be 4 comma-separated coordinates schema: title: bbox type: string - name: filter required: false in: query description: query parameter that represents a parse-able string of filter expressions, structured according to the Common Query Language Specification of the OGC Features API. If filter values must include whitespace, try wrapping the value in single quotes. schema: title: filter type: string examples: equals: summary: Equals value: type='Feature Service' greaterThan: summary: Greater Than value: created > 1670531235 greaterThanOrEquals: summary: Greater Than Or Equals value: created >= 1670531235 LessThan: summary: Less Than value: created < 1670531235 lessThanOrEquals: summary: Less Than Or Equals value: created <= 1670531235 in: summary: IN value: tags IN (tag1, 'tag2', tag3) notIn: summary: NOT IN value: tags NOT IN (tag1, 'tag2', tag3) betweenAnd: summary: BETWEEN AND value: created BETWEEN 1670531235 AND 1770531235 notBetweenAnd: summary: NOT BETWEEN AND value: created NOT BETWEEN 1670531235 AND 1770531235 like: summary: LIKE value: description LIKE 'moby*' 'null': summary: IS NULL value: source IS NULL notNull: summary: IS NOT NULL value: owner IS NOT NULL and: summary: AND value: tags NOT IN (tag1, 'tag2', tag3) AND owner IS NOT NULL or: summary: OR value: tags NOT IN (tag1, 'tag2', tag3) OR owner IS NOT NULL not: summary: NOT value: tags NOT IN (tag1, 'tag2', tag3) NOT owner IS NULL subExpressions: summary: Subexpressions value: ((type='Feature Service' AND access=public) OR (type='Web Mapping Application' AND access=shared)) - name: limit required: false in: query description: The number of results to return. schema: title: limit type: integer minimum: 0 maximum: 100 - name: startindex required: false in: query description: The initial index of the results to return, starting at 1. schema: title: startindex type: integer minimum: 1 - name: type required: false in: query description: The type of resource. schema: title: type type: string description: the type of the underlying resource - name: title required: false in: query description: The title of resource to return. schema: title: title type: string description: the title of the underlying resource - name: recordId required: false in: query description: The recordId of resource to return. recordId could be itemId or itemId_layerId schema: title: recordId type: string description: id of the record - name: sortBy required: false in: query description: Sort results by specific fields. Prefixed by either "+" for ascending or "-" for descending. If no prefix is provided, "+" is assumed. schema: title: sortBy type: string - name: tags required: false in: query description: Tags for items search schema: example: 'true' type: string - name: token required: false in: query description: Token to use when accessing the underlying ArcGIS Item that represents the site. schema: title: token type: string - name: openData required: false in: query description: Boolean flag to get items that are shared to Opendata group schema: example: 'true' type: string - name: f required: false in: query description: The available output formats for feature server schema: $ref: '#/components/schemas/FeatureServerFormats' - name: where required: false in: query description: Where clause for feature server querying schema: example: 1=1 - name: geometryType required: false in: query description: Filter by geometry types schema: example: - esriGeometryPoint - esriGeometryMultipoint - esriGeometryPolyline - esriGeometryPolygon - esriGeometryEnvelope - name: groupByFieldsForStatistics required: false in: query description: Attribute to use as key for aggregation schema: example: zipCode - name: outStatistics required: false in: query schema: $ref: '#/components/schemas/OutputStatistics' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FeatureLayerQueryDto' tags: - Geoservice-Beta info: title: Bonneville Power Administration Data Search API description: 'Welcome to the Search API. This guide describes how to use the Search API to programmatically query, filter, and search a catalog. Use this explorer to test API endpoints and search the site''s catalog without needing to use the site''s client search interface. Common uses cases include rendering features on a map in other tools including ArcGIS Map Viewer, GIS desktop applications, OWSLib, and more. The Search API conforms to the new OGC API - Records specification. For further details including definitions and example use cases, see the web help.' version: 1.0.0 contact: {} x-api-evangelist-note: Registered copy. Byte-identical to openapi/_original/bonneville-power-administration-data-search-api-openapi.json except for this note and the servers[] block, which the published document omits; the host is taken from the API's own landing-page self link at https://data-bpagis.hub.arcgis.com/api/search/v1. See overlays/. tags: [] servers: - url: https://data-bpagis.hub.arcgis.com description: BPA GIS Data Hub — the ArcGIS Hub site instance BPA operates (org Iz3chmSt4P7oOoZy) components: schemas: Catalog: type: object properties: {} RangeParamsEpoch: type: object properties: from: type: number description: epoch time in milliseconds example: 160000000 to: type: number description: epoch time in milliseconds example: 170000000 required: - from - to EnvelopeDto: type: object properties: bbox: type: array minItems: 4 items: type: number type: type: string description: Type of geometry filter, must be "Envelope" enum: - Envelope coordinates: description: Coordinates in either 2d bbox [xmin,ymin,xmax,ymax] or envelope [[xmin,ymax],[xmax,ymin]] formats anyOf: - type: array minItems: 4 maxItems: 4 items: type: number - type: array minItems: 2 maxItems: 2 items: type: array minItems: 2 maxItems: 2 items: type: number required: - type - coordinates GeometryDto: type: object properties: bbox: type: array minItems: 4 items: type: number GeometryFilterDto: type: object properties: relation: type: string description: Type of relation, defaults to "intersects" enum: - intersects - disjoint - within - contains geometry: anyOf: - $ref: '#/components/schemas/EnvelopeDto' allOf: - $ref: '#/components/schemas/GeometryDto' required: - geometry ItemSearchFiltersDto: type: object properties: id: oneOf: - type: string nullable: false description: an id pattern: ^[a-f0-9]{32}$ - type: array nullable: false description: an array of ids, any of which should match items: type: string nullable: false description: an id pattern: ^[a-f0-9]{32}$ - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: an id pattern: ^[a-f0-9]{32}$ any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: an id pattern: ^[a-f0-9]{32}$ not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: an id pattern: ^[a-f0-9]{32}$ exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: an id pattern: ^[a-f0-9]{32}$ owner: example: dev_bas_hub_admin oneOf: - type: string nullable: false description: an owner - type: array nullable: false description: an array of owners, any of which should match items: type: string nullable: false description: an owner - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: an owner any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: an owner not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: an owner exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: an owner created: description: a date range example: from: 160000000 to: 170000000 allOf: - $ref: '#/components/schemas/RangeParamsEpoch' modified: description: a date range example: from: 160000000 to: 170000000 allOf: - $ref: '#/components/schemas/RangeParamsEpoch' title: example: all: - all - here - must match any: - any - here - must match not: - none - here - must match exact: - all - here - must match exactly oneOf: - type: string nullable: false description: a title string - type: array nullable: false description: an array of title strings, any of which should match items: type: string nullable: false description: a title string - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a title string any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a title string not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a title string exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a title string type: example: - Feature Service - Microsoft Excel oneOf: - type: string nullable: false description: a type - type: array nullable: false description: an array of types, any of which should match items: type: string nullable: false description: a type - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a type any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a type not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a type exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a type typekeywords: example: HubProject oneOf: - type: string nullable: false description: a typekeyword - type: array nullable: false description: an array of typekeywords, any of which should match items: type: string nullable: false description: a typekeyword - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a typekeyword any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a typekeyword not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a typekeyword exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a typekeyword description: example: all: - all - here - must match any: - any - here - must match not: - none - here - must match exact: - all - here - must match exactly oneOf: - type: string nullable: false description: a decription string - type: array nullable: false description: an array of description strings, any of which should match items: type: string nullable: false description: a description string - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a description string any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a description string not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a description string exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a description string tags: example: - tag 1 - tag 2 oneOf: - type: string nullable: false description: a tag - type: array nullable: false description: an array of tags, any of which should match items: type: string nullable: false description: a tag - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a tag any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a tag not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a tag exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a tag snippet: example: a test snippet oneOf: - type: string nullable: false description: a snippet string - type: array nullable: false description: an array of snippet strings, any of which should match items: type: string nullable: false description: a snippet string - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a snippet string any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a snippet string not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a snippet string exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a snippet string accessinformation: example: all: - all - here - must match any: - any - here - must match not: - none - here - must match exact: - all - here - must match exactly oneOf: - type: string nullable: false description: an accessinformation string - type: array nullable: false description: an array of accessinformation strings, any of which should match items: type: string nullable: false description: an accessinformation string - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: an accessinformation string any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: an accessinformation string not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: an accessinformation string exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: an accessinformation string access: example: - public - private anyOf: - type: string nullable: false enum: - public - private - org - shared description: an access string - type: array nullable: false description: an array of access strings, any of which should match items: type: string nullable: false enum: - public - private - org - shared description: an accessinformation string - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false enum: - public - private - org - shared description: an access string any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false enum: - public - private - org - shared description: an access string not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false enum: - public - private - org - shared description: an access string exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false enum: - public - private - org - shared description: an access string group: oneOf: - type: string nullable: false description: a group id pattern: ^[a-f0-9]{32}$ - type: array nullable: false description: an array of group ids, any of which should match items: type: string nullable: false description: a group id pattern: ^[a-f0-9]{32}$ - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a group id pattern: ^[a-f0-9]{32}$ any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a group id pattern: ^[a-f0-9]{32}$ not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a group id pattern: ^[a-f0-9]{32}$ exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a group id pattern: ^[a-f0-9]{32}$ culture: example: all: - all - here - must match any: - any - here - must match not: - none - here - must match exact: - all - here - must match exactly oneOf: - type: string nullable: false description: a culture string - type: array nullable: false description: an array of culture strings, any of which should match items: type: string nullable: false description: a culture string - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a culture string any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a culture string not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a culture string exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a culture string orgid: oneOf: - type: string nullable: false description: an org id pattern: ^[a-zA-Z0-9]{16}$ - type: array nullable: false description: an array of org ids, any of which should match items: type: string nullable: false description: an org id pattern: ^[a-zA-Z0-9]{16}$ - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: an org id pattern: ^[a-zA-Z0-9]{16}$ any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: an org id pattern: ^[a-zA-Z0-9]{16}$ not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: an org id pattern: ^[a-zA-Z0-9]{16}$ exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: an org id pattern: ^[a-zA-Z0-9]{16}$ categories: example: category test oneOf: - type: string nullable: false description: a category - type: array nullable: false description: an array of categories, any of which should match items: type: string nullable: false description: a category - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false description: a category any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false description: a category not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false description: a category exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false description: a category term: example: all: - all - here - must match any: - any - here - must match not: - none - here - must match exact: - all - here - must match exactly oneOf: - type: string nullable: false description: a string of terms for searching - type: object properties: all: type: array nullable: true description: optional array of terms that all must match items: type: string nullable: false any: type: array nullable: true description: optional array of terms, only at least one must match items: type: string nullable: false not: type: array nullable: true description: optional array of terms, none of which can must match items: type: string nullable: false exact: type: array nullable: true description: optional array of terms, all of which must match exactly items: type: string nullable: false boundary: $ref: '#/components/schemas/GeometryFilterDto' ItemSearchFiltersBlockDto: type: object properties: operation: type: string enum: - AND - OR default: AND predicates: type: array items: $ref: '#/components/schemas/ItemSearchFiltersDto' required: - predicates CollectionDto: type: object properties: id: type: string example: '12345' type: type: string enum: - Collection title: type: string example: Collection Title description: type: string example: Collection description itemType: type: string crs: type: array items: type: string filters: type: array items: $ref: '#/components/schemas/ItemSearchFiltersBlockDto' required: - id - type - title - description - itemType - crs CollectionsResponseLinksDto: type: object properties: rel: type: string type: type: string title: type: string href: type: string required: - rel - type - title - href CollectionsResponseDto: type: object properties: collections: type: array items: $ref: '#/components/schemas/CollectionDto' links: type: array items: $ref: '#/components/schemas/CollectionsResponseLinksDto' required: - collections - links CollectionDtoLink: type: object properties: rel: type: string type: type: string title: type: string href: type: string hreflang: type: string required: - rel - type - title - href - hreflang CollectionWithLinksDto: type: object properties: id: type: string example: '12345' type: type: string enum: - Collection title: type: string example: Collection Title description: type: string example: Collection description itemType: type: string crs: type: array items: type: string filters: type: array items: $ref: '#/components/schemas/ItemSearchFiltersBlockDto' links: type: array items: $ref: '#/components/schemas/CollectionDtoLink' required: - id - type - title - description - itemType - crs - links OgcQueryablesResponseDto: type: object properties: type: type: string enum: - object title: type: string $schema: type: string $id: type: string properties: type: object properties: recordId: title: recordId type: string description: id of the record geometry: title: geometry type: object description: geometry of the underlying resource oneOf: - title: GeoJSON Point type: object required: - type - coordinates properties: type: type: string enum: - Point coordinates: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number nullable: true - title: GeoJSON LineString type: object required: - type - coordinates properties: type: type: string enum: - LineString coordinates: type: array minItems: 2 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON Polygon type: object required: - type - coordinates properties: type: type: string enum: - Polygon coordinates: type: array items: type: array minItems: 4 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON MultiPoint type: object required: - type - coordinates properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON MultiLineString type: object required: - type - coordinates properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array minItems: 2 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON MultiPolygon type: object required: - type - coordinates properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array minItems: 4 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number type: title: type type: string description: the type of the underlying resource title: title: title type: string description: the title of the underlying resource required: - type - title - $schema - properties OgcItemDto: type: object properties: id: type: string title: id type: type: string title: type enum: - Feature geometry: title: geometry oneOf: - title: GeoJSON Point type: object required: - type - coordinates properties: type: type: string enum: - Point coordinates: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON LineString type: object required: - type - coordinates properties: type: type: string enum: - LineString coordinates: type: array minItems: 2 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON Polygon type: object required: - type - coordinates properties: type: type: string enum: - Polygon coordinates: type: array items: type: array minItems: 4 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON MultiPoint type: object required: - type - coordinates properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON MultiLineString type: object required: - type - coordinates properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array minItems: 2 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number - title: GeoJSON MultiPolygon type: object required: - type - coordinates properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array minItems: 4 items: type: array minItems: 2 items: type: number bbox: type: array minItems: 4 items: type: number properties: type: object title: properties time: type: object title: time required: - id - type - geometry - properties - time OgcItemResponseDto: type: object properties: type: type: string title: type enum: - FeatureCollection timestamp: type: string title: timestamp format: date-time numberReturned: type: number title: numberReturned numberMatched: type: number title: numberMatched features: title: features type: array items: $ref: '#/components/schemas/OgcItemDto' required: - type - timestamp - numberReturned - numberMatched - features OgcItemAggregationLinkDto: type: object properties: type: type: string title: type rel: type: string title: rel title: type: string title: title href: type: string title: href required: - type - rel - title - href OgcItemAggregationResponseDto: type: object properties: timestamp: type: string title: timestamp format: date-time aggregations: type: object title: aggregations links: title: links type: array items: $ref: '#/components/schemas/OgcItemAggregationLinkDto' required: - timestamp - aggregations - links DiscussionSummary: type: object properties: text: type: string title: text description: The text of the discussion post summary numberMatched: type: number title: numberMatched description: The total number of discussion posts that matched the search criteria (up to 10000) numberConsidered: type: number title: numberConsidered description: The total number of matching discussion posts that were considered for summarization numberSummarized: type: number title: numberSummarized description: The total number of matching discussion posts that were successfully used for summarization numberErrored: type: number title: numberErrored description: The total number of matching discussion posts considered for summarization, but not included due to errors required: - text - numberMatched - numberConsidered - numberSummarized - numberErrored DiscussionSummaryLink: type: object properties: type: type: string title: type rel: type: string title: rel title: type: string title: title href: type: string title: href required: - type - rel - title - href DiscussionSummaryResponseDto: type: object properties: summary: title: summary allOf: - $ref: '#/components/schemas/DiscussionSummary' timestamp: type: string title: timestamp links: title: links type: array items: $ref: '#/components/schemas/DiscussionSummaryLink' required: - summary - timestamp - links OgcApiLandingPageLinkDto: type: object properties: rel: type: string description: relationship type: type: string description: link MIME type title: type: string description: link title href: type: string description: link uri required: - rel - type - title - href OgcApiLandingPageDto: type: object properties: title: type: string description: API title description: type: string description: API description item: description: OGC Record of underlying API Resource allOf: - $ref: '#/components/schemas/OgcItemDto' links: description: API links type: array items: $ref: '#/components/schemas/OgcApiLandingPageLinkDto' required: - title - description - links OgcApiConformancePageLinkDto: type: object properties: rel: type: string description: relationship type: type: string description: link MIME type title: type: string description: link title href: type: string description: link uri hreflang: type: string description: link uri required: - rel - type - title - href OgcApiConformancePageDto: type: object properties: conformsTo: description: Array of links to conformance specifications that API conforms to type: array items: type: string links: description: API links type: array items: $ref: '#/components/schemas/OgcApiConformancePageLinkDto' required: - conformsTo - links AuthInfoDto: type: object properties: isTokenBasedSecurity: type: boolean description: Indicates whether token-based security is enabled example: true tokenServicesUrl: type: string description: Token generation endpoint URL example: https://totoro-purple-qa-pre-hub.hubqa.arcgis.com/events/rest/generateToken required: - isTokenBasedSecurity - tokenServicesUrl RestInfoDto: type: object properties: currentVersion: type: number description: Current numeric version of the service example: 11.2 fullVersion: type: string description: Full service version string example: 11.2.0 authInfo: description: Authentication metadata for the service allOf: - $ref: '#/components/schemas/AuthInfoDto' required: - currentVersion - fullVersion - authInfo FeatureServerFormats: type: string enum: - json StatisticType: type: string enum: - count - sum - avg - var - max - min OutputStatistics: type: object properties: outStatisticFieldName: type: string description: The name of the statistic example: RegistrationAverage onStatisticField: type: string description: The layer attribute to calculate statistic on example: registrationCount statisticType: description: The type of statistic to calculate example: - count - sum - avg - var - max - min allOf: - $ref: '#/components/schemas/StatisticType' required: - outStatisticFieldName - onStatisticField - statisticType SpatialReferenceDto: type: object properties: latestVcsWkid: type: number latestWkid: type: number latestWkt: type: string vcsWkid: type: number wkid: type: number wkt: type: string FeatureServerExtentDto: type: object properties: spatialReference: description: Spatial reference for the extent allOf: - $ref: '#/components/schemas/SpatialReferenceDto' xmin: type: number xmax: type: number ymin: type: number ymax: type: number required: - spatialReference - xmin - xmax - ymin - ymax FeatureInfoDto: type: object properties: id: type: number name: type: string type: type: string parentLayerId: type: number defaultVisibility: type: boolean subLayerIds: nullable: true type: array items: type: number minScale: type: number maxScale: type: number geometryType: type: string required: - id - name - type - parentLayerId - defaultVisibility - minScale - maxScale - geometryType FeatureServerDto: type: object properties: currentVersion: type: number serviceDescription: type: string hasVersionedData: type: boolean supportsDisconnectedEditing: type: boolean hasStaticData: type: boolean hasSharedDomains: type: boolean maxRecordCount: type: number supportedQueryFormats: type: string supportsVCSProjection: type: boolean supportedExportFormats: type: string capabilities: type: string description: type: string copyrightText: type: string spatialReference: $ref: '#/components/schemas/SpatialReferenceDto' fullExtent: $ref: '#/components/schemas/FeatureServerExtentDto' initialExtent: $ref: '#/components/schemas/FeatureServerExtentDto' allowGeometryUpdates: type: boolean units: type: string supportsAppend: type: boolean supportsSharedDomains: type: boolean supportsWebHooks: type: boolean supportsTemporalLayers: type: boolean layerOverridesEnabled: type: boolean syncEnabled: type: boolean supportsApplyEditsWithGlobalIds: type: boolean supportsReturnDeleteResults: type: boolean supportsLayerOverrides: type: boolean supportsTilesAndBasicQueriesMode: type: boolean supportsQueryContingentValues: type: boolean supportedContingentValuesFormats: type: string supportsContingentValuesJson: type: object nullable: true tables: type: array items: $ref: '#/components/schemas/FeatureInfoDto' layers: type: array items: $ref: '#/components/schemas/FeatureInfoDto' relationships: type: array items: type: object supportsRelationshipsResource: type: boolean required: - currentVersion - serviceDescription - hasVersionedData - supportsDisconnectedEditing - hasStaticData - hasSharedDomains - maxRecordCount - supportedQueryFormats - supportsVCSProjection - supportedExportFormats - capabilities - description - copyrightText - spatialReference - fullExtent - initialExtent - allowGeometryUpdates - units - supportsAppend - supportsSharedDomains - supportsWebHooks - supportsTemporalLayers - layerOverridesEnabled - syncEnabled - supportsApplyEditsWithGlobalIds - supportsReturnDeleteResults - supportsLayerOverrides - supportsTilesAndBasicQueriesMode - supportsQueryContingentValues - supportedContingentValuesFormats - tables - layers - relationships - supportsRelationshipsResource FeatureLayerAdvancedQueryCapabilitiesDto: type: object properties: supportsPagination: type: boolean supportsQueryAttachmentsCountOnly: type: boolean supportsPaginationOnAggregatedQueries: type: boolean supportsQueryRelatedPagination: type: boolean supportsQueryWithDistance: type: boolean supportsReturningQueryExtent: type: boolean supportsStatistics: type: boolean supportsOrderBy: type: boolean supportsDistinct: type: boolean supportsQueryWithResultType: type: boolean supportsSqlExpression: type: boolean supportsAdvancedQueryRelated: type: boolean supportsCountDistinct: type: boolean supportsPercentileStatistics: type: boolean supportedSpatialAggregationStatistics: type: array items: type: string supportsLod: type: boolean supportsQueryWithLodSR: type: boolean supportedLodTypes: type: array items: type: string supportsReturningGeometryCentroid: type: boolean supportsReturningGeometryEnvelope: type: boolean supportsQueryWithDatumTransformation: type: boolean supportsCurrentUserQueries: type: boolean supportsHavingClause: type: boolean supportsOutFieldSQLExpression: type: boolean supportsMaxRecordCountFactor: type: boolean supportsTopFeaturesQuery: type: boolean supportsDisjointSpatialRel: type: boolean supportsQueryWithCacheHint: type: boolean supportedOperationsWithCacheHint: type: array items: type: string supportsQueryAnalytic: type: boolean supportsDefaultSR: type: boolean supportsFullTextSearch: type: boolean advancedQueryAnalyticCapabilities: type: object advancedEditingCapabilities: type: object required: - supportsPagination - supportsQueryAttachmentsCountOnly - supportsPaginationOnAggregatedQueries - supportsQueryRelatedPagination - supportsQueryWithDistance - supportsReturningQueryExtent - supportsStatistics - supportsOrderBy - supportsDistinct - supportsQueryWithResultType - supportsSqlExpression - supportsAdvancedQueryRelated - supportsCountDistinct - supportsPercentileStatistics - supportedSpatialAggregationStatistics - supportsLod - supportsQueryWithLodSR - supportedLodTypes - supportsReturningGeometryCentroid - supportsReturningGeometryEnvelope - supportsQueryWithDatumTransformation - supportsCurrentUserQueries - supportsHavingClause - supportsOutFieldSQLExpression - supportsMaxRecordCountFactor - supportsTopFeaturesQuery - supportsDisjointSpatialRel - supportsQueryWithCacheHint - supportedOperationsWithCacheHint - supportsQueryAnalytic - supportsDefaultSR - supportsFullTextSearch - advancedQueryAnalyticCapabilities - advancedEditingCapabilities FeatureLayerUniqueIdFieldDto: type: object properties: name: type: string isSystemMaintained: type: boolean required: - name - isSystemMaintained FeatureLayerDateFieldsTimeReferenceDto: type: object properties: timeZone: type: string respectsDaylightSaving: type: boolean required: - timeZone - respectsDaylightSaving FeatureLayerFieldDto: type: object properties: name: type: string type: type: string alias: type: string sqlType: type: string domain: type: object nullable: true defaultValue: type: object nullable: true length: type: number editable: type: boolean nullable: type: boolean required: - name - type - alias - sqlType - editable - nullable FeatureLayerIndexDto: type: object properties: name: type: string fields: type: string isAscending: type: boolean isUnique: type: boolean description: type: string indexType: type: string required: - name - fields - isAscending - isUnique - description - indexType FeatureLayerOwnershipBasedAccessControlForFeaturesDto: type: object properties: allowOthersToQuery: type: boolean required: - allowOthersToQuery FeatureLayerSymbolOutlineDto: type: object properties: color: type: array items: type: number width: type: number type: type: string style: type: string required: - color - width - type - style FeatureLayerSymbolDto: type: object properties: color: type: array items: type: number outline: $ref: '#/components/schemas/FeatureLayerSymbolOutlineDto' type: type: string style: type: string required: - color - outline - type - style FeatureLayerRendererDto: type: object properties: type: type: string symbol: $ref: '#/components/schemas/FeatureLayerSymbolDto' required: - type - symbol FeatureLayerDrawingInfoDto: type: object properties: renderer: $ref: '#/components/schemas/FeatureLayerRendererDto' labelingInfo: type: object nullable: true required: - renderer FeatureLayerDto: type: object properties: currentVersion: type: number id: type: number name: type: string type: type: string displayField: type: string description: type: string copyrightText: type: string defaultVisibility: type: boolean isDataVersioned: type: boolean hasContingentValuesDefinition: type: boolean supportsAppend: type: boolean supportsCalculate: type: boolean supportsASyncCalculate: type: boolean supportsTruncate: type: boolean supportsAttachmentsByUploadId: type: boolean supportsAttachmentsResizing: type: boolean supportsRollbackOnFailureParameter: type: boolean supportsStatistics: type: boolean supportsExceedsLimitStatistics: type: boolean supportsAdvancedQueries: type: boolean supportsValidateSql: type: boolean supportsLayerOverrides: type: boolean supportsTilesAndBasicQueriesMode: type: boolean supportsFieldDescriptionProperty: type: boolean supportsQuantizationEditMode: type: boolean supportsApplyEditsWithGlobalIds: type: boolean supportsReturningQueryGeometry: type: boolean supportedPbfFeatureEncodings: type: string advancedQueryCapabilities: $ref: '#/components/schemas/FeatureLayerAdvancedQueryCapabilitiesDto' useStandardizedQueries: type: boolean allowGeometryUpdates: type: boolean hasAttachments: type: boolean htmlPopupType: type: string hasM: type: boolean hasZ: type: boolean objectIdField: type: string uniqueIdField: $ref: '#/components/schemas/FeatureLayerUniqueIdFieldDto' globalIdField: type: string typeIdField: type: string dateFieldsTimeReference: $ref: '#/components/schemas/FeatureLayerDateFieldsTimeReferenceDto' preferredTimeReference: type: object nullable: true templates: type: array items: type: object supportedQueryFormats: type: string supportedAppendFormats: type: string supportedExportFormats: type: string supportedSpatialRelationships: type: array items: type: string supportedContingentValuesFormats: type: string hasStaticData: type: boolean maxRecordCount: type: number standardMaxRecordCount: type: number standardMaxRecordCountNoGeometry: type: number tileMaxRecordCount: type: number maxRecordCountFactor: type: number fields: type: array items: $ref: '#/components/schemas/FeatureLayerFieldDto' relationships: type: array items: type: object indexes: type: array items: $ref: '#/components/schemas/FeatureLayerIndexDto' capabilities: type: string ownershipBasedAccessControlForFeatures: $ref: '#/components/schemas/FeatureLayerOwnershipBasedAccessControlForFeaturesDto' types: type: array items: type: object timeInfo: type: object minScale: type: number maxScale: type: number drawingInfo: $ref: '#/components/schemas/FeatureLayerDrawingInfoDto' extent: $ref: '#/components/schemas/FeatureServerExtentDto' supportsCoordinatesQuantization: type: boolean hasLabels: type: boolean geometryType: type: string required: - currentVersion - id - name - type - displayField - description - copyrightText - defaultVisibility - isDataVersioned - hasContingentValuesDefinition - supportsAppend - supportsCalculate - supportsASyncCalculate - supportsTruncate - supportsAttachmentsByUploadId - supportsAttachmentsResizing - supportsRollbackOnFailureParameter - supportsStatistics - supportsExceedsLimitStatistics - supportsAdvancedQueries - supportsValidateSql - supportsLayerOverrides - supportsTilesAndBasicQueriesMode - supportsFieldDescriptionProperty - supportsQuantizationEditMode - supportsApplyEditsWithGlobalIds - supportsReturningQueryGeometry - supportedPbfFeatureEncodings - advancedQueryCapabilities - useStandardizedQueries - allowGeometryUpdates - hasAttachments - htmlPopupType - hasM - hasZ - objectIdField - uniqueIdField - globalIdField - typeIdField - dateFieldsTimeReference - templates - supportedQueryFormats - supportedAppendFormats - supportedExportFormats - supportedSpatialRelationships - supportedContingentValuesFormats - hasStaticData - maxRecordCount - standardMaxRecordCount - standardMaxRecordCountNoGeometry - tileMaxRecordCount - maxRecordCountFactor - fields - relationships - indexes - capabilities - ownershipBasedAccessControlForFeatures - types - timeInfo - minScale - maxScale - drawingInfo - extent - supportsCoordinatesQuantization - hasLabels - geometryType FeatureLayersDto: type: object properties: layers: type: array items: $ref: '#/components/schemas/FeatureLayerDto' tables: type: array items: $ref: '#/components/schemas/FeatureLayerDto' required: - layers - tables FeatureLayerQueryFeatureDto: type: object properties: attributes: type: object geometry: type: object nullable: true required: - attributes FeatureLayerQueryDto: type: object properties: objectIdFieldName: type: string uniqueIdField: $ref: '#/components/schemas/FeatureLayerUniqueIdFieldDto' globalIdFieldName: type: string hasZ: type: boolean hasM: type: boolean spatialReference: $ref: '#/components/schemas/SpatialReferenceDto' fields: type: array items: $ref: '#/components/schemas/FeatureLayerFieldDto' features: type: array items: $ref: '#/components/schemas/FeatureLayerQueryFeatureDto' exceededTransferLimit: type: boolean geometryType: type: string required: - objectIdFieldName - uniqueIdField - globalIdFieldName - hasZ - hasM - spatialReference - fields - features - exceededTransferLimit - geometryType