Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
contentManagement

Get content item by path.

Get a content item corresponding to the given path.

Path is specified in the required query parameter path. The path should be URL encoded. For example, to get "Acme Corp" folder of a user "user@sumo.com" you can use the following curl command:

curl https://api.sumologic.com/api/v2/content/path?path=/Library/Users/user%40sumo.com/Acme%20Corp

The absolute path to a content item should be specified to get the item. The content library has "Library" folder at the root level. For items in "Personal" folder, the base path is "/Library/Users/user@sumo.com" where "user@sumo.com" is the email address of the user. For example if a user with email address wile@acme.com has Rockets folder inside Personal folder, the path of Rockets folder will be /Library/Users/wile@acme.com/Rockets.

For items in "Admin Recommended" folder, the base path is "/Library/Admin Recommended". For example, given a folder Acme in Admin Recommended folder, the path will be /Library/Admin Recommended/Acme.

get/v2/content/path

Query parameters

pathstring required

Path of the content item to retrieve.

Response

Content item corresponding to the given path.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Identifier of the content item.

namestring required

The name of the content item.

itemTypestring required

Type of the content item. Supported values are:

  1. Folder
  2. Search
  3. Report (for old dashboards)
  4. Dashboard (for new dashboards)
  5. Lookups
parentIdstring required

Identifier of the parent content item.

permissionsstring[] required

List of permissions the user has on the content item.

descriptionstring

Description of the content item.

isScheduledboolean

Indicates whether the content item refers to scheduled search. This field is only relevant to Search content type.

Example response

{
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "000000000C1C17C6",
  "name": "Personal",
  "itemType": "Folder",
  "parentId": "0000000001C41EF2",
  "permissions": [
    "View",
    "GrantView",
    "Edit"
  ],
  "description": "Personal folder for John Doe"
}