This API can help you get all project details of a logged account. With this API you can retrieve a specific project or the list of all projects, update, delete and create new ones.
You can get all the information regarding to your team’s projects just by sending requests to this URL
Copy code GET https://www.webwork-tracker.com/rest-api/projects
The response returns in a json format. You can find an example of response structure below.
Copy code [ { "project_name": "{project_name}" "contract_id": "{contract_id}" "user_id": "{user_id}" "id": "{project_id}" "deleted_at": "{deleted_at}" "tags": [{tags}] }, {...} ]
If you need to get information regarding a specific project, you need to add the {project_id} at the end of the URL.
Copy code GET https://www.webwork-tracker.com/rest-api/projects/{project_id}
The response returns in a json format. Below you can see an example of response structure.
Copy code { "id": "{project_id}" "owner_id": "{owner_id}" "name": "{project_name}" "status": "{status}" "start_date": "{start_date}" "estimation": "{estimation}" "deadline": "{deadline}" "notes": "{notes}" "created_at": "{created_at}" "updated_at": "{updated_at}" "deleted_at": "{deleted_at}" }
You can update a project by sending
Copy code PUT https://www.webwork-tracker.com/rest-api/projects/{project_id}
You should put the following header in your request
Copy code Content-Type: application/x-www-form-urlencoded
You can use
Property name | Type | Is required |
---|---|---|
name | string | YES |
start_date | date | NO |
deadline | date | NO |
notes | string | NO |
estimation | integer | NO |
The returned response contains a success
property with your request success value.
Copy code { "success": "{success_of_the_request}" }
In order to create a new project in your account, you should add project name, start date,
deadline, estimation parameters to the request body using the
Copy code POST https://www.webwork-tracker.com/rest-api/projects
Here you see parameters you can pass to the request body
Property name | Type | Is required |
---|---|---|
name | string | YES |
start_date | date | NO |
deadline | date | NO |
notes | string | NO |
estimation | integer | NO |
The returned response includes a success
property which contains your request
success value, and project
property which is an array of the created project
options.
Copy code { "success": "{success_of_the_request}" }
Copy code { "success": "{success_of_the_request}" "project": "{project_array}" }
In case of failure the response will include only success
property.
To delete a project, you should send a request to the same URL using
Copy code DELETE https://www.webwork-tracker.com/rest-api/projects/{project_id}
The returned response includes a success
property which contains your request
success value.
Copy code { "success": "{success_of_the_request}" }