Loading ...

REST API: Case Overview | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Cases » REST API: Case Overview
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 13

REST API: Case Overview

0 
 /5
0 (0votes)

Case Properties

A case (or issue) object is any query, request for change, problem, bug, suggestion or off-specification raised during the project. It can be about anything to do with the project. It includes the Issue ID that is used to make reference to the particular case throughout the system. Each Issue ID is unique and automatically generated by the Communifire system.

Attributes Notes Data type
AssignedToUserDislplayName
 Display name of the user to whom the issue has been assigned. string
AssignedToUserID ID of the user to whom the issue has been assigned. int
AssignedToUserProfileURL
 URL of the user's profile to whom the issue has been assigned. string
CommentCount Number of comments made on the issue. int
DateAssigned Issue's date of assignment to the user. datetime
DateCreated Issue's date of creation. datetime
DateStringTaskEnd Date and time specifying the case's due date. string
DateUpdated Date on which the issue was last updated. datetime
DateUpdatedText Date (string) on which the issue was last updated. string
IsCommented Specifies if comments have been made on the issue. bool
IssueComment Comments made on the issue. string
IssueDescription
 Brief description of the issue. string
IssueID ID value which uniquely identifies each issue in the Communifire.
Generated automatically. This cannot be changed.		 int
IssuePriorityID Priority ID; indicating the intensity of the issue. int
IssuePriorityName Priority name; indicating the intensity of the issue.
Values can be: High, Medium, Low etc.		 string
IssueStatusID Status ID; indicating the current status of the issue. int
IssueStatusName Status name; indicating the current status of the issue.
Values can be: New, Re-opened, Closed, Fixed, In-progress, Feedback Required.		 string
IssueTitle Title of the issue. string
IssueURL URL of the issue. string
LastUpdatedByUserDisplayName Display name of the user who last updated the issue. string
LastUpdatedByUserEmail Email ID of the user who last update the issue.  string
LastUpdatedByUserFirstName First name of the user who last updated the issue. string
LastUpdatedByUserID ID of the user who last updated the issue. int
LastUpdatedByUserLastName Last name of the user who last update the issue string
LastUpdatedByUserName User name of the user who last update the issue string
LastUpdatedByUserProfileURL URL of the user who last updated the issue. string
MilestoneID ID of the milestone after which the issue will be fixed. int
MilestoneTitle Title of the milestone after which the issue will be fixed. string
MilestoneUrl URL to directly browse to the milestone. string
ProjectID ID of the project under which the issue persists. int
ProjectSectionID ID of the project section under which the issue persists. int
ProjectSectionName
 Name of the project section under which the issue persists. string
ProjectTitle Title of the project under which the issue persists. string
ReportedByUserDisplayName Display name of the user who reported the issue. string
ReportedByUserEmail Email ID of the user who reported the issue. string
ReportedByUserID ID of the user who reported the issue. int
ReportedByUserName User name of the user who reported the issue. string
ReportedByUserProfileURL URL of the user who reported the issue. string
SpaceID ID of the space under which the issue is reported. int
SpaceName Name of space.  string
Tagname Name of the tag created or used, to easily locate that issue and other similar issues. string
UserID
 ID of the user who reported the issue. int
UserName User name of the user who reported the issue. string

Please Note Refer to REST API: Create Case forhow to create a new case via the REST API.

 

Wiki Index

Pages

Intranet Software