Skip to main content

Browse Restore Preview Records​

Browse records of a specific Salesforce object for restore preview. Supports filtering via whereClause and pagination via limit/offset.

Path Parameters
  • clientId integer required

    Client Id of the Salesforce organization

  • jobId integer required

    Job Id to preview

  • objectName string required

    Salesforce object name (e.g., Account, Contact)

  • pathId integer required

    Path Id for the object (must be >= -1)

Query Parameters
  • backupSetId integer required

    Backup Set Id for the Salesforce organization

  • limit integer

    Maximum number of records to return

  • offset integer

    Number of records to skip for pagination

Request Body

Request body containing optional filter criteria. The whereClause is a UTF-8 byte array representation of a JSON-encoded QueryBuilderBlock object.

Example QueryBuilderBlock JSON structure:

{
  "isAnd": true,
  "rules": [
    {
      "column": "Name",
      "condition": "CONTAINS",
      "stringParam1": "Test"
    }
  ]
}

Supported conditions: EQUALS, DOESNOTEQUALS, CONTAINS, DOESNOTCONTAINS, LESSTHAN, LESSTHANEQUAL, GREATERTHAN, GREATERTHANEQUAL

  • whereClause int32[]

    UTF-8 byte array of JSON-encoded QueryBuilderBlock filter to apply on records

  • whereClauseEncryptionType int32

    Encryption type for the where clause

Responses

OK

Schema
  • cacheId string

    Cache identifier for pagination

  • offset integer

    Current offset position

  • limit integer

    Maximum number of records returned

  • totalRecordCount integer

    Total count of records available

  • columns object[]

    Properties of all the columns

  • name string

    Column Name

  • dataField string
  • type string

    Column Type

  • recordsCount integer

    Number of records returned

  • records array[]

    Record data rows

Loading...