Skip to main content

Perform Office 365 Sharepoint Restore​

Select

SaaS
Customer Managed

Perform Office 365 Sharepoint Restore

Path Parameters
  • appId int32 required

    Commvault Sharepoint app id

Request Body
  • ifDocumentExists string

    Possible values: [SKIP, UNCONDITIONALLY_OVERWRITE]

    Default value: SKIP

  • deletedItems boolean

    Include deleted items on Restore

  • additionalRestoreOption string

    Possible values: [RESTORE_ACLS_ONLY, RESTORE_WORKFLOW_DEFINITION_AND_ALERTS_ONLY]

  • latestVersion boolean

    Default value: true

    Restore latest version only

  • skipLookupMetadata boolean

    Skip lookup metadata on sharepoint restore

  • sites object[]
  • GUID string required
  • name string required
  • type string

    Possible values: [SUBSITE, SITE]

    Type of the sharepoint item

  • category object
  • GUID string

    Custom category GUID(Optional)

  • conditions object[]

    Conditions for custom category.

  • ruleOperator string required

    Possible values: [CONTAINS, REGEX, STARTS_WITH, ENDS_WITH, BEFORE, AFTER, ON_OR_BEFORE, ON_OR_AFTER, LESS, GREATER, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUALS, NOT_EQUAL]

    Operator of the custom category condition.

  • ruleValue string required

    Value of the custom category condition rule.

  • ruleName string required

    Possible values: [GEO_LOCATION, LOCALE, SITE_COLLECTION_CLASSIFICATION, SITE_COLLECTION_URL, SITE_DESCRIPTION, SITE_URL, TIME_ZONE, SP_PROPERTY_BAG]

    Sharepoint custom category rule name.

  • propertyBagName string

    Sharepoint property bag name.

  • propertyBagType string

    Possible values: [DATE, DATETIME, NUMBER, STRING, TIME]

    Type of the sharepoint property bag value.

Responses

OK

Schema
  • taskId int32
  • jobIds string[]

    JobIds for the immediate run request

POST /v4/office365/sharepoint/:appid/restore

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
appId — path required
Body
{

  "ifDocumentExists": "SKIP",

  "deletedItems": true,

  "additionalRestoreOption": "RESTORE_ACLS_ONLY",

  "latestVersion": true,

  "skipLookupMetadata": true,

  "sites": [

    {

      "GUID": "string",

      "name": "string",

      "type": "SUBSITE"

    }

  ],

  "category": {

    "GUID": "string",

    "conditions": [

      {

        "ruleOperator": "CONTAINS",

        "ruleValue": "string",

        "ruleName": "GEO_LOCATION",

        "propertyBagName": "string",

        "propertyBagType": "DATE"

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Sharepoint/:appId/Restore' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "ifDocumentExists": "SKIP",
  "deletedItems": true,
  "additionalRestoreOption": "RESTORE_ACLS_ONLY",
  "latestVersion": true,
  "skipLookupMetadata": true,
  "sites": [
    {
      "GUID": "string",
      "name": "string",
      "type": "SUBSITE"
    }
  ],
  "category": {
    "GUID": "string",
    "conditions": [
      {
        "ruleOperator": "CONTAINS",
        "ruleValue": "string",
        "ruleName": "GEO_LOCATION",
        "propertyBagName": "string",
        "propertyBagType": "DATE"
      }
    ]
  }
}'