API routes (Click a route to expand it, click here to expand/collapse all)
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
GET/auth/login ⎘Authentication required
Log-in to Brainbay-Connection.
Parameter Location Type Requirements Optional Default value Description
redirect_uri URI-Query string No The redirect URI is the callback entry point.
state URI-Query string Yes null The state which was sent with the request for Login to Brainbay.
Response HTTP Type Description
Success 200 string Returns the URL to the log-in portal of Brainbay.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('brainbay:agri' OR 'brainbay:comm' OR 'brainbay:resi' OR 'brainbay:*') ⎘
GET/authorize ⎘Authentication required
Shows your logged in status and to which parts you have access in Brainbay.
Response HTTP Type Description
Success 200 {loggedIn:boolean, permissions?: string[]} Permissions can contain the following values: "brainbay:agri", "brainbay:comm", "brainbay:resi", it is the intersection of the permissions on KATEv2 and what your user has on Brainbay
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('brainbay:agri' OR 'brainbay:comm' OR 'brainbay:resi') ⎘
GET/compview/setup ⎘Authentication required
Obtain Brainbay filters for within your category.
Parameter Location Type Requirements Optional Default value Description
category URI-Query string
enum: [ "agri", "comm", "resi" ]
 No The category you want to search in.
Response HTTP Type Description
Success 200 Filter[] Filters that you can utilize based on the category.
ExternalServiceUnauthorizedException 401 You are not authorized by Brainbay for this.
ConfigurationException 500 Invalid microservice configuration. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('brainbay:agri' OR 'brainbay:comm' OR 'brainbay:resi') ⎘
GET/dataset/byId/{objectGuid} ⎘Authentication required
Look up a Brainbay object within your category.
Parameter Location Type Requirements Optional Default value Description
category URI-Query string
enum: [ "agri", "comm", "resi" ]
 No The category you want to search in.
objectGuid URI-Path string No The ObjectGuid from said object
Response HTTP Type Description
Success 200 Object The object you requested, converted to format that is a subset of a REDSet.
ExternalServiceUnauthorizedException 401 You are not authorized by Brainbay for this.
ConfigurationException 500 Invalid microservice configuration. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('brainbay:agri' OR 'brainbay:comm' OR 'brainbay:resi') ⎘
GET/v1/{sector}/filters ⎘Authentication required
Obtain Brainbay filters for within your sector.
Parameter Location Type Requirements Optional Default value Description
sector URI-Path string
enum: [ "agriculture", "business", "residential" ]
 No The sector you want to search in.
Response HTTP Type Description
Success 200 Filter[] Filters that you can utilize based on the sector.
ExternalServiceUnauthorizedException 401 You are not authorized by Brainbay for this.
ConfigurationException 500 Invalid microservice configuration. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
brainbay:* ⎘
POST/auth/logout ⎘Authentication required
Log out of Brainbay-Connection.
Response HTTP Type Description
Success 200 true Confirmation that you have logged out.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('brainbay:agri' OR 'brainbay:comm' OR 'brainbay:resi' OR 'brainbay:*') ⎘
POST/compview/search/map/{category} ⎘Authentication required
Search Brainbay within your category.
Parameter Location Type Requirements Optional Default value Description
category URI-Path string
enum: [ "agri", "comm", "resi" ]
 No The category you want to search in.
geoBoxCoordinates POST-body string
format: json
 No Specify the GeoBox coordinates for the bottom-left and top-right corners. The order of coordinates for each corner is first longitude then latitude as floats. Example: [[5.01, 52.31],[5.45, 51.95]].
zoomLevel POST-body int
minimum: 1
maximum: 20
 Yes 8 The current map zoom level. Used to dynamically adjust clustering precision. For example a low `zoomLevel` results in more but smaller clusters, while a larger value in less broader clusters
filters POST-body string
format: json
 No The filters you want to apply.
Response HTTP Type Description
Success 200 array Result of your search.
ExternalServiceUnauthorizedException 401 You are not authorized by Brainbay for this.
InvalidFilterException 400 The provided filter is invalid, please use one that is supplied by the endpoint for filters.
ConfigurationException 500 Invalid microservice configuration. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('brainbay:agri' OR 'brainbay:comm' OR 'brainbay:resi') ⎘
POST/v1/{sector}/lookup/{objectGuid} ⎘Authentication required
Look up a Brainbay object within your sector.
Parameter Location Type Requirements Optional Default value Description
sector URI-Path string
enum: [ "agriculture", "business", "residential" ]
 No The sector you want to retrieve in.
objectGuid URI-Path string No The ObjectGuid from said object
Response HTTP Type Description
Success 200 array Result of your search, array of Brainbay Objects enriched with coordinates.
ExternalServiceUnauthorizedException 401 You are not authorized by Brainbay for this.
ConfigurationException 500 Invalid microservice configuration. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
brainbay:* ⎘
POST/v1/{sector}/search ⎘Authentication required
Search Brainbay within your sector.
Parameter Location Type Requirements Optional Default value Description
sector URI-Path string
enum: [ "agriculture", "business", "residential" ]
 No The sector you want to search in.
filters POST-body string
format: json
 No The filters you want to apply.
raw POST-body bool Yes false Do not optimize/clean the output format, give the unmapped output of brainbay
Response HTTP Type Description
Success 200 array Result of your search.
ExternalServiceUnauthorizedException 401 You are not authorized by Brainbay for this.
InvalidFilterException 400 The provided filter is invalid, please use one that is supplied by the endpoint for filters.
ConfigurationException 500 Invalid microservice configuration. See details for details.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
brainbay:* ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error