{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.2",
    "title": "Zoeken naar subactiviteiten, toonbare_activiteiten en werkzaamheden (beta)",
    "description": "Een 'beta' versie van de REST-API voor het zoeken naar subactiviteiten, toonbare_activiteiten en werkzaamheden (toonbare_activiteiten zijn de juridische activiteiten waarvoor vragenbomen beschikbaar zijn). De REST-API voor de onderstaande endpoints maakt gebruik van de Elasticsearch Search API welke beschreven staat in: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html",
    "contact": {
      "name": "Ontwikkelaarsportaal Omgevingswet",
      "url": "https://developer.omgevingswet.overheid.nl/services/contact/"
    }
  },
  "paths": {
    "/subactiviteiten/_search": {
      "get": {
        "summary": "Zoeken in subactiviteiten",
        "tags": [
          "Zoeken in subactiviteiten"
        ],
        "description": "Het request wordt in de body van de de get request meegestuurd. Deze request/response staat beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html De request retourneert de subactiviteiten die voldoen aan de meegegeven query",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "description": "De lijst van subactiviteiten die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Zoeken in subactiviteiten",
        "tags": [
          "Zoeken in subactiviteiten"
        ],
        "description": "De request retourneert de subactiviteiten die voldoen aan de meegegeven query",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "De body van de request bevat de search query als beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html",
                "type": "object"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "De lijst van subactiviteiten die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/subactiviteiten": {
      "get": {
        "summary": "Definitie van de subactiviteiten index",
        "tags": [
          "Index definities"
        ],
        "description": "Haalt informatie op over de actieve subactiviteiten index (settings, mappings, aliasses).",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/200"
          }
        }
      }
    },
    "/toonbare_activiteiten/_search": {
      "get": {
        "summary": "Zoeken in toonbare_activiteiten",
        "tags": [
          "Zoeken in toonbare_activiteiten"
        ],
        "description": "Het request wordt in de body van de de get request meegestuurd. Deze request/response staat beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html De request retourneert de toonbare_activiteiten die voldoen aan de meegegeven query",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "description": "De lijst van toonbare_activiteiten die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Zoeken in toonbare_activiteiten",
        "tags": [
          "Zoeken in toonbare_activiteiten"
        ],
        "description": "De request retourneert de toonbare_activiteiten die voldoen aan de meegegeven query",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "De body van de request bevat de search query als beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html",
                "type": "object"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "De lijst van toonbare_activiteiten die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/toonbare_activiteiten": {
      "get": {
        "summary": "Definitie van de toonbare_activiteiten index",
        "tags": [
          "Index definities"
        ],
        "description": "Haalt informatie op over de actieve toonbare_activiteiten index (settings, mappings, aliasses)",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/200"
          }
        }
      }
    },
    "/toonbare_en_subactiviteiten/_search": {
      "get": {
        "summary": "Zoeken in toonbare_en_subactiviteiten (aggregratie van subactiviteiten en toonbare_activiteiten)",
        "tags": [
          "Zoeken in toonbare_en_subactiviteiten"
        ],
        "description": "Het request wordt in de body van de de get request meegestuurd. Deze request/response staat beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html De request retourneert de subactiviteiten en toonbare_activiteiten die voldoen aan de meegegeven query",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "description": "De lijst van subactiviteiten en toonbare_activiteiten die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Zoeken in toonbare_en_subactiviteiten (aggregratie van subactiviteiten en toonbare_activiteiten)",
        "tags": [
          "Zoeken in toonbare_en_subactiviteiten"
        ],
        "description": "De request retourneert de subactiviteiten en toonbare_activiteiten die voldoen aan de meegegeven query.",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "De body van de request bevat de search query als beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html",
                "type": "object"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "De lijst van subactiviteiten en toonbare_activiteiten die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/toonbare_en_subactiviteiten": {
      "get": {
        "summary": "Definities van de toonbare_activiteiten en subactiviteiten index",
        "tags": [
          "Index definities"
        ],
        "description": "Haalt informatie op over de actieve toonbare_activiteiten index en de subactiviteiten index (settings, mappings, aliasses).  Omdat toonbare_en_subactiviteiten een alias is die naar twee indices verwijst, bevat het antwoord de details van beide indices.",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/200"
          }
        }
      }
    },
    "/werkzaamheden/_search": {
      "get": {
        "summary": "Zoeken in werkzaamheden",
        "tags": [
          "Zoeken in werkzaamheden"
        ],
        "description": "Het request wordt in de body van de de get request meegestuurd. Deze request/response staat beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html De request retourneert de werkzaamheden die voldoen aan de meegegeven query",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "description": "De lijst van werkzaamheden die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Zoeken in werkzaamheden",
        "tags": [
          "Zoeken in werkzaamheden"
        ],
        "description": "De request retourneerd de werkzaamheden die voldoen aan de meegegeven query",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "description": "De body van de request bevat de search query als beschreven in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html",
                "type": "object"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "De lijst van werkzaamheden die voldoen aan de meegegeven query",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/werkzaamheden": {
      "get": {
        "summary": "Definitie van de werkzaamheden index",
        "tags": [
          "Index definities"
        ],
        "description": "Haalt informatie op over de actieve werkzaamheden index (settings, mappings, aliasses)",
        "parameters": [
          {
            "$ref": "#/components/parameters/x_api_key"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/200"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "x_api_key": {
        "name": "x-api-key",
        "in": "header",
        "description": "De api-key ter authenticatie, verkrijgbaar via het ontwikkelaarsportaal",
        "required": false,
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "200": {
        "description": "Definitie van de actieve index waar de alias naar verwijst De elasticsearch operatie staat beschreven op https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object"
            }
          }
        }
      }
    }
  },
  "x-wso2-cors": {
    "accessControlAllowOrigins": [
      "*"
    ],
    "corsConfigurationEnabled": true,
    "accessControlAllowCredentials": false,
    "accessControlAllowMethods": [
      "GET",
      "POST"
    ],
    "accessControlAllowHeaders": [
      "authorization",
      "Access-Control-Allow-Origin",
      "Content-Type",
      "SOAPAction"
    ]
  }
}