Projects
Contents
List Projects
List all projects. For more information see Projects document model.
Endpoint:
URL |
|
Method |
|
Expected response code |
|
Expected response type |
|
Example:
curl -v \
-H "Authorization: apikey $API_USER:$API_KEY" \
$COREDATA_BASE_URL/api/v2/projects/Example response:
Result projects are sorted by creation date ascending and then by ID ascending (to get stable sorting results).
List Favourite Projects
See User home | List-favourite-Projects.
Get Project details
Get an existing Project details.
Endpoint:
URL |
|
Method |
|
Expected response code |
|
Expected response type |
|
URL parameters:
project_id– ID of an existing project.
Example:
project_id=d4d780ae-7758-11ee-9f6f-2b890065fae6
curl -v \
-H "Authorization: apikey $API_USER:$API_KEY" \
$COREDATA_BASE_URL/api/v2/projects/$project_id/Example response:
Create Project
Create a project in a space.
Endpoint:
URL |
|
Method |
|
Content-Type |
|
Expected response code |
|
Request JSON body properties:
Property | Type | Description | Mandatory |
|---|---|---|---|
|
| ID of an existing space. | Yes |
|
| Title for the new project. | Yes |
|
| A | No |
|
| A list of usernames. | No |
|
| A list of contact IDs. | No |
|
| Description of the Project. | No |
|
| Project’s due date in format | No |
|
| ID of the Fileplan Category. | No |
|
| A list of usernames. | No |
|
| Project status. Project statuses can be found in the E.g. is we have a project status | No |
|
| Project status message. | No |
|
| A list of IDs of projects created with | No |
|
| A list of tags. | No |
|
| ID of a Project Template to be used. | No |
The aspects property example – assuming URL aspect exists on the Project Template:
"aspects": {
"url": {
"url": "www.azazo.com"
}
}The aspects property example – using KKS codes:
"aspects": {
"kkscode": {
"kks_code": ["COD____"]
}
}Example:
space_id=c6c574bc-7758-11ee-a909-cbd0373c1708
title="New project"
curl -v \
-X POST \
-H "Authorization: apikey $API_USER:$API_KEY" \
-H "Content-Type: application/json" \
-d "{\"title\": \"$title\", \"space\": \"$space_id\"}" \
$COREDATA_BASE_URL/api/v2/projects/Response contains Location header with link to the newly created project. The link contains the project ID:
Location: /api/v2/projects/d4de3d64-77ca-11ee-a3a4-ef9b9d43eefb/Update Project
Update an existing Project.
Endpoint:
URL |
|
Method |
|
Content-Type |
|
Expected response code |
|
URL parameters:
project_id– ID of an existing project to be updated.
Other request parameters in JSON body are applicable from the Create Project section above.
Example:
project_id=d4de3d64-77ca-11ee-a3a4-ef9b9d43eefb
title="Updated project"
curl -v \
-X PUT \
-H "Authorization: apikey $API_USER:$API_KEY" \
-H "Content-Type: application/json" \
-d "{\"title\": \"$title\"}" \
$COREDATA_BASE_URL/api/v2/projects/$project_id/Delete Project
Delete a project.
Endpoint:
URL |
|
Method |
|
Expected response code |
|
URL parameters:
project_id– ID of an existing project to be deleted.
Example:
project_id=d4de3d64-77ca-11ee-a3a4-ef9b9d43eefb
curl -v \
-X DELETE \
-H "Authorization: apikey $API_USER:$API_KEY" \
$COREDATA_BASE_URL/api/v2/projects/$project_id/List Projects in a Space
List all Projects in an existing Space.
Endpoint:
URL |
|
Method |
|
Expected response code |
|
Expected response type |
|
Where:
space_id– ID of an existing space.
Example:
space_id=c6c574bc-7758-11ee-a909-cbd0373c1708
curl -v \
-H "Authorization: apikey $API_USER:$API_KEY" \
$COREDATA_BASE_URL/api/v2/spaces/$space_id/projects/Example response:
Add an existing Contact to a Project
It is possible to add an existing contact to an existing project using the Update Project endpoint.
Here is an example:
# Assume we have a project
project_id=ad2e105c-77c8-11ee-aeee-13451b1d7d84
# Get the contact ID of the project
curl -v \
-H "Authorization: apikey $API_USER:$API_KEY" \
$COREDATA_BASE_URL/api/v2/projects/$project_id/ | jq ".contacts"
# ...
# [
# "73c2314c-7758-11ee-b86c-1b2d654e4cc1"
# ]
contact_id=73c2314c-7758-11ee-b86c-1b2d654e4cc1
# Assume we have another contact, not associated with the project yet. We have
# to update the project with the new list of contact including the new one.
new_contact_id=00ca5976-780c-11ee-9095-17836a4f851d
curl -v \
-X PUT \
-H "Authorization: apikey $API_USER:$API_KEY" \
-H "Content-Type: application/json" \
-d "{\"contacts\": [\"$contact_id\",\"$new_contact_id\"]}" \
$COREDATA_BASE_URL/api/v2/projects/$project_id/
# Verify the project's contact list
curl -v \
-H "Authorization: apikey $API_USER:$API_KEY" \
$COREDATA_BASE_URL/api/v2/projects/$project_id/ | jq ".contacts"
# ...
# [
# "73c2314c-7758-11ee-b86c-1b2d654e4cc1",
# "00ca5976-780c-11ee-9095-17836a4f851d"
# ]
# ^ The project's contact list contains the new contact ID as well as the old one.List Files in a Project
See Files [v2] | Get-Files-in-a-Project.
List Tasks in a Project
See Tasks | List-Tasks-in-a-Project.
List Folders in a Project
See Folders | List-Folders-in-a-Project.
Create Folder in a Project
See Folders | Create-a-Folder-in-a-Project.
Create Task in a Project
See Tasks | Create-Task-in-a-Project.