Cmdlets for SuiteCRM

Build 24.0.9060

Employees

Create, update, delete, and query employees registered in the SuiteCRM project

Table Specific Information

Select

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

SELECT * FROM Employees WHERE Department = 'HR'

Insert

Create an Employee by specifying any writable column. 

INSERT INTO Employees ([First Name], [Last name], Title) VALUES ('Trucie', 'Dart', 'Eng.')

Update

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

UPDATE Employees SET Description = 'Updated description' WHERE Id = 'Test123'

Delete

Remove an Employee by specifying the Id. 

DELETE FROM Employees WHERE Id = 10003

Columns

Name Type ReadOnly Description
ID [KEY] String False

The unique identifier of the employee.

AcceptStatusC String True

The status fields for the call accept status of the employee.

AcceptStatusId String True

The Id of the accept status of the employee.

AcceptStatusM String True

The status fields for the meeting accept status of the employee.

AcceptStatusName String True

The name of the accept status of the employee.

AddressCity String False

The city in the address of the employee.

AddressCountry String False

The country in the address of the employee.

AddressPostalCode String False

The postal code in the address of the employee.

AddressState String False

The state in the address of the employee.

AddressStreet String False

The street address of the employee.

AuthenticationId String False

The Id used in authentication.

CreatedBy String True

The Id of the user who created the record.

CreatedByName String True

The user name of the user who created the record.

DateEntered Datetime True

The date the employee record was entered into the system.

DateModified Datetime True

The date the employee record was last modified.

Deleted Bool False

Whether the employee is deleted.

Department String False

The department of the employee.

Description String False

The description for the employee.

DisplayEmployeeRecord Bool False

Whether to show the employee.

EmailAddress String True

The alternate email address of the employee.

EmailClient String True

The link type of the email for the employee.

EmployeeStatus String False

The status of the employee.

ExternalAuthentication Bool False

Whether the employee only has external authentication available.

Fax String False

The fax of the employee.

FirstName String False

The first name of the employee.

Fullname String True

The full name of the employee.

GroupUser Bool False

Whether the employee is a group user.

HomePhone String False

The home phone number of the employee.

IMName String False

The Id of the instant messenger service used by the employee.

IMType String False

The type of the instant messenger service used by the employee.

IsAdministrator Bool False

Whether the employee is an admin.

IsUser Bool False

Whether the employee has a Sugar login.

LastName String False

The last name of the employee.

LBL_PRIMARY_GROUP Bool True

The primary security group the employee is assigned to.

LBL_REPORTS_TO_ID String False

The Id of who the employee reports to.

LBL_securitygroup_noninherit_id String True

The security group's non-inheritance id.

LBL_SECURITYGROUP_NONINHERITABLE Bool True

Whether the group is non inheritable.

Mobile String False

The mobile phone number of the employee.

ModifiedById String True

The Id of the user who last modified the record.

ModifiedByName String True

The user name of the user who last modified the record.

Name String False

The name of the employee.

NotifyonAssignment Bool False

Whether the employee can receive notifications.

Other String False

The alternate phone of the employee.

Password String False

The user hash of the employee.

Password_Last_Changed Datetime False

The date the password of the employee was last changed.

Photo String False

The Id of the picture.

PortalAPIUser Bool False

Whether the employee is a portal-only user.

Reportsto String True

The user name of who the employee reports to.

SecurityGroup String True

The security group's fields that are selected for non-inheritance.

Status String False

The status of the employee.

SystemGeneratedPassword Bool False

Whether the employee has a system-generated password.

Title String False

The title of the employee.

UserName String False

The username of the employee.

UserType String True

The user type of the employee.

WorkPhone String False

The work phone number of the employee.

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