Cmdlets for SuiteCRM

Build 24.0.9060

EAPM

Create, update, delete, and query the EAPM (External API Module) entries in SuiteCRM

Table Specific Information

Select

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

SELECT * FROM EAPM WHERE Application LIKE 'Suite%'

Insert

Create an EAPM entry by specifying any writable column.

INSERT INTO EAPM ([App User Name], Application) VALUES ('Saved app', 'Test Application')

Update

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

UPDATE EAPM SET Connected = True WHERE Id = 'Test123' 

Delete

Delete an EAPM entry by specifying the Id.

DELETE FROM EAPM WHERE Id = '10003'

Columns

Name Type ReadOnly Description
ID [KEY] String False

Unique identifier for the external API.

APIData String False

Any API data that the external API may wish to store on a per-user basis.

AppPassword String False

The password of the external API.

AppUserName String False

The name of the external API.

Application String False

The application name of the external API.

AssignedUserId String False

The Id of the user assigned to the record.

Connected Bool False

Whether the external API has been validated.

ConsumerKey String False

The consumer key for the external API.

ConsumerSecret String False

The consumer secret for the external API.

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

The full text of the note.

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.

OAuthToken String False

The OAuth access token for the external API.

PleaseNote String True

The note for the external API.

SuiteCRMUser String True

The name of the user assigned to the record.

URL String False

The URL of the external API.

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