|
ProjectStage
An object representing a project stage.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the ProjectStage object. When adding a new ProjectStage the value must be 0. |
|
ProjectId |
integer |
The ID for the parent project object. |
|
Name |
string (100) |
The stage's name field. |
|
Description |
string (100) |
The stage's description text. |
|
StartDate |
DateTime |
Stage start date. Optional. This value can be null. |
|
ActualStartDate |
DateTime |
Stores the actual date the stage was started. This value is optional. |
|
EstimatedCompletionDate |
DateTime |
Date value for the Estimated Completion Date field. This value is optional. |
|
CompletionDate |
DateTime |
Stores the actual completing date. This value is optional. |
|
Status |
integer |
ID to set the stage's Status drop-down box. Value should be equal to a ProjectStageStatus object's ID field. |
|
IsCompleted |
boolean |
Flag to indicate the stage is completed. |
|
IsRequireSignoff |
boolean |
Flag to indicate the stage requires external user signoff. |
|
IsSignoff |
boolean |
Flag to indicate the stage was signed off. |
|
SignoffDate |
DateTime |
Date value indicating when the stage was signed off. This value is optional. |
|
SignoffIpAddress |
string (100) |
Stores the external user's IP address. |
|
SortOrder |
integer |
Sorting order of the stage. This can be null. Read only. |
|
OwnerId |
integer |
ID of the user who owns this object. This value is optional. |
|
IsInvoiceRequired |
boolean |
Flag to indicate a completed stage should generate an invoice. |
|
InvoiceAmountType |
string (100) |
Indicates what kind of invoice should be generated. Values are percentage, fixed. |
|
InvoiceAmount |
double |
Value of the invoice. This value is optional. |
|
InvoiceDueDate |
integer |
How many days after the stage is completed should the invoice be generated. This value is optional. |
|
IsInvoicePaid |
boolean |
Flag to indicate the project's invoice has been paid. |
|
TaskList |
List<Task> |
A list of task objects associated with this project stage. |
|
DependencyList |
List<ProjectMilestoneDependency> |
A list of dependencies for this stage. |
List
Description
Returns a list of project stages associated with the project.
URL
https://{company}.bluecamroo.com/api/ProjectMilestone/list?projectId={projectId}
HTTP Method
GET
Parameters
None.
Data Return
Returns the list of stages for the specified project in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Description
Returns the details of a project stage.
URL
https://{company}.bluecamroo.com/api/ProjectMilestone/get/{id}
HTTP Method
GET
Parameters
None.
Data Return
Returns the ProjectStage object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds a stage to a project.
URL
https://{company}.bluecamroo.com/api/ProjectMilestone/add
HTTP Method
POST
Parameters
A ProjectStage object
Data Return
Returns the ProjectStage object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates a ProjectStage object to replace the specified project stage.
URL
https://{company}.bluecamroo.com/api/ProjectMilestone/update
HTTP Method
PUT
Parameters
A ProjectStage object
Data Return
Returns the ProjectStage object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the project stage.
URL
https://{company}.bluecamroo.com/api/ProjectMilestone/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|