Catalogue guide - data.govt.nz

Using data.govt.nz APIs

Technical documentation and code examples for developer use with the data.govt.nz Application Programming Interfaces (APIs).
- About data.govt.nz APIs
  
  The metadata and many datasets on data.govt.nz are available for use via an Application Programming Interface (API). When using our API you need to know what you can and cannot do with the data and where to find technical documentation.
- Do's and dont's of using the data.govt.nz API
  
  Data.govt.nz's data APIs are made openly available for users and it's worth taking a moment to find out what you can and cannot do when using our APIs in your own applications.
- Accessing dataset metadata via API
  
  Data.govt.nz's datasets, organisations and groups can be accessed and queried as JSON date through the metadata API; this page describes how.
- Accessing machine readable data via API
  
  The data.govt.nz DataStore API allows you to access and query the rows and columns of raw data listed by agencies in machine readable CSV format via a JSON API endpoint.
- How to export all datasets from data.govt.nz into a CSV
  
  Using the ckanapi-exporter tool you can extract all dataset metadata into a single CSV file.
- How to export an agencies datasets as a data package
  
  Export an agencies datasets into sub-folders including any hosted or referenced data files and a json file with metadata.
Releasing data on data.govt.nz

Guidance and tutorials on using the data.govt.nz catalogue to publish open data listings. This includes a helpful checklist, general user help and specific 'how to' articles for New Zealand government agencies listing open datasets.
- Open data release checklist
  
  A draft checklist of the things you should consider before releasing open data.
- What is a publisher account and how do I apply?
  
  Government agencies can publish and update their datasets on the data.govt.nz catalogue by applying for a publisher account.
- Apply for a data.govt.nz publisher account
  
  Add government datasets to the listing on data.govt.nz.
- What metadata should I include with my dataset?
  
  Metadata describes your dataset to others in a standardised way. Having good quality metadata helps people discover and use your dataset. This guidance provides a description and examples of good practice metadata when releasing on data.govt.nz.
- Adding datasets to data.govt.nz
  
  Learn how to prepare a machine readable CSV file and publish to the data.govt.nz data catalogue.
- How do I add or update our Chief Executive expenses?
  
  Public Service Commission ask agencies to disclose their Departmental Secretary or Chief Executive Expenses at least annually. Data.govt.nz allows you to self-manage the update process to the CE Expenses datasets. This allows agencies to publish faster and meet the disclosure deadline.
- How to correctly enter your open licence in ArcGIS Online
  
  This walkthrough will help you correctly set up Creative Commons licences for your data layers in ArcGIS Online open data portal. Setting licences correctly here flows through to data.govt.nz when you make use of automated harvesting.
- How to respond to a data request
  
  Data.govt.nz allows people to request open data from agencies with a data request form. This guidance page helps agencies resolve data requests they receive by using the response features built into data.govt.nz.
- Automating dataset updates
  
  Data.govt.nz adopted an international data harvesting open standard (data.json) to automate agency dataset updates and additions. There are tools available to help generate the correct format and the open standard data schema is detailed with examples.
- Formats for open data
  
  Machine and human readable formats, such as PDF, CSV, and XLS, ensures that you maximise the value of your open data while complying with open government data and information policies.
- Qualities of a good open data API
  
  There are 15 key things you can do to ensure your data API is user-friendly.
- How do I set up two-factor authentication (2fa)?
  
  Following best practice guidance from CERT NZ, we have made Publisher accounts on data.govt.nz more secure by using two-factor authentication.
Step by step guides

Step by step guides to help you work through processes involved with managing and releasing data.
- Releasing open data on data.govt.nz
  
  Guide to reviewing and safely releasing open data for reuse.