Jump to

• Request
• Response

Retrieve a list of folders

get

/api/rest/2.0/assets/sms/folders

Retrieves all folders that match the criteria specified by the request parameters.

Request

Supported Media Types

• application/json

Query Parameters

• count: integer
  ISmsFolderService_Parameter_Search_count_Description
• depth: string
  ISmsFolderService_Parameter_Search_depth_Description
• includeArchived: boolean
  ISmsFolderService_Parameter_Search_includeArchived_Description
• includeAvailable: boolean
  ISmsFolderService_Parameter_Search_includeAvailable_Description
• lastUpdatedAt: integer
  ISmsFolderService_Parameter_Search_lastUpdatedAt_Description
• orderBy: string
  ISmsFolderService_Parameter_Search_orderBy_Description
• page: integer
  ISmsFolderService_Parameter_Search_page_Description
• search: string
  ISmsFolderService_Parameter_Search_search_Description

Back to Top

Response

Supported Media Types

• application/json

200 Response

ISmsFolderService_StatusCode_Search_200_Description

Body ()

Root Schema : QueryResultFolder

Type: object

Title: QueryResultFolder

Show Source

• elements: array elements
  Array of folders.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The asset's type in Eloqua.

{
    "title":"QueryResultFolder",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of folders.",
            "items":{
                "$ref":"#/definitions/FolderRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of folders.

Show Source

• Array of: object Folder
  Title: Folder

{
    "type":"array",
    "description":"Array of folders.",
    "items":{
        "$ref":"#/definitions/FolderRest20"
    }
}

Nested Schema : Folder

Type: object

Title: Folder

Show Source

• archive: string
  Whether or not the folder is archived.
• createdAt: string
  Read Only: true

  The date and time the folder was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the folder.
• currentStatus: string
  The asset's current status. This is a read-only property.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description: string
  The description of the folder.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the folder.
• id: string
  Read Only: true

  Id of the folder. This is a read-only property.
• isSystem: string
  Read Only: true

  Whether or not the folder is a system folder.
• name: string
  The name of the folder.
• permissions: array permissions
  The permissions for the folder granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  The date and time the folder is scheduled for.
• sourceTemplateId: string
  Id of the source template.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the folder was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the folder.

{
    "title":"Folder",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the folder. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The asset's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The name of the folder."
        },
        "description":{
            "type":"string",
            "description":"The description of the folder."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the folder granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the folder."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the folder was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the folder."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the folder was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the folder is scheduled for."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "isSystem":{
            "type":"string",
            "readOnly":true,
            "description":"Whether or not the folder is a system folder."
        },
        "archive":{
            "type":"string",
            "description":"Whether or not the folder is archived."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the folder granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the folder granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top