folders_global
Creates, updates, deletes, gets or lists a folders_global
resource.
Overview
Name | folders_global |
Type | Resource |
Id | sumologic.content.folders_global |
Fields
The following fields are returned by SELECT
queries:
- getGlobalFolderAsync
An asynchronous job to get a list of all content items been scheduled.
Name | Datatype | Description |
---|---|---|
id | string | Identifier to get the status of an asynchronous job. (example: C03E086C137F38B4) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
getGlobalFolderAsync | select | region | isAdminMode | Schedule an asynchronous job to get Global View. Global View contains all top-level content items that a user has permissions to view in the organization. User can traverse the top-level folders using [GetFolder API] to get rest of the content items. Make sure you set isAdminMode header parameter to true when traversing top-level items.Global View is not a real folder, therefore there is no folder identifier associated with it. You get back a identifier of asynchronous job in response to this endpoint. See [Asynchronous-Request] section for more details on how to work with asynchronous request. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
isAdminMode | string | Set this to "true" if you want to perform the request as a Content Administrator. |
SELECT
examples
- getGlobalFolderAsync
Schedule an asynchronous job to get Global View. Global View contains all top-level content items that a user has permissions to view in the organization. User can traverse the top-level folders using [GetFolder API] to get rest of the content items. Make sure you set isAdminMode
header parameter to true
when traversing top-level items.
Global View is not a real folder, therefore there is no folder identifier associated with it.
You get back a identifier of asynchronous job in response to this endpoint. See [Asynchronous-Request] section for more details on how to work with asynchronous request.
SELECT
id
FROM sumologic.content.folders_global
WHERE region = '{{ region }}' -- required
AND isAdminMode = '{{ isAdminMode }}'
;