Create project

POST

https://api.catenda.com/v2/orgs/{organization-id}/projects

Add a new project. The current user must be an owner of the organization. The project will be owned by the organization and count towards the owners project limit.

Path Parameters

organization-idstringrequired
Description
Id of the organization

Body Parameters

bodyobjectrequired
- descriptionstringrequired
  Example
  Project description
  Description
  A short text describing the project, limited to 1024 characters
- namestringrequired
  Example
  Project name
  Description
  The name of the project, limited to 512 characters

Responses

200OK

project
Description
All data in Catenda belongs to a project and has a single owner.
- createdAtstring
  Example
  2016-09-26T14:45:05.000Z
  Description
  The date and time the project was created in ISO 8601 format
- descriptionstring
  Example
  Project description
  Description
  A short text describing the project, limited to 1024 characters
- idstring
  Example
  af2d8af0fa54465b89bf26dd3d92cfd0
  Description
  A unique identifier for the project, represented as compacted UUID using 32 hexadecimal characters
- imageUrlstring
  Example
  https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/image
  Description
  The URL for the project cover picture
- namestring
  Example
  Project name
  Description
  The name of the project, limited to 512 characters
- owneruser
  Description
  Represents a User, Organization or Team. A User is someone with a Catenda account, commonly representing a person. An Organization represents a company, project organization or an application. Organizations do not have a username and cannot sign in to Catenda. A Team represents a group of users within a project. Teams do not have a username and cannot sign in to Catenda.
  - idstring
    Example
    524809076a694255b989d236517a55da
    Description
    Represented as compacted UUID using 32 hexadecimal characters
  - namestring
    Example
    John Doe
    Description
    The name of the user, limited to 128 characters
  - usernamestring
    Example
    [email protected]
    Description
    The handle the user identifies with. Commonly the username will be in email address format. Usernames are unique but subject to change, we recommend using the id field to reference users instead. If the user represents an organization or a team the value is always null. Limited to 50 characters.
  - emailstring
    Example
    [email protected]
    Description
    Email address of the User
  - createdAtstring
    Example
    2016-09-20T14:55:22.000Z
    Description
    The date and time the user was created in ISO 8601 format
  - avatarUrlstring
    Example
    https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512
    Description
    The URL for the user avatar
  - typestring<user | organization | team>
    Example
    user
    Description
    The type of user, valid values are: - user - organization - team
- siteLocationobject
  Description
  The approximate location (latitude, longitude in WGS 84) of the project
  - longitudestring
    Example
    8.26
    Description
    Longitude in WGS 84
  - latitudestring
    Example
    6.46
    Description
    Latitude in WGS 84
- updatedAtstring
  Example
  2016-09-26T14:45:40.000Z
  Description
  The date and time of the last change to the project in ISO 8601 format

curl

curl --request POST \
     --url https://api.catenda.com/v2/orgs/{organization-id}/projects \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "description": "Project description",
     "name": "Project name"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "description": "Project description",
   "name": "Project name"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.catenda.com/v2/orgs/{organization-id}/projects", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.catenda.com/v2/orgs/{organization-id}/projects")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "description": "Project description",
   "name": "Project name"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.catenda.com/v2/orgs/{organization-id}/projects"

payload = json.dumps({
   "description": "Project description",
   "name": "Project name"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "createdAt": "2016-09-26T14:45:05.000Z",
  "description": "Project description",
  "id": "af2d8af0fa54465b89bf26dd3d92cfd0",
  "imageUrl": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/image",
  "name": "Project name",
  "owner": {
    "id": "524809076a694255b989d236517a55da",
    "name": "John Doe",
    "username": "[email protected]",
    "email": "[email protected]",
    "createdAt": "2016-09-20T14:55:22.000Z",
    "avatarUrl": "https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512",
    "type": "user"
  },
  "siteLocation": {
    "longitude": 8.26,
    "latitude": 6.46
  },
  "updatedAt": "2016-09-26T14:45:40.000Z"
}

Add a new project.

The current user must be an owner of the organization.

The project will be owned by the organization and count towards the owners project limit.