|
Case
An object that represents a case. A case is a child of a customer object.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
Unique Identity of a case. When adding a new case object the value must be 0. |
|
ParentId |
integer |
ID of the parent object. |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the case object is a child of. Value is project. |
|
ContactId |
integer |
ID for a contact associated with this case. |
|
CaseNumber |
string (100) |
The case's reference number. |
|
Subject |
string (100) |
Case's Subject field. |
|
Description |
string (100) |
Case's Description field. |
|
Status |
string (100) |
ID to set the case's Status drop-down box. Value should be equal to a CaseStatus object's ID field. |
|
OpenDate |
DateTime |
Date value indicating when the case was opened. |
|
IsClosed |
boolean |
Flag to indicate the case is closed and can't be edited. |
|
IsEscalated |
boolean |
Flag to indicate the case has been escalated. |
|
OwnerId |
integer |
The ID of the user who owns this object. |
|
IsLocked |
boolean |
Flag to indicate the case can't be edited. This property is read only |
|
ProductId |
integer |
If the case is related to a product, the ID of the product. Optional. This value can be null. |
|
ProjectId |
integer |
If the case is related to a project, the ID of the project. Optional. This value can be null. |
|
MilestoneId |
integer |
If the case is related to a stage, the ID of the stage. Optional. This value can be null. |
|
CreatedBy |
integer |
ID of the user who created this case. Read only. |
|
CreationDate |
DateTime |
Indicates when this object was created. Read only. |
|
LastModifiedBy |
integer |
ID of the user who last modified the object. Read only. |
|
LastModifiedDate |
DateTime |
Date the last time the object was modified. Read only. |
|
LastActivityDate |
DateTime |
Date the last time the object was accessed in any way. Read only. |
|
LastModifiedBy |
integer |
ID of the user who last modified this case. Read only. |
|
IsLocked |
boolean |
Flag to indicate the case cannot be edited. This property is read only. |
|
CaseStatus |
string (100) |
The status of the case. Can be Open, Resolved, Re-opened, Escalated, or Closed. |
|
IsWatched |
boolean |
Flag to indicate this record's update stream is watched. |
|
ReviewDate |
DateTime |
Date and time this record needs to be reviewed. |
|
RelatedParentId |
integer |
ID of the object this case is related to (a person or organization). |
|
RelatedParentObject |
string (100) |
Indicate if the parent is an organization or person object. |
|
CaseAge |
integer |
In days how old the case is. |
|
Contact |
contact |
Contact object of the person identified as the case contact. |
|
AttachmentList |
List<AttachmentAssociate> |
A list of any attachment objects. |
|
Priority |
integer |
Sets the cases Priority field. Value matches the CasePriority lookup value. |
|
PriorityName |
string (100) |
Text of the priority. |
Get
Description
Returns the details of a specified case.
URL
https://{company}.bluecamroo.com/api/case/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the case 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 case object.
URL
https://{company}.bluecamroo.com/api/case/add
HTTP Method
POST
Parameters
A case object
Data Return
Returns the case 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 case object.
URL
https://{company}.bluecamroo.com/api/case/update
HTTP Method
A case object
Data Return
Returns the case 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 specified case.
URL
https://{company}.bluecamroo.com/api/case/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)
|