DMS API 1.0.0
APIs for interacting with the DMS
auth
POST /api/v1/auth/login/
Description
Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework
Accept the following POST parameters: username, password Return the REST Framework Token Object's key.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"username": "string",
"email": "derp@meme.org",
"password": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string"
}
},
"required": [
"password"
]
}
{
"username": "string",
"email": "derp@meme.org",
"password": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string"
}
},
"required": [
"password"
]
}
{
"username": "string",
"email": "derp@meme.org",
"password": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"username": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"password": {
"type": "string"
}
},
"required": [
"password"
]
}
Responses
{
"access": "string",
"refresh": "string",
"user": {
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
}
Schema of the response body
{
"type": "object",
"description": "Serializer for JWT authentication.",
"properties": {
"access": {
"type": "string"
},
"refresh": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/UserDetails"
}
},
"required": [
"access",
"refresh",
"user"
]
}
POST /api/v1/auth/logout/
Description
Calls Django logout method and delete the Token object assigned to the current User object.
Accepts/Returns nothing.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Responses
{
"detail": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"detail": {
"type": "string",
"readOnly": true
}
},
"required": [
"detail"
]
}
POST /api/v1/auth/password/change/
Description
Calls Django Auth SetPasswordForm save method.
Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"new_password1": "string",
"new_password2": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
}
},
"required": [
"new_password1",
"new_password2"
]
}
{
"new_password1": "string",
"new_password2": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
}
},
"required": [
"new_password1",
"new_password2"
]
}
{
"new_password1": "string",
"new_password2": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
}
},
"required": [
"new_password1",
"new_password2"
]
}
Responses
{
"detail": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"detail": {
"type": "string",
"readOnly": true
}
},
"required": [
"detail"
]
}
POST /api/v1/auth/password/reset/
Description
Calls Django Auth PasswordResetForm save method.
Accepts the following POST parameters: email Returns the success/fail message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"email": "derp@meme.org"
}
Schema of the request body
{
"type": "object",
"description": "Serializer for requesting a password reset e-mail.",
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}
{
"email": "derp@meme.org"
}
Schema of the request body
{
"type": "object",
"description": "Serializer for requesting a password reset e-mail.",
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}
{
"email": "derp@meme.org"
}
Schema of the request body
{
"type": "object",
"description": "Serializer for requesting a password reset e-mail.",
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}
Responses
{
"detail": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"detail": {
"type": "string",
"readOnly": true
}
},
"required": [
"detail"
]
}
POST /api/v1/auth/password/reset/confirm/
Description
Password reset e-mail link is confirmed, therefore this resets the user's password.
Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"new_password1": "string",
"new_password2": "string",
"uid": "string",
"token": "string"
}
Schema of the request body
{
"type": "object",
"description": "Serializer for confirming a password reset attempt.",
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
},
"uid": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"token",
"uid"
]
}
{
"new_password1": "string",
"new_password2": "string",
"uid": "string",
"token": "string"
}
Schema of the request body
{
"type": "object",
"description": "Serializer for confirming a password reset attempt.",
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
},
"uid": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"token",
"uid"
]
}
{
"new_password1": "string",
"new_password2": "string",
"uid": "string",
"token": "string"
}
Schema of the request body
{
"type": "object",
"description": "Serializer for confirming a password reset attempt.",
"properties": {
"new_password1": {
"type": "string",
"maxLength": 128
},
"new_password2": {
"type": "string",
"maxLength": 128
},
"uid": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"new_password1",
"new_password2",
"token",
"uid"
]
}
Responses
{
"detail": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"detail": {
"type": "string",
"readOnly": true
}
},
"required": [
"detail"
]
}
POST /api/v1/auth/token/refresh/
Description
Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
Request body
{
"access": "string",
"refresh": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"access": {
"type": "string",
"readOnly": true
},
"refresh": {
"type": "string",
"writeOnly": true
}
},
"required": [
"access",
"refresh"
]
}
{
"access": "string",
"refresh": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"access": {
"type": "string",
"readOnly": true
},
"refresh": {
"type": "string",
"writeOnly": true
}
},
"required": [
"access",
"refresh"
]
}
{
"access": "string",
"refresh": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"access": {
"type": "string",
"readOnly": true
},
"refresh": {
"type": "string",
"writeOnly": true
}
},
"required": [
"access",
"refresh"
]
}
Responses
{
"access": "string",
"refresh": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"access": {
"type": "string",
"readOnly": true
},
"refresh": {
"type": "string",
"writeOnly": true
}
},
"required": [
"access",
"refresh"
]
}
POST /api/v1/auth/token/verify/
Description
Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.
Request body
{
"token": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"token": {
"type": "string",
"writeOnly": true
}
},
"required": [
"token"
]
}
{
"token": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"token": {
"type": "string",
"writeOnly": true
}
},
"required": [
"token"
]
}
{
"token": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"token": {
"type": "string",
"writeOnly": true
}
},
"required": [
"token"
]
}
Responses
{
"token": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"token": {
"type": "string",
"writeOnly": true
}
},
"required": [
"token"
]
}
GET /api/v1/auth/user/
Description
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.
Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email
Returns UserModel fields.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Responses
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the response body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"first_name",
"last_name",
"pk",
"username"
]
}
PUT /api/v1/auth/user/
Description
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.
Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email
Returns UserModel fields.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the request body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"first_name",
"last_name",
"pk",
"username"
]
}
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the request body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"first_name",
"last_name",
"pk",
"username"
]
}
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the request body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"first_name",
"last_name",
"pk",
"username"
]
}
Responses
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the response body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"first_name",
"last_name",
"pk",
"username"
]
}
PATCH /api/v1/auth/user/
Description
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.
Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email
Returns UserModel fields.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the request body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
}
}
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the request body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
}
}
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the request body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
}
}
Responses
{
"pk": 0,
"username": "string",
"email": "derp@meme.org",
"first_name": "string",
"last_name": "string"
}
Schema of the response body
{
"type": "object",
"description": "User model w/o password",
"properties": {
"pk": {
"type": "integer",
"readOnly": true,
"title": "ID"
},
"username": {
"type": "string",
"description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
"pattern": "^[\\w.@+-]+$",
"maxLength": 150
},
"email": {
"type": "string",
"format": "email",
"readOnly": true,
"nullable": true,
"title": "Email address"
},
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
}
},
"required": [
"email",
"first_name",
"last_name",
"pk",
"username"
]
}
datasets
GET /api/v1/datasets/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
contributor |
query | string | No | Contributor | |
cursor |
query | string | No | The pagination cursor value. | |
extent |
query | string | No | ||
project |
query | string | No | Project | |
search |
query | string | No | Search | |
tags |
query | array | No | ||
version |
query | string | No |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"version": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetList"
}
}
}
}
POST /api/v1/datasets/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
GET /api/v1/datasets/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this dataset. |
Responses
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
PUT /api/v1/datasets/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this dataset. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
PATCH /api/v1/datasets/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this dataset. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
DELETE /api/v1/datasets/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this dataset. |
Responses
GET /api/v1/datasets/{id}/feature/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this dataset. |
Responses
{
"type": "Feature",
"id": "string",
"geometry": null,
"bbox": [
12.9721,
77.5933,
12.9721,
77.5933
],
"properties": {
"title": "string"
}
}
Schema of the response body
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/GisFeatureEnum"
},
"id": {
"type": "string"
},
"geometry": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point"
]
},
"coordinates": {
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"example": [
12.9721,
77.5933
],
"minItems": 2,
"maxItems": 3
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"LineString"
]
},
"coordinates": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"example": [
12.9721,
77.5933
],
"minItems": 2,
"maxItems": 3
},
"example": [
[
22.4707,
70.0577
],
[
12.9721,
77.5933
]
],
"minItems": 2
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Polygon"
]
},
"coordinates": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"example": [
12.9721,
77.5933
],
"minItems": 2,
"maxItems": 3
},
"example": [
[
22.4707,
70.0577
],
[
12.9721,
77.5933
]
],
"minItems": 4
},
"example": [
[
[
0.0,
0.0
],
[
0.0,
50.0
],
[
50.0,
50.0
],
[
50.0,
0.0
],
[
0.0,
0.0
]
]
]
}
}
}
]
},
"bbox": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 4,
"maxItems": 4,
"example": [
12.9721,
77.5933,
12.9721,
77.5933
]
},
"properties": {
"type": "object",
"properties": {
"title": {
"type": "string"
}
}
}
}
}
GET /api/v1/datasets/metadata-schema/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Responses
{
"url": "string",
"id": "string",
"title": "string",
"name": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"project": "string",
"project_id": "string",
"metadata": null,
"version": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"name": {
"type": "string",
"readOnly": true,
"pattern": "^[-a-zA-Z0-9_]+$"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"project": {
"type": "string",
"format": "uri",
"readOnly": true
},
"project_id": {
"type": "string"
},
"metadata": {},
"version": {
"type": "string",
"nullable": true
}
},
"required": [
"last_modified_at",
"name",
"project",
"project_id",
"title",
"url"
]
}
datasets-relationships
GET /api/v1/datasets-relationships/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
cursor |
query | string | No | The pagination cursor value. | |
involves |
query | string | No | ||
source |
query | string | No | ||
target |
query | string | No | ||
type |
query | string | No | * `IsCitedBy` - Is cited by * `Cites` - Cites * `IsSupplementTo` - Is supplement to * `IsSupplementedBy` - Is supplemented by * `IsContinuedBy` - Is continued by * `Continues` - Continues * `IsDescribedBy` - Is described by * `Describes` - Describes * `HasMetadata` - Has metadata * `IsMetadataFor` - Is metadata for * `HasVersion` - Has version * `IsVersionOf` - Is version of * `IsNewVersionOf` - Is new version of * `IsPreviousVersionOf` - Is previous version of * `IsPartOf` - Is part of * `HasPart` - Has part * `IsPublishedIn` - Is published in * `IsReferencedBy` - Is referenced by * `References` - References * `IsDocumentedBy` - Is documented by * `Documents` - Documents * `IsCompiledBy` - Is compiled by * `Compiles` - Compiles * `IsVariantFormOf` - Is variant form of * `IsOriginalFormOf` - Is original form of * `IsIdenticalTo` - Is identical to * `IsReviewedBy` - Is reviewed by * `Reviews` - Reviews * `IsDerivedFrom` - Is derived from * `IsSourceOf` - Is source of * `Requires` - Requires * `IsRequiredBy` - Is required by * `IsObsoletedBy` - Is obsoleted by * `Obsoletes` - Obsoletes |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"source": "string",
"source_id": "string",
"target": "string",
"target_id": "string",
"type": "IsCitedBy",
"uuid": "ec67089f-282b-4696-a085-47c42957147e",
"url": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetRelationship"
}
}
}
}
POST /api/v1/datasets-relationships/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"url": "string",
"uuid": "861ed046-387e-4fa7-9850-03beda7aa1a8",
"source": "string",
"target": "string",
"type": "IsCitedBy"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Type636Enum"
}
},
"required": [
"source",
"target",
"type",
"url",
"uuid"
]
}
{
"url": "string",
"uuid": "b6d37bad-2d99-45d0-a61f-4256b1b177d4",
"source": "string",
"target": "string",
"type": "IsCitedBy"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Type636Enum"
}
},
"required": [
"source",
"target",
"type",
"url",
"uuid"
]
}
{
"url": "string",
"uuid": "ecf074b0-85c6-49a4-87e8-947d35dc8152",
"source": "string",
"target": "string",
"type": "IsCitedBy"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Type636Enum"
}
},
"required": [
"source",
"target",
"type",
"url",
"uuid"
]
}
Responses
{
"url": "string",
"uuid": "f49eac07-cb44-41d2-a53f-958adb225b8c",
"source": "string",
"target": "string",
"type": "IsCitedBy"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Type636Enum"
}
},
"required": [
"source",
"target",
"type",
"url",
"uuid"
]
}
DELETE /api/v1/datasets-relationships/{uuid}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
uuid |
path | string | No |
Responses
datatables
GET /api/v1/datatables/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
cursor |
query | string | No | The pagination cursor value. | |
is_accessible |
query | boolean | No | ||
is_pmtiles |
query | boolean | No | ||
name |
query | string | No | ||
resource |
query | string | No | ||
search |
query | string | No | Search |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"id": "string",
"name": "string",
"title": "string",
"resource": "string",
"resource_id": "string",
"is_spatial": "string",
"driver": "string",
"count": 0,
"uri": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataTableList"
}
}
}
}
dmps
GET /api/v1/dmps/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": 0,
"name": "string",
"data": null
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DMP"
}
}
}
}
GET /api/v1/dmps/{id}/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | integer | No | A unique integer value identifying this dmp. |
Responses
{
"id": 0,
"name": "string",
"data": null
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
},
"required": [
"id",
"name"
]
}
PUT /api/v1/dmps/{id}/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | integer | No | A unique integer value identifying this dmp. |
Request body
{
"id": 0,
"name": "string",
"data": null
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
},
"required": [
"id",
"name"
]
}
{
"id": 0,
"name": "string",
"data": null
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
},
"required": [
"id",
"name"
]
}
{
"id": 0,
"name": "string",
"data": null
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
},
"required": [
"id",
"name"
]
}
Responses
{
"id": 0,
"name": "string",
"data": null
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
},
"required": [
"id",
"name"
]
}
PATCH /api/v1/dmps/{id}/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | integer | No | A unique integer value identifying this dmp. |
Request body
{
"id": 0,
"name": "string",
"data": null
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
}
}
{
"id": 0,
"name": "string",
"data": null
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
}
}
{
"id": 0,
"name": "string",
"data": null
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
}
}
Responses
{
"id": 0,
"name": "string",
"data": null
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"data": {
"nullable": true
}
},
"required": [
"id",
"name"
]
}
mapresources
GET /api/v1/mapresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
cursor |
query | string | No | The pagination cursor value. | |
dataset |
query | string | No | Dataset | |
dataset__project |
query | string | No | Project | |
extent |
query | string | No | ||
resource_type |
query | string | No | Resource Type * `resource` - Resource * `mapresource` - Map Resource * `tabularresource` - Tabular Resource * `rasterresource` - Raster Resource | |
search |
query | string | No | Search | |
title__icontains |
query | string | No | ||
uri__startswith |
query | string | No |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MapResource"
}
}
}
}
POST /api/v1/mapresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
GET /api/v1/mapresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this map resource. |
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PUT /api/v1/mapresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this map resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PATCH /api/v1/mapresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this map resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
}
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"map_type": "nina"
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"map_type": {
"$ref": "#/components/schemas/MapTypeEnum"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
DELETE /api/v1/mapresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this map resource. |
Responses
partitionedresources
GET /api/v1/partitionedresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
cursor |
query | string | No | The pagination cursor value. | |
dataset |
query | string | No | Dataset | |
dataset__project |
query | string | No | Project | |
extent |
query | string | No | ||
resource_type |
query | string | No | Resource Type * `resource` - Resource * `mapresource` - Map Resource * `tabularresource` - Tabular Resource * `rasterresource` - Raster Resource | |
search |
query | string | No | Search | |
title__icontains |
query | string | No | ||
uri__startswith |
query | string | No |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartitionedResource"
}
}
}
}
POST /api/v1/partitionedresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
GET /api/v1/partitionedresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this partitioned resource. |
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PUT /api/v1/partitionedresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this partitioned resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PATCH /api/v1/partitionedresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this partitioned resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
DELETE /api/v1/partitionedresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this partitioned resource. |
Responses
projects
GET /api/v1/projects/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
category |
query | integer | No | ||
customer__istartswith |
query | string | No | ||
end_date__lte |
query | string | No | ||
leader |
query | string | No | Leader | |
limit |
query | integer | No | Number of results to return per page. | |
name__icontains |
query | string | No | ||
number__istartswith |
query | string | No | ||
offset |
query | integer | No | The initial index from which to return the results. | |
participant |
query | string | No | Participant | |
section |
query | string | No | ||
start_date__gte |
query | string | No | ||
status |
query | string | Yes | * `N` - Active * `T` - Completed * `P` - Parked * `C` - Not completed | |
tags |
query | array | No | ||
topics |
query | array | No |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"count",
"results"
],
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
}
}
}
GET /api/v1/projects/{number}/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
number |
path | string | No | A unique value identifying this project. |
Responses
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
},
"required": [
"number",
"start_date"
]
}
PUT /api/v1/projects/{number}/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
number |
path | string | No | A unique value identifying this project. |
Request body
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
},
"required": [
"number",
"start_date"
]
}
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
},
"required": [
"number",
"start_date"
]
}
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
},
"required": [
"number",
"start_date"
]
}
Responses
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
},
"required": [
"number",
"start_date"
]
}
PATCH /api/v1/projects/{number}/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
number |
path | string | No | A unique value identifying this project. |
Request body
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
}
}
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
}
}
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
}
}
Responses
{
"number": "string",
"description": "string",
"start_date": "2022-04-13T15:42:05.901Z",
"end_date": "2022-04-13T15:42:05.901Z",
"status": null,
"category": 0,
"section": "string",
"customer": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"number": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"category": {
"type": "integer",
"nullable": true
},
"section": {
"type": "string",
"nullable": true
},
"customer": {
"type": "string",
"nullable": true
}
},
"required": [
"number",
"start_date"
]
}
rasterresources
GET /api/v1/rasterresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
cursor |
query | string | No | The pagination cursor value. | |
dataset |
query | string | No | Dataset | |
dataset__project |
query | string | No | Project | |
extent |
query | string | No | ||
resource_type |
query | string | No | Resource Type * `resource` - Resource * `mapresource` - Map Resource * `tabularresource` - Tabular Resource * `rasterresource` - Raster Resource | |
search |
query | string | No | Search | |
title__icontains |
query | string | No | ||
uri__startswith |
query | string | No |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RasterResource"
}
}
}
}
POST /api/v1/rasterresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
GET /api/v1/rasterresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this raster resource. |
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PUT /api/v1/rasterresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this raster resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PATCH /api/v1/rasterresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this raster resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
}
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null,
"titiler": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
},
"titiler": {
"title": "Titiler configuration"
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
DELETE /api/v1/rasterresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this raster resource. |
Responses
resources
GET /api/v1/resources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
cursor |
query | string | No | The pagination cursor value. | |
dataset |
query | string | No | Dataset | |
dataset__project |
query | string | No | Project | |
extent |
query | string | No | ||
is_accessible |
query | boolean | No | ||
is_cog |
query | boolean | No | ||
resource_type |
query | string | No | Resource Type * `resource` - Resource * `mapresource` - Map Resource * `tabularresource` - Tabular Resource * `rasterresource` - Raster Resource | |
search |
query | string | No | Search | |
title__icontains |
query | string | No | ||
uri__startswith |
query | string | No |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string"
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceList"
}
}
}
}
POST /api/v1/resources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
GET /api/v1/resources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this resource. |
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PUT /api/v1/resources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PATCH /api/v1/resources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
DELETE /api/v1/resources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this resource. |
Responses
GET /api/v1/resources/{id}/feature/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this resource. |
Responses
{
"type": "Feature",
"id": "string",
"geometry": null,
"bbox": [
12.9721,
77.5933,
12.9721,
77.5933
],
"properties": {
"title": "string"
}
}
Schema of the response body
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/GisFeatureEnum"
},
"id": {
"type": "string"
},
"geometry": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point"
]
},
"coordinates": {
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"example": [
12.9721,
77.5933
],
"minItems": 2,
"maxItems": 3
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"LineString"
]
},
"coordinates": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"example": [
12.9721,
77.5933
],
"minItems": 2,
"maxItems": 3
},
"example": [
[
22.4707,
70.0577
],
[
12.9721,
77.5933
]
],
"minItems": 2
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Polygon"
]
},
"coordinates": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"example": [
12.9721,
77.5933
],
"minItems": 2,
"maxItems": 3
},
"example": [
[
22.4707,
70.0577
],
[
12.9721,
77.5933
]
],
"minItems": 4
},
"example": [
[
[
0.0,
0.0
],
[
0.0,
50.0
],
[
50.0,
50.0
],
[
50.0,
0.0
],
[
0.0,
0.0
]
]
]
}
}
}
]
},
"bbox": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 4,
"maxItems": 4,
"example": [
12.9721,
77.5933,
12.9721,
77.5933
]
},
"properties": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "A name that describes the resource"
}
}
}
}
}
tabularresources
GET /api/v1/tabularresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
cursor |
query | string | No | The pagination cursor value. | |
dataset |
query | string | No | Dataset | |
dataset__project |
query | string | No | Project | |
extent |
query | string | No | ||
resource_type |
query | string | No | Resource Type * `resource` - Resource * `mapresource` - Map Resource * `tabularresource` - Tabular Resource * `rasterresource` - Raster Resource | |
search |
query | string | No | Search | |
title__icontains |
query | string | No | ||
uri__startswith |
query | string | No |
Responses
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
]
}
Schema of the response body
{
"type": "object",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cD00ODY%3D\""
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TabularResource"
}
}
}
}
POST /api/v1/tabularresources/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
GET /api/v1/tabularresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this tabular resource. |
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PUT /api/v1/tabularresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this tabular resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
PATCH /api/v1/tabularresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this tabular resource. |
Request body
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the request body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
}
}
Responses
{
"url": "string",
"id": "string",
"title": "string",
"uri": "string",
"created_at": "2022-04-13T15:42:05.901Z",
"last_modified_at": "2022-04-13T15:42:05.901Z",
"dataset_id": "string",
"dataset": "string",
"role": null,
"access_type": null,
"description": "string",
"metadata": null,
"user_metadata": null,
"is_metadata_manual": true,
"last_sync": null
}
Schema of the response body
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true
},
"id": {
"type": "string"
},
"title": {
"type": "string",
"description": "A name that describes the resource"
},
"uri": {
"type": "string",
"title": "URI of the resource"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"dataset_id": {
"type": "string"
},
"dataset": {
"type": "string",
"format": "uri",
"readOnly": true
},
"role": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/RoleEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"access_type": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/AccessTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"description": {
"type": "string"
},
"metadata": {
"nullable": true,
"title": "GDAL Metadata"
},
"user_metadata": {
"nullable": true,
"title": "User provided metadata"
},
"is_metadata_manual": {
"type": "boolean"
},
"last_sync": {
"nullable": true
}
},
"required": [
"dataset",
"dataset_id",
"id",
"last_modified_at",
"uri",
"url"
]
}
DELETE /api/v1/tabularresources/{id}/
Description
Enforces object-level permissions in rest_framework.viewsets.ViewSet,
deriving the permission type from the particular action to be performed..
As with rules.contrib.views.AutoPermissionRequiredMixin, this only works when
model permissions are registered using rules.contrib.models.RulesModelMixin.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
id |
path | string | No | A unique value identifying this tabular resource. |
Responses
uploads
POST /api/v1/uploads/tusd/webhook/
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
jwtCookieAuth |
cookie | string | N/A | No | API key |
jwtHeaderAuth |
header | string | N/A | No | JWT Bearer token |
jwtAuth |
header | string | N/A | No | JWT Bearer token |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
cookieAuth |
cookie | string | N/A | No | API key |
Responses
Schemas
AccessTypeEnum
Type: string
BlankEnum
Type:
Dataset
| Name | Type | Description |
|---|---|---|
created_at |
string(date-time) | |
id |
string | |
last_modified_at |
string(date-time) | |
metadata |
||
name |
string | |
project |
string(uri) | |
project_id |
string | |
title |
string | |
url |
string(uri) | |
version |
string | null |
DatasetGeo
| Name | Type | Description |
|---|---|---|
bbox |
Array<number> | |
geometry |
||
id |
string | |
properties |
Properties: title |
|
type |
GisFeatureEnum |
DatasetList
| Name | Type | Description |
|---|---|---|
created_at |
string(date-time) | |
id |
string | |
last_modified_at |
string(date-time) | |
name |
string | |
project |
string(uri) | |
project_id |
string | |
title |
string | |
url |
string(uri) | |
version |
string | null |
DatasetRelationship
| Name | Type | Description |
|---|---|---|
source |
string(uri) | |
source_id |
string | |
target |
string(uri) | |
target_id |
string | |
type |
Type636Enum | |
url |
string(uri) | |
uuid |
string(uuid) |
DatasetRelationshipCreate
| Name | Type | Description |
|---|---|---|
source |
string | |
target |
string | |
type |
Type636Enum | |
url |
string(uri) | |
uuid |
string(uuid) |
DataTableList
| Name | Type | Description |
|---|---|---|
count |
integer | |
driver |
string | |
id |
string | |
is_spatial |
string | |
name |
string | |
resource |
string(uri) | |
resource_id |
string | |
title |
string | |
uri |
string |
DMP
| Name | Type | Description |
|---|---|---|
data |
||
id |
integer | |
name |
string |
GisFeatureEnum
Type: string
JWT
| Name | Type | Description |
|---|---|---|
access |
string | |
refresh |
string | |
user |
UserDetails |
Login
| Name | Type | Description |
|---|---|---|
email |
string(email) | |
password |
string | |
username |
string |
MapResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
map_type |
MapTypeEnum | |
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
MapTypeEnum
Type: string
NullEnum
Type:
PaginatedDatasetListList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<DatasetList> |
PaginatedDatasetRelationshipList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<DatasetRelationship> |
PaginatedDataTableListList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<DataTableList> |
PaginatedDMPList
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<DMP> |
PaginatedMapResourceList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<MapResource> |
PaginatedPartitionedResourceList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<PartitionedResource> |
PaginatedProjectList
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<Project> |
PaginatedRasterResourceList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<RasterResource> |
PaginatedResourceListList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<ResourceList> |
PaginatedTabularResourceList
| Name | Type | Description |
|---|---|---|
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<TabularResource> |
PartitionedResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
PasswordChange
| Name | Type | Description |
|---|---|---|
new_password1 |
string | |
new_password2 |
string |
PasswordReset
| Name | Type | Description |
|---|---|---|
email |
string(email) |
PasswordResetConfirm
| Name | Type | Description |
|---|---|---|
new_password1 |
string | |
new_password2 |
string | |
token |
string | |
uid |
string |
PatchedDataset
| Name | Type | Description |
|---|---|---|
created_at |
string(date-time) | |
id |
string | |
last_modified_at |
string(date-time) | |
metadata |
||
name |
string | |
project |
string(uri) | |
project_id |
string | |
title |
string | |
url |
string(uri) | |
version |
string | null |
PatchedDMP
| Name | Type | Description |
|---|---|---|
data |
||
id |
integer | |
name |
string |
PatchedMapResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
map_type |
MapTypeEnum | |
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
PatchedPartitionedResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
PatchedProject
| Name | Type | Description |
|---|---|---|
category |
integer | null | |
customer |
string | null | |
description |
string | null | |
end_date |
string(date-time) | null | |
number |
string | |
section |
string | null | |
start_date |
string(date-time) | |
status |
PatchedRasterResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
titiler |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
PatchedResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
PatchedTabularResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
PatchedUserDetails
| Name | Type | Description |
|---|---|---|
email |
string(email) | null | |
first_name |
string | |
last_name |
string | |
pk |
integer | |
username |
string | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
Project
| Name | Type | Description |
|---|---|---|
category |
integer | null | |
customer |
string | null | |
description |
string | null | |
end_date |
string(date-time) | null | |
number |
string | |
section |
string | null | |
start_date |
string(date-time) | |
status |
RasterResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
titiler |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
Resource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
ResourceGeo
| Name | Type | Description |
|---|---|---|
bbox |
Array<number> | |
geometry |
||
id |
string | |
properties |
Properties: title |
|
type |
GisFeatureEnum |
ResourceList
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
last_modified_at |
string(date-time) | |
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) |
RestAuthDetail
| Name | Type | Description |
|---|---|---|
detail |
string |
RoleEnum
Type: string
StatusEnum
Type: string
TabularResource
| Name | Type | Description |
|---|---|---|
access_type |
||
created_at |
string(date-time) | |
dataset |
string(uri) | |
dataset_id |
string | |
description |
string | |
id |
string | |
is_metadata_manual |
boolean | |
last_modified_at |
string(date-time) | |
last_sync |
||
metadata |
||
role |
||
title |
string | A name that describes the resource |
uri |
string | |
url |
string(uri) | |
user_metadata |
TokenRefresh
| Name | Type | Description |
|---|---|---|
access |
string | |
refresh |
string |
TokenVerify
| Name | Type | Description |
|---|---|---|
token |
string |
Type636Enum
Type: string
UserDetails
| Name | Type | Description |
|---|---|---|
email |
string(email) | null | |
first_name |
string | |
last_name |
string | |
pk |
integer | |
username |
string | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| cookieAuth | apiKey | ||
| jwtAuth | http | bearer | |
| jwtCookieAuth | apiKey | ||
| jwtHeaderAuth | http | bearer | |
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |