Projects

Get Project

Retrieve existing project

GET/api/v2/{app_id}/projects/{project_id}

Authorization

OAuth2AuthorizationCodeBearerAPIKeyHeaderAPIKeyQuery

Path parameters

app_id*App Id

project_id*Project Id

Response

200422

Successful Response

Body

application/json

id*Id

Project id

name*Name

Project name

descriptionDescription

Project description

stringnull

public*Public

Project publication setting

area_of_interest*all of

GeoJSON feature describing the area of interest

Request

JavaScriptCurlPython

const response = await fetch('/api/v2/{app_id}/projects/{project_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "name": "text",
  "description": "text",
  "public": false,
  "area_of_interest": {
    "geometry": {
      "type": "text",
      "coordinates": [
        0
      ]
    },
    "id": "text",
    "bbox": []
  }
}

Update Project

Update existing project

PUT/api/v2/{app_id}/projects/{project_id}

Authorization

OAuth2AuthorizationCodeBearerAPIKeyHeaderAPIKeyQuery

Path parameters

app_id*App Id

project_id*Project Id

Body

application/json

nameName

Project name

stringnull

descriptionDescription

Project description

stringnull

publicPublic

Project publication setting

booleannull

Response

200422

Successful Response

Body

application/json

id*Id

Project id

name*Name

Project name

descriptionDescription

Project description

stringnull

public*Public

Project publication setting

area_of_interest*all of

GeoJSON feature describing the area of interest

Request

JavaScriptCurlPython

const response = await fetch('/api/v2/{app_id}/projects/{project_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200422

{
  "name": "text",
  "description": "text",
  "public": false,
  "area_of_interest": {
    "geometry": {
      "type": "text",
      "coordinates": [
        0
      ]
    },
    "id": "text",
    "bbox": []
  }
}

Delete Project

Delete existing project

DELETE/api/v2/{app_id}/projects/{project_id}

Authorization

OAuth2AuthorizationCodeBearerAPIKeyHeaderAPIKeyQuery

Path parameters

app_id*App Id

project_id*Project Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v2/{app_id}/projects/{project_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}