Projects
A project entity allows you to maintain information about a project.
End Points
Create a project
List of all projects
Update the details of a project
Retrieve details of a project
Delete a project
Make a project active
Make a project inactive
Attribute
project_id
long
Unique ID for the project generated by the server. This is used as identifier.
project_name
string
Name of the project.
customer_id
long
Unique ID of the customer.
customer_name
string
Name of the customer.
currency_code
string
Base currency for the project.
description
string
Description about the project.
status
string
Status of the project. It can either be
active
or inactive
. billing_type
string
Type of billing for the project. Give
based_on_task_hours
as default. budget_type
string
Type of budget of the project. Possible values are
hours_per_staff
or hours_per_task
or total_project_hours
or total_project_cost
. show_to_all_users
boolean
Whether the Project is shown to all users.
project_head_id
long
Unique ID of Project Head.
project_head_name
string
Name of the Project Head.
custom_fields
array
Custom fields for a project.
customfield_id
long
value
string
Value of the Custom Field
created_time
string
Time of project creation.
users
array
Associated user details list.
user_id
long
Unique ID of the user.
is_current_user
boolean
Whether he/she is the current user. It can either be
true
or false
. name
string
Name of the user.
email
string
Email ID of the user.
user_role
string
Role of the user.
role_id
long
Unique ID for the role.
status
string
Status of the project. It can either be
active
or inactive
. rate
double
Fixed rate for user.
Create a project
Create a new project.
Arguments
project_name
string
(Required)
Name of the project.
customer_id
long
(Required)
Unique ID of the customer.
description
string
Description about the project.
billing_type
string
Type of billing for the project. Give
based_on_task_hours
as default. show_to_all_users
boolean
Whether the Project is shown to all users.
project_head_id
long
Unique ID of Project Head.
custom_fields
array
Custom fields for a project.
customfield_id
long
value
string
Value of the Custom Field
users
array
Associated user details list.
user_id
long
Unique ID of the user.
is_current_user
boolean
Whether he/she is the current user. It can either be
true
or false
. name
string
Name of the user.
email
string
Email ID of the user.
user_role
string
Role of the user.
role_id
long
Unique ID for the role.
status
string
Status of the project. It can either be
active
or inactive
. rate
double
Fixed rate for user.
List of all projects
List of all projects.
Update the details of a project
Update the details of an existing project.
Arguments
project_name
string
Name of the project.
customer_id
long
Unique ID of the customer.
description
string
Description about the project.
billing_type
string
Type of billing for the project. Give
based_on_task_hours
as default. custom_fields
array
Custom fields for a project.
customfield_id
long
value
string
Value of the Custom Field
Retrieve details of a project
Details of an existing project.
Delete a project
Delete an existing project.
Make a project active
Mark a project as active.
Make a project inactive
Mark a project as inactive.