Projects | Orbify

Orbify

Orbify platform Orbify community

Get Project

Retrieve existing project

get

/{app_id}/projects/{project_id}

Authorizations

Path parameters

app_idintegerrequired

project_idintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v2/{app_id}/projects/{project_id}'

200

422

{
  "description": "Project description",
  "id": 123,
  "name": "Project name",
  "area_of_interest": {
    "properties": {
      "radius": 0.133
    },
    "geometry": {
      "type": "Point",
      "coordinates": [
        -78.84779139647071,
        -4.0988921451725275
      ]
    }
  }
}

Successful Response

Update Project

Update existing project

put

/{app_id}/projects/{project_id}

Authorizations

Path parameters

app_idintegerrequired

project_idintegerrequired

Body

nameany of

Project name

descriptionany of

Project description

publicany of

Project publication setting

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v2/{app_id}/projects/{project_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "Project description",
    "name": "Project name"
  }'

200

422

{
  "description": "Project description",
  "id": 123,
  "name": "Project name",
  "area_of_interest": {
    "properties": {
      "radius": 0.133
    },
    "geometry": {
      "type": "Point",
      "coordinates": [
        -78.84779139647071,
        -4.0988921451725275
      ]
    }
  }
}

Successful Response

Delete Project

Delete existing project

delete

/{app_id}/projects/{project_id}

Authorizations

Path parameters

app_idintegerrequired

project_idintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v2/{app_id}/projects/{project_id}'

200

422

No body

Successful Response