Gemeente Amsterdam Grootstedelijke Projecten API

openapi: 3.2.0
info:
  title: Amsterdam Nl Grootstedelijke Projecten API
  version: 1.0.0
  contact:
    email: datapunt@amsterdam.nl
  license:
    name: ''
  termsOfService: https://data.amsterdam.nl/
  description: 'Operations tagged grootstedelijke_projecten across 2 of this provider''s published API definitions: amsterdam-nl-gebieden-openapi-original.json, amsterdam-nl-gebieden-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.data.amsterdam.nl/
security:
- oauth2: []
tags:
- name: grootstedelijke_projecten
paths:
  /grootstedelijke_projecten:
    get:
      operationId: gebieden_grootstedelijke_projecten_list
      parameters:
      - in: header
        name: Accept-Crs
        schema:
          type: string
        description: Accept-Crs header for Geo queries
      - in: header
        name: Content-Crs
        schema:
          type: string
        description: Content-Crs header for Geo queries
      - in: header
        name: X-Api-Key
        schema:
          type: string
        description: Api Key for statistical purposes, not for authentication
      - name: _count
        required: false
        in: query
        description: Include a count of the total result set and the number of pages.Only works for responses that return a page.
        schema:
          type: boolean
      - in: query
        name: _csv_header
        schema:
          type: string
          enum:
          - id
          - title
          - none
        description: Specify type of header for csv file
      - in: query
        name: _csv_separator
        schema:
          type: string
          enum:
          - ','
          - ;
        description: Specify type of separator for csv file
      - in: query
        name: _expand
        schema:
          type: boolean
        description: Allow to expand relations.
      - in: query
        name: _expandScope
        schema:
          type: string
        description: Comma separated list of named relations to expand.
      - in: query
        name: _fields
        schema:
          type: string
        description: Comma-separated list of fields to display
      - in: query
        name: _format
        schema:
          type: string
          enum:
          - json
          - csv
          - geojson
        description: Select the export format
      - name: _pageSize
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: _sort
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: datum
        in: query
        description: Exact; text
        schema:
          type: string
      - name: datum[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: datum[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: datum[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: datum[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: datum[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: geometrie
        in: query
        description: GeoJSON | GEOMETRY(...)
        schema:
          type: string
      - name: geometrie[contains]
        in: query
        description: Use x,y or POINT(x y)
        schema:
          type: string
      - name: geometrie[intersects]
        in: query
        description: Use WKT (POLYGON((x1 y1, x2 y2, ...))) or GeoJSON
        schema:
          type: string
      - name: geometrie[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: string
      - name: geometrie[not]
        in: query
        description: GeoJSON | GEOMETRY(...)
        schema:
          type: string
      - name: geometrie[within]
        in: query
        description: Use x,y,d or WKT POINT(x y),d
        schema:
          type: string
      - name: id
        in: query
        description: Exact; number
        schema:
          type: integer
      - name: id[gt]
        in: query
        description: Greater than; number
        schema:
          type: integer
      - name: id[gte]
        in: query
        description: Greater than or equal to; number
        schema:
          type: integer
      - name: id[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: integer
        explode: false
        style: form
      - name: id[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: id[lt]
        in: query
        description: Less than; number
        schema:
          type: integer
      - name: id[lte]
        in: query
        description: Less than or equal to; number
        schema:
          type: integer
      - name: id[not]
        in: query
        description: Exclude matches; number
        schema:
          type: array
          items:
            type: integer
      - name: legenda
        in: query
        description: Exact; text
        schema:
          type: string
      - name: legenda[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: legenda[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: legenda[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: legenda[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: legenda[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: naam
        in: query
        description: Exact; text
        schema:
          type: string
      - name: naam[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: naam[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: naam[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: naam[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: naam[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: type
        in: query
        description: Categorie GSP, OD, PHS of PHSOD
        schema:
          type: string
      - name: type[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: type[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: type[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: type[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: type[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: typering
        in: query
        description: Omschrijving type
        schema:
          type: string
      - name: typering[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: typering[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: typering[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: typering[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: typering[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: url
        in: query
        description: URL naar bekendmaking
        schema:
          type: string
          format: uri
      - name: url[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
            format: uri
        explode: false
        style: form
      - name: url[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: url[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: url[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: url[not]
        in: query
        description: Exclude matches; URL
        schema:
          type: array
          items:
            type: string
            format: uri
      tags:
      - grootstedelijke_projecten
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/PaginatedGebiedengrootstedelijke_projectenList'
            text/csv:
              schema:
                $ref: '#/components/schemas/PaginatedGebiedengrootstedelijke_projectenList'
            application/geo+json:
              schema:
                $ref: '#/components/schemas/PaginatedGebiedengrootstedelijke_projectenList'
          description: ''
      summary: Gebieden grootstedelijke projecten list
      x-summary-source: derived
    servers:
    - url: https://api.data.amsterdam.nl/
  /grootstedelijke_projecten/{id}:
    get:
      operationId: gebieden_grootstedelijke_projecten_retrieve
      parameters:
      - in: header
        name: Accept-Crs
        schema:
          type: string
        description: Accept-Crs header for Geo queries
      - in: header
        name: Content-Crs
        schema:
          type: string
        description: Content-Crs header for Geo queries
      - in: header
        name: X-Api-Key
        schema:
          type: string
        description: Api Key for statistical purposes, not for authentication
      - in: query
        name: _csv_header
        schema:
          type: string
          enum:
          - id
          - title
          - none
        description: Specify type of header for csv file
      - in: query
        name: _csv_separator
        schema:
          type: string
          enum:
          - ','
          - ;
        description: Specify type of separator for csv file
      - in: query
        name: _expand
        schema:
          type: boolean
        description: Allow to expand relations.
      - in: query
        name: _expandScope
        schema:
          type: string
        description: Comma separated list of named relations to expand.
      - in: query
        name: _fields
        schema:
          type: string
        description: Comma-separated list of fields to display
      - in: query
        name: _format
        schema:
          type: string
          enum:
          - json
          - csv
          - geojson
        description: Select the export format
      - name: _sort
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: datum
        in: query
        description: Exact; text
        schema:
          type: string
      - name: datum[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: datum[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: datum[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: datum[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: datum[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: geometrie
        in: query
        description: GeoJSON | GEOMETRY(...)
        schema:
          type: string
      - name: geometrie[contains]
        in: query
        description: Use x,y or POINT(x y)
        schema:
          type: string
      - name: geometrie[intersects]
        in: query
        description: Use WKT (POLYGON((x1 y1, x2 y2, ...))) or GeoJSON
        schema:
          type: string
      - name: geometrie[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: string
      - name: geometrie[not]
        in: query
        description: GeoJSON | GEOMETRY(...)
        schema:
          type: string
      - name: geometrie[within]
        in: query
        description: Use x,y,d or WKT POINT(x y),d
        schema:
          type: string
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[^/]+$
        required: true
      - name: id
        in: query
        description: Exact; number
        schema:
          type: integer
      - name: id[gt]
        in: query
        description: Greater than; number
        schema:
          type: integer
      - name: id[gte]
        in: query
        description: Greater than or equal to; number
        schema:
          type: integer
      - name: id[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: integer
        explode: false
        style: form
      - name: id[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: id[lt]
        in: query
        description: Less than; number
        schema:
          type: integer
      - name: id[lte]
        in: query
        description: Less than or equal to; number
        schema:
          type: integer
      - name: id[not]
        in: query
        description: Exclude matches; number
        schema:
          type: array
          items:
            type: integer
      - name: legenda
        in: query
        description: Exact; text
        schema:
          type: string
      - name: legenda[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: legenda[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: legenda[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: legenda[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: legenda[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: naam
        in: query
        description: Exact; text
        schema:
          type: string
      - name: naam[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: naam[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: naam[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: naam[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: naam[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: type
        in: query
        description: Categorie GSP, OD, PHS of PHSOD
        schema:
          type: string
      - name: type[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: type[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: type[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: type[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: type[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: typering
        in: query
        description: Omschrijving type
        schema:
          type: string
      - name: typering[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
        explode: false
        style: form
      - name: typering[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: typering[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: typering[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: typering[not]
        in: query
        description: Exclude matches; text
        schema:
          type: array
          items:
            type: string
      - name: url
        in: query
        description: URL naar bekendmaking
        schema:
          type: string
          format: uri
      - name: url[in]
        in: query
        description: 'Matches any value from a comma-separated list: val1,val2,valN.'
        schema:
          type: array
          items:
            type: string
            format: uri
        explode: false
        style: form
      - name: url[isempty]
        in: query
        description: Whether the field is empty or not.
        schema:
          type: boolean
      - name: url[isnull]
        in: query
        description: Whether the field has a NULL value or not.
        schema:
          type: boolean
      - name: url[like]
        in: query
        description: Matches text using wildcards (? and *).
        schema:
          type: string
      - name: url[not]
        in: query
        description: Exclude matches; URL
        schema:
          type: array
          items:
            type: string
            format: uri
      tags:
      - grootstedelijke_projecten
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/Gebiedengrootstedelijke_projecten'
            text/csv:
              schema:
                $ref: '#/components/schemas/Gebiedengrootstedelijke_projecten'
            application/geo+json:
              schema:
                $ref: '#/components/schemas/Gebiedengrootstedelijke_projecten'
          description: ''
      summary: Gebieden grootstedelijke projecten retrieve
      x-summary-source: derived
    servers:
    - url: https://api.data.amsterdam.nl/
components:
  schemas:
    GebiedendefaultGrootstedelijkeProjectenLinks:
      type: object
      description: The contents of the `grootstedelijkeProjecten._links` field. It contains all relationships with objects.
      properties:
        schema:
          type: string
          format: uri
          description: The schema field is exposed with every record
          readOnly: true
        self:
          $ref: '#/components/schemas/Gebiedengrootstedelijke_projectenLink'
      required:
      - schema
      - self
    Point3D:
      type: array
      description: Point in 3D space
      minItems: 2
      maxItems: 3
      items:
        type: number
    Gebiedengrootstedelijke_projecten:
      type: object
      description: grootstedelijkeProjecten
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/GebiedendefaultGrootstedelijkeProjectenLinks'
          title: ' links'
        id:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
        geometrie:
          $ref: '#/components/schemas/MultiPolygon'
        naam:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
          description: Categorie GSP, OD, PHS of PHSOD
        url:
          type:
          - string
          - 'null'
          format: uri
          description: URL naar bekendmaking
          maxLength: 200
        typering:
          type:
          - string
          - 'null'
          description: Omschrijving type
        datum:
          type:
          - string
          - 'null'
        legenda:
          type:
          - string
          - 'null'
      required:
      - _links
      - geometrie
      - id
    Geometry:
      type: object
      description: GeoJSON geometry
      discriminator:
        propertyName: type
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - Point
          - LineString
          - Polygon
          - MultiPoint
          - MultiLineString
          - MultiPolygon
          description: the geometry type
        coordinates:
          type: array
          minItems: 2
          description: Based on the geometry type, a point or collection of points.
          items:
            type: number
    Gebiedengrootstedelijke_projectenLink:
      type: object
      description: The identifier of the relationship to grootstedelijkeProjecten.
      properties:
        href:
          type: string
          format: uri
          readOnly: true
        title:
          type: string
        id:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
      required:
      - href
      - id
      - title
    PaginatedGebiedengrootstedelijke_projectenList:
      type: object
      properties:
        page:
          type: object
          properties:
            number:
              type: integer
              example: 3
            size:
              type: integer
              example: 20
            totalElements:
              type: integer
              example: 5
            totalPages:
              type: integer
              example: 3
        _links:
          type: object
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  format: uri
                  example: https://api.data.amsterdam.nl/v1/.../resource/?page=3
            next:
              type: object
              properties:
                href:
                  type:
                  - string
                  - 'null'
                  format: uri
                  example: https://api.data.amsterdam.nl/v1/.../resource/?page=4
            previous:
              type: object
              properties:
                href:
                  type:
                  - string
                  - 'null'
                  format: uri
                  example: https://api.data.amsterdam.nl/v1/.../resource/?page=2
        _embedded:
          type: object
          properties:
            grootstedelijke_projecten:
              type: array
              items:
                $ref: '#/components/schemas/Gebiedengrootstedelijke_projecten'
    MultiPolygon:
      type: object
      description: GeoJSON geometry
      allOf:
      - $ref: '#/components/schemas/Geometry'
      - properties:
          type:
            type: string
            enum:
            - MultiPolygon
          coordinates:
            type: array
            items:
              type: array
              items:
                type: array
                items:
                  $ref: '#/components/schemas/Point3D'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://iam.amsterdam.nl/auth/realms/datapunt-ad/protocol/openid-connect/auth
          scopes: {}
externalDocs:
  description: API Usage Documentation
  url: https://api.data.amsterdam.nl/v1/docs/datasets/gebieden.html
x-refined-from:
- amsterdam-nl-gebieden-openapi-original.json
- amsterdam-nl-gebieden-openapi.yml
x-versions:
  default:
    url: https://api.data.amsterdam.nl/v1/afvalwijzer
    status: stable
    endSupportDate: null
    statusDescription: stabiel
    default: true
    paths:
      afvalwijzer: stable
      acc_afvalwijzer: stable
    pathsUnderDevelopment: false
  v1:
    url: https://api.data.amsterdam.nl/v1/afvalwijzer/v1
    status: stable
    endSupportDate: null
    statusDescription: stabiel
    default: true
    paths:
      afvalwijzer: stable
      acc_afvalwijzer: stable
    pathsUnderDevelopment: false
    pathsDeprecated: false
    pathsDiscontinued: false