list_arcgis_datasource_items¶

DatasourcesApi.list_arcgis_datasource_items(datasource_id, ingestion_type, item_type, role_id, content_type=None, action=None, target_location=None, title=None, offset=None, limit=None, datasource_advanced_filters=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

List ArcGIS items for ingestion

ArcGIS only. With action=getItems, returns a page of items for the given ingestionType and itemType. Caller needs editor access (else AUTH-1012). Non-arcgis types return 200 with a not-supported Message. Pagination: offset defaults to 0, limit defaults to 100 (max 100); last page when next_available is false.

Parameters:

datasource_id (str) – UUID of the datasource. Rejected with IPV-1045 if missing or unknown. (required)
ingestion_type (str) – metadata-and-data requires targetLocation. Rejected with IPV-1001 when missing. (required)
item_type (str) – ArcGIS item type or AllItems. Rejected with IPV-1001 when invalid. Feature Service + metadata-and-data includes Layers. (required)
role_id (str) – Amorphic role ID. Must grant editor access on the datasource. (required)
content_type (str) – Must be application/json when sending a body.
action (str) – Only getItems is handled for arcgis. Missing or other values leave the response unset (500).
target_location (str) – Required when ingestionType is metadata-and-data. Must be one of s3, s3athena, redshift, lf (else IPV-1001).
title (str) – Exact title filter applied to the ArcGIS search query. Takes precedence over title in AdvancedFilters.
offset (str) – 0-based page offset. Default 0. Must be >= 0 (else IPV-1001). Last page when response next_available is false.
limit (str) – Page size. Default 100. Must be an integer from 1 to 100 (else IPV-1001).
datasource_advanced_filters (DatasourceAdvancedFilters)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DatasourceOperationsPutResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: PUT /datasources/{datasource_id}/operations

Request¶

The request body is optional.

Request / response example

{
  "AdvancedFilters": "W3siSXRlbVR5cGUiOiJGZWF0dXJlIFNlcnZpY2UiLCJGaWx0ZXJzIjp7InRpdGxlIjoiLipleGFtcGxlLip9fV0="
}

Success (HTTP 200)¶

ArcGIS getItems page, or Message when the datasource type is not arcgis.

Paginated ArcGIS items

{
  "ItemType": "Feature Service",
  "Items": [
    {
      "Id": "8a906fdd276f4de8bc3f84409ab04cb5",
      "Title": "City parcels",
      "Description": "Parcel boundaries",
      "Layers": [
        {
          "id": 0,
          "name": "Parcels"
        }
      ]
    }
  ],
  "next_available": false,
  "count": 1,
  "total_count": 1
}

Non-arcgis datasource

{
  "Message": "This operation is not supported for jdbc datasource type"
}

Errors¶

Documented error codes: AUTH-1012, IPV-1045, IPV-1001, GE-1034.

HTTP 400

Validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Common codes: AUTH-1012 (no editor access), IPV-1045 (unknown datasource), IPV-1001 (missing/invalid ingestionType, itemType, targetLocation, offset, limit, or AdvancedFilters).

Missing ingestionType or itemType

{
  "Message": "IPV-1001 - ingestionType and itemType query parameters are required"
}

Invalid targetLocation

{
  "Message": "IPV-1001 - targetLocation must be one of: ['s3', 's3athena', 'redshift', 'lf']"
}

AdvancedFilters not base64

{
  "Message": "IPV-1001 - AdvancedFilters must be base64 encoded"
}

HTTP 500

Backend failure (for example GE-1034 from ArcGIS search) or unbound response when action is missing/not getItems on an arcgis datasource.

ArcGIS search failed

{
  "Message": "GE-1034 - Failed to get items from ArcGIS"
}