Returns a list of all the sources available to you.

To create a source, post to this view.

Parameters

• type: string (required). The type of source to create. Example: info. Choices: info upload cifs arcgis wfs postgres
• name: string (required). The name of the new source.
• group: string|id(optional)
• user: string|id (optional). The group or user (at least one required) that owns the source, by ID or API URL.
• url_remote: string (optional). The remote URL to the source, not required for info or uploadsources
• options: object (optional). Refer to the source specific notes above.
• scan_schedule: string (optional). A Cron expression specifying how frequently the source should be scanned. All normal cron values are supported but the ‘minutes’ value is currently ignored. Predefined scheduling definitions are supported except for "@reboot".

Returns details of a source.

Returns a list of scans for a source.

Notable fields:

status : The current status of this scan. Valid values are:

running completed cancelled error change_counts : counts of datasources deleted, updated and added in this scan. This is only guaranteed to be present in completed scans. For other scans it may be null or the counts may all be 0. tags:

• Data Sources security:
• SessionAuthentication: []
• HeaderTokenAuthentication: [] operationId: getSourceScans responses: '200': description: OK content: application/json: schema: $ref: '#/schemas/SourceScans'

Starts a scan for this source. No post data is required.

Information about a particular scan. This is the same as an item in the list view above, except it also includes a progress indicator, which is a float between 0 and 1. Progress is approximate.

Cancels an in-progress scan.

Gets a log for a scan. By default this is returned as text/plain, but you can request JSON via the Accept header.

Lists datasources for this source.

The API for datasources is read-only. Datasources are updated by scanning your source. If you don't see what you expect here, check that your source has been scanned recently.

Detailed information for a given datasource. Includes all the info shown in the list above, as well as much more information describing the datasource.

Field notes

• type is the source type, not to be confused with data_type, format or geometry_type

• data_type refers to the broad type of data. Different types of data require significantly different handling. Current data types are:

  • table
  • vector
  • raster
  • grid
  • attribute-grid

• format is a string describing the media type of this datasource.

• geometry_type describes the type of geometry in vector datasources. It is null for non-vector datasources. Possible values are:

• point

• linestring

• polygon

• multipoint

• multilinestring

• multipolygon

• Spatial datasources may or may not have a known Coordinate Reference System (crs).

• extent is a GeoJSON geometry. It may be null for aspatial datasources. The coordinate system for this geometry is the same as that in the crs field, which may not be known.

• For vector and table datasources, fields is a list of JSON objects. It will be null for other datasources.

Some datasources can have attached XML metadata. This is attached by the CIFS and Upload scanners, if a datasource has an .xml file with the same basename. For example:

my-points-with-metadata.geojson my-points-with-metadata.xml As with sources, datasource XML must be in one of these three formats:

• ISO 19115/19139
• FGDC CSDGM
• Dublin Core

Response Body

<dc xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/">
  <title></title>
  <creator>Bob Jones and Associates</creator>
  <subject>hydro</subject>
  <description>Some nice colourful aerial photos of the Auckland Harbour.</description>
  <date>2013-01-01</date>
  <type>raster</type>
  <language>eng</language>
</dc>

The Export Validation endpoint accepts the same content as the Export Creation API but will not create/start the export and will return additional information.

Error Codes

The following errors are returned as part of a 400 response when the validation request itself fails. The paths below indicate where the error will be found in the nested respone, for example:

  {
    "error_code": 400,
    "errors": {
      "items": [
        `no-items: You must request at least one item`
      ]
    }
  }

• errors
  • items
    • no-items: You must request at least one item \
    • duplicate-items: Duplicate items were requested
    • [index]
      • item
        • Invalid hyperlink - No URL match.
  • crs
    • Invalid CRS
    • Unknown CRS
• formats
  • No format was selected for layers of type '{kind}'

The following error codes are returned as part of a 200 response which will include other information about the Export validation.

• invalid_reasons

  • kml-invalid-crs
  • missing-crs
  • no-layers
  • over-size-limit:max-{overall-size-limit}
  • under-sized-courier-export:min-{overall-size-limit}
  • over-size-limit:{mime-type}:max-{format-size-limit}
  • missing-shipping_address-field:{field_name}

• items

  • [index]
    • invalid_reasons
      • commercial-data-not-supported
      • outside-extent
      • online-only
      • invalid-for-given-crs

Get the groups configured for this site.

Returns a list of permissions granted to users within this group.

Allows the caller to make multiple changes to the group permissions. Each action in the list has one of three action types that can be performed:

• create - add a new permission for a user to this group
• update - modify the permissions for an existing permission
• delete - delete a permission that currently exists

The update and delete operations require the url to the permission as returned in the GET request to this endpoint. The value object specifies the user (by ID) and the permission to grant.

Fetches an existing access request to the group for the currently authenticated user.

Submit an access request to the group for the currently authenticated user.

Revokes the access request for the currently authenticated user.

Fetches all outstanding access requests for the group.

Fetches an access requests for the group.

Declines a users request to access the group. This will notify the requesting user that the request has been declined.

Approves a request to access the group. The user will be notified that the request has been approved.

List layers (at layers/) and tables (at tables/) respectively. List views follow the Catalog API semantics.

All fields except name and data.datasources are optional.