Cmdlets for SuiteCRM

Build 24.0.9060

Cases

Create, update, delete, and query the SuiteCRM cases

Table Specific Information

Select

You can query the Cases table using any criteria in the WHERE clause. The cmdlet will use the SuiteCRM API to filter the results.

SELECT * FROM Cases WHERE Priority LIKE 'P2' 

Insert

Create a Case by specifying any writable column.

INSERT INTO Cases (Subject, Type, Number) VALUES ('New Tracker', 'Adminitration', 71)

Update

You can update any Case column that is writable, by specifying the Id.

UPDATE Cases SET Status = 'Closed_Closed' WHERE Id = 'Test123' 

Delete

Delete a Case by specifying the Id.

DELETE FROM Cases WHERE Id = '10003'

Columns

Name Type ReadOnly Description
ID [KEY] String False

The unique identifier for the record.

AccountID String False

The Id of the associated account.

AccountName String False

The name of the associated account.

account_name1 String True

A second account for the case

Address String True

Address from Google Maps of the case.

AssignedUserId String False

The user Id assigned to the record.

AssignedUserName String True

The name of the user assigned to the record.

CaseAttachments String True

A display of case attachments

CaseUpdatesThreaded String False

A list of the case updates

Createdbycontact String True

The user name of the user who created the case contact.

CreatedById String False

The Id of the user who created the record.

CreatedByName String False

The user name of the user who created the record.

DateCreated Datetime False

The date the record was created.

DateModified Datetime False

The date the record was last modified.

Deleted Bool False

Record deletion indicator.

Description String False

The full text of the note.

GeocodeStatus String True

Geocode from Google Maps of the case.

InternalUpdate Bool False

Whether the update is internal.

Latitude Double True

Latitude from Google Maps of the case.

LBL_CONTACT_CREATED_BY_ID String True

The User that created the case's contact

Longitude Double True

Longitude from Google Maps of the case.

ModifiedById String False

The Id of the user who last modified the record.

ModifiedByName String False

The user name who last modified the record.

Number Int False

The user-visible unique identifier for the case.

Priority String False

The priority of the case.

Resolution String False

The resolution of the case.

State String False

State the case is left in

The allowed values are OPen, Closed.

Status String False

The status of the case.

Subject String False

The short description of the bug.

Suggestions String True

Collection of suggestions left for the case.

Type String False

The type of case.

Updateattachmentform String True

The HTML text for the case's update attachment

UpdateText String True

Text associated with an update on the case.

WorkLog String False

Free-form text used to denote activities of interest.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Rows@Next String

Identifier for the next page of results. Do not set this value manually.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060