Cmdlets for SuiteCRM

Build 24.0.9060

Alerts

Create, update, delete, and query the Alerts of your SuiteCRM account

Table Specific Information

Select

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

SELECT * FROM Alerts WHERE Name LIKE '%test%' 

Insert

Create Alerts by specifying any writable column.

INSERT INTO Alerts (Name, Type, [Target Module]) VALUES ('Urgent', 'Important', 'Opportunities')

Update

You can update any writable Alert column, by specifying the Id.

UPDATE Alerts SET [Is read] = true WHERE Id = 'Test123' 

Delete

Remove an Alert specifying the Id.

DELETE FROM Alerts WHERE Id = '1000'

Columns

Name Type ReadOnly Description
ID [KEY] String False

The unique identifier of the alert.

Assignedto String False

The Id of the user assigned to the record.

AssignedUserId String True

The user name of the user assigned to the record.

CreatedById String True

The Id of the user who created the record.

CreatedByName String True

The name of the user who created the record.

DateCreated Datetime True

The date the record was created.

DateModified Datetime True

The date the record was last modified.

Deleted Bool False

The record deletion indicator.

Description String False

Text of the alert

IsRead Bool False

Whether the alert has been read

ModifiedById String True

The Id of the user who last modified the record.

ModifiedByName String True

The name of the user who last modified the record.

Name String False

Name assigned to the alert

TargetModule String False

Which SuiteCRM module the alert is for

Type String False

Type of alert

UrlRedirect String False

The URL the alert redirects to

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