API docs by Redocly

BeLifeline Server API (v0.7.5)

Download OpenAPI specification:Download

Server

Status_get

Responses

Response samples

Content type
application/json
"string"

Koyo

Get a list of koyos' basic information

query Parameters
limit
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update information on own koyo

Authorizations:
ApiKeyAuth
path Parameters
koyo_id
required
string (Koyo.koyoId) ^[a-z_-]{1,64}$
Request Body schema: application/json
required
koyo_id
required
string (Koyo ID generated by the admin api) ^[a-z_-]{1,64}$

This ID can be obtained through admin api. It is a human friendly format like GitHub repository names. Only the pattern ^[a-z_-]{1,64}$ is allowed.

koyo_name
required
string (Koyo name) [ 1 .. 64 ] characters
koyo_description
required
string (Koyo description) <= 2048 characters
need_external
required
Array of strings (ExtInfo.ExtInfoId)
Items Value: "example_id"
required
object (param name: param default)

Koyo parameters. The key is the parameter name and the value is the default value.

koyo_scales
required
Array of numbers <float> (Koyo scales is resolution (e.g. one data per meter)) [ items <float > ]

Koyo scales is resolution (e.g. one data per meter). Returns a list of supported scales.

koyo_data_ids
required
Array of strings <uuid> (Koyo data IDs) [ items <uuid > ]
version
required
string (Koyo version) ^\d+\.\d+\.\d+$

Semantic versioning

license
required
string (Koyo license)
ext_licenses
required
Array of strings (Koyo source license for use)

Licenses for primary information and other information used by the koyo.

Responses

Request samples

Content type
application/json
{
  • "koyo_id": "string",
  • "koyo_name": "string",
  • "koyo_description": "string",
  • "need_external": [
    ],
  • "koyo_params": {
    },
  • "koyo_scales": [
    ],
  • "koyo_data_ids": [
    ],
  • "version": "string",
  • "license": "string",
  • "ext_licenses": [
    ]
}

Response samples

Content type
application/json
{
  • "koyo_id": "string",
  • "koyo_name": "string",
  • "koyo_description": "string",
  • "need_external": [
    ],
  • "koyo_params": {
    },
  • "koyo_scales": [
    ],
  • "koyo_data_ids": [
    ],
  • "version": "string",
  • "license": "string",
  • "ext_licenses": [
    ],
  • "first_entry_at": "2019-08-24T14:15:22Z",
  • "last_entry_at": "2019-08-24T14:15:22Z",
  • "last_updated_at": "2019-08-24T14:15:22Z"
}

Get koyos' basic information

path Parameters
koyo_id
required
string (Koyo.koyoId) ^[a-z_-]{1,64}$

Responses

Response samples

Content type
application/json
{
  • "koyo_id": "string",
  • "koyo_name": "string",
  • "koyo_description": "string",
  • "need_external": [
    ],
  • "koyo_params": {
    },
  • "koyo_scales": [
    ],
  • "koyo_data_ids": [
    ],
  • "version": "string",
  • "license": "string",
  • "ext_licenses": [
    ],
  • "first_entry_at": "2019-08-24T14:15:22Z",
  • "last_entry_at": "2019-08-24T14:15:22Z",
  • "last_updated_at": "2019-08-24T14:15:22Z"
}

Post new data of own koyo

Authorizations:
ApiKeyAuth
path Parameters
koyo_id
required
string (Koyo.koyoId) ^[a-z_-]{1,64}$
Request Body schema: application/json
required
version
required
string (Koyo version) ^\d+\.\d+\.\d+$

The version of the koyo used to generate the data.

koyo_scale
required
number <float> (Koyo scale)

The resolution of the data.

content_type
required
string (Data type)
Enum: "image" "csv" "json"

The type of data format.(enum: image, csv, json...)

content
required
string <byte> (Data content)

The data content itself.

Responses

Request samples

Content type
application/json
{
  • "version": "string",
  • "koyo_scale": 0.1,
  • "content_type": "image",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "koyo_data_id": "00a87f2c-0135-46d7-8900-d5f74d5468eb",
  • "koyo_id": "string",
  • "version": "string",
  • "koyo_scale": 0.1,
  • "content_type": "image",
  • "content": "string",
  • "entry_at": "2019-08-24T14:15:22Z",
  • "target_at": "2019-08-24T14:15:22Z"
}

External Information

ExtInfo_list

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get example data endpoint

Authorizations:
ApiKeyAuth
query Parameters
object (Types.GeoJSON.MultiPolygon)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post example data endpoint

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
Array
required
object (Types.GeoJSON.MultiPolygon)
image
required
string <byte>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

ExtInfo_get

Authorizations:
ApiKeyAuth
path Parameters
extinfo_id
required
string (ExtInfo.ExtInfoId)
Value: "example_id"

Responses

Response samples

Content type
application/json
{
  • "external_id": "example_id",
  • "external_name": "string",
  • "external_description": "string",
  • "license": "string",
  • "license_description": "string",
  • "first_entry_at": "2019-08-24T14:15:22Z",
  • "last_updated_at": "2019-08-24T14:15:22Z",
  • "updated_history": [
    ]
}

Provider

List of koyo's basic information

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get data from the koyo

Authorizations:
ApiKeyAuth
path Parameters
altorithm_id
required
string (Koyo.koyoId) ^[a-z_-]{1,64}$
query Parameters
type
required
string (Provider.RequestType)
Enum: "TileMapService" "GeoJSON"
koyo_data_id
string <uuid> (Koyo.koyoDataId)
object (Types.GeoJSON.MultiPolygon)
object (Types.Date.DateUntil)
object (Types.Date.DateUntil)
object
scale
number <float> (Koyo.koyoScale)

Responses

Response samples

Content type
application/json
{
  • "koyo_data_id": "00a87f2c-0135-46d7-8900-d5f74d5468eb",
  • "koyo_id": "string",
  • "version": "string",
  • "koyo_scale": 0.1,
  • "content_type": "image",
  • "content": "string",
  • "entry_at": "2019-08-24T14:15:22Z",
  • "target_at": "2019-08-24T14:15:22Z"
}

Admin

Client_create

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
username
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
  • "username": "string",
  • "api_key": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z",
  • "last_updated_at": "2019-08-24T14:15:22Z"
}

Client_list

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Client_delete

Authorizations:
ApiKeyAuth
path Parameters
client_id
required
string <uuid> (Provider.clientId)

Responses

Response samples

Content type
application/json
{
  • "delete_client_id": "0039699a-32b9-497c-85be-d8da489c441f"
}

Client_revoke

Authorizations:
ApiKeyAuth
path Parameters
client_id
required
string <uuid> (Provider.clientId)

Responses

Response samples

Content type
application/json
{
  • "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
  • "api_key": "string"
}

ExtInfo_create

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
external_name
required
string (External infomation name)
external_description
required
string (External infomation description)
license
required
string (External information license)
license_description
required
string (External information license description)
first_entry_at
required
string <date-time>
last_updated_at
required
string <date-time>
updated_history
required
Array of strings <date-time> [ items <date-time > ]

Responses

Request samples

Content type
application/json
{
  • "external_name": "string",
  • "external_description": "string",
  • "license": "string",
  • "license_description": "string",
  • "first_entry_at": "2019-08-24T14:15:22Z",
  • "last_updated_at": "2019-08-24T14:15:22Z",
  • "updated_history": [
    ]
}

Response samples

Content type
application/json
{
  • "external_id": "example_id",
  • "external_name": "string",
  • "external_description": "string",
  • "license": "string",
  • "license_description": "string",
  • "first_entry_at": "2019-08-24T14:15:22Z",
  • "last_updated_at": "2019-08-24T14:15:22Z",
  • "updated_history": [
    ],
  • "api_key": "string"
}

ExtInfo_delete

Authorizations:
ApiKeyAuth
path Parameters
extinfo_id
required
string (ExtInfo.ExtInfoId)
Value: "example_id"

Responses

Response samples

Content type
application/json
{
  • "delete_extinfo_id": "example_id"
}

ExtInfo_revoke

Authorizations:
ApiKeyAuth
path Parameters
extinfo_id
required
string (ExtInfo.ExtInfoId)
Value: "example_id"

Responses

Response samples

Content type
application/json
{
  • "extinfo_id": "example_id",
  • "api_key": "string"
}

Create new koyo information

Set up koyo's basic information and register it in the database. You can get koyo_id by hitting this endpoint. For updating basic information, please use /koyo api instead of admin api

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
koyo_name
required
string (Koyo name) [ 1 .. 64 ] characters
koyo_description
required
string (Koyo description) <= 2048 characters
need_external
required
Array of strings (ExtInfo.ExtInfoId)
Items Value: "example_id"
required
object (param name: param default)

Koyo parameters. The key is the parameter name and the value is the default value.

koyo_scales
required
Array of numbers <float> (Koyo scales is resolution (e.g. one data per meter)) [ items <float > ]

Koyo scales is resolution (e.g. one data per meter). Returns a list of supported scales.

koyo_data_ids
required
Array of strings <uuid> (Koyo data IDs) [ items <uuid > ]
version
required
string (Koyo version) ^\d+\.\d+\.\d+$

Semantic versioning

license
required
string (Koyo license)
ext_licenses
required
Array of strings (Koyo source license for use)

Licenses for primary information and other information used by the koyo.

Responses

Request samples

Content type
application/json
{
  • "koyo_name": "string",
  • "koyo_description": "string",
  • "need_external": [
    ],
  • "koyo_params": {
    },
  • "koyo_scales": [
    ],
  • "koyo_data_ids": [
    ],
  • "version": "string",
  • "license": "string",
  • "ext_licenses": [
    ]
}

Response samples

Content type
application/json
{
  • "koyo_id": "string",
  • "koyo_name": "string",
  • "koyo_description": "string",
  • "need_external": [
    ],
  • "koyo_params": {
    },
  • "koyo_scales": [
    ],
  • "koyo_data_ids": [
    ],
  • "version": "string",
  • "license": "string",
  • "ext_licenses": [
    ],
  • "first_entry_at": "2019-08-24T14:15:22Z",
  • "last_entry_at": "2019-08-24T14:15:22Z",
  • "last_updated_at": "2019-08-24T14:15:22Z",
  • "api_key": "string"
}

Delete koyo information

Authorizations:
ApiKeyAuth
path Parameters
koyo_id
required
string (Koyo.koyoId) ^[a-z_-]{1,64}$

Responses

Response samples

Content type
application/json
{
  • "delete_koyo_id": "string"
}

Revoke koyo api key

Authorizations:
ApiKeyAuth
path Parameters
koyo_id
required
string (Koyo.koyoId) ^[a-z_-]{1,64}$

Responses

Response samples

Content type
application/json
{
  • "koyo_id": "string",
  • "api_key": "string"
}