Case¶

Defines a case within a channel.

Capabilities¶

Assignment and Deadlines¶

• Case.AssignedAt: Gets the date and time when the case was assigned.
• Case.AssignedTo: Gets or sets the identity of the user to whom the case is assigned.
• Case.DeadlineAt: Gets or sets the deadline date and time for the case.
• Case.Assign: Assigns the case to the specified identity.

Details¶

• Case.ChannelId: Gets the globally unique identifier of the channel to which the case belongs.
• Case.ContentType: Gets or sets the content type of the case.
• Case.Description: Gets or sets the description of the case.
• Case.Id: Gets the globally unique identifier of the case.
• Case.Number: Gets the tracking number of the case.
• Case.Subject: Gets or sets the subject of the case.

Lifecycle and Scheduling¶

• Case.ClosedAt: Gets the date and time when the case was closed.
• Case.IsClosed: Gets or sets the closed state of the case.
• Case.IsDeadlined: Gets a value indicating whether the case currently has a deadline.
• Case.NextReminderDate: Gets or sets the date and time of the next reminder notification.
• Case.Priority: Gets or sets the priority of the case.
• Case.SentReminders: Gets the number of reminder notifications that have been sent.

Audit¶

• Case.CreatedAt: Gets the date and time when the case was created.
• Case.CreatedBy: Gets the identity of the user who created the case.
• Case.UpdatedAt: Gets the date and time when the case was last updated.
• Case.UpdatedBy: Gets the identity of the user who last updated the case.

Classification and Tracking¶

• Case.Milestones: Gets the milestones associated with the case.
• Case.Profile: Gets the profile data of the case.
• Case.Tags: Gets or sets the tags assigned to the case.
• Case.AddProfile: Adds profile data to the case.
• Case.AddTag: Adds a tag to the case.
• Case.Move: Moves the case to the specified channel.
• Case.ProfileChanged: Notifies the system that the contents of the case profile property have changed.
• Case.RemoveTag: Removes a tag from the case.

Related Records¶

• Case.AddLink: Adds a link to the specified case, marking it as related.
• Case.Copy: Creates a new copy of the current case.
• Case.GetMessages: Gets an array of message IDs that were sent on this case.
• Case.GetWorkItems: Gets an array of work items that were started on this case.

Messaging¶

• Case.Reply: Sends a message attached to the case.