Resource.getList (Method)
Returns one or more structures, each containing information about an existing resource.
Returns:
Resource_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| AliasList | String | Comma-delimited list of aliases (alternate names) for this resource. |
| Category | ResourceCategory | Category for the resource. |
| Description | PlainText | Description of the resource. |
| EarlyLoadSourceArray | ResourceLoadStruct_Array | An array containing information for the early loading sources. |
| ID | ResourceID | ID of the resource. |
| InstallInstructions | String | User-provided notes and instructions for installing this resource package. |
| LateLoadSourceArray | ResourceLoadStruct_Array | An array containing information for the late loading sources. |
| Name | PlainText_NonNull_255 | Name of the resource. |
| PackagingDir | DirectoryPath_EmptyString | All files in this directory will be included when any object using this resource is exported. |
| Redistributable | Boolean | True if the resource license terms allow redistribution, false otherwise. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | ResourceID_0 | Optional. Defaults to '0'. | ID of a resource. If this value is 0, CommonSpot returns all records instead of just given resource ID. |
| name | ResourceName_EmptyString | Optional. Defaults to an empty string. | Name of a resource. If this value is empty string, CommonSpot returns all records instead of just given resource name. |
| searchString | String | Optional. Defaults to an empty string. | If specified, the string for which CommonSpot will search against. The search will compare the resource name and description fields. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to an empty string. | The operator used to perform the search; for example, 'Contains', 'Begins with', 'Equals', and so on. |
| orderBy | SQLOrderByClause_EmptyString | Optional. Defaults to 'Category, ItemPos'. | Order in which to return results. Default order is by category then item position. |
Context:
| License Requirements | None |
| Permission Requirements | (none) |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 1000103 | A valid search operator is required when specifying a search string. |
Notes:
None