getChildren
If you use the skipChildCapId parameter, the function excludes any child record whose record ID object is skipChildCapId.
Version
1.4
Parameters
| Parameter | Type | Description |
|---|---|---|
| pCapType | string | Four level record type. Must contain 3 slash (/) characters. Do not add spaces before or after slashes. You can use the asterisk (*) as a wildcard to match all entries for a given level. |
| pParentCapId (optional) | CapIDModel | Record ID object for parent record. Use null if skipChildCapId parameter is used. |
| skipChildCapId (optional) | CapIDModel | Record ID object of child record to exclude. |
Returns
Returns all child records whose record type matches pCapType, as an array of record ID objects. If the pParentCapId parameter is used, returns child records of the record whose record ID object is pParentCapId.
Notes
If the skipChildCapId parameter is used, the function excludes any child record whose record ID object is skipChildCapId.
See also
childGetByCapType