Skip to main content

Create a Data Classification Plan​

Select

SaaS
Customer Managed

Create a Data Classification Plan

Request Body
  • name string

    Name of Data Classification Plan

  • threatAnalysis int32

    Enables\Disables Threat Analysis support for DC Plan

  • application string

    Possible values: [NOT_AVAILABLE, FILE_STORAGE_OPTIMIZATION, SENSITIVE_DATA_GOVERNANCE, CASE_MANAGER, CONTENT_INDEXING, THREAT_ANALYSIS]

    Content indexing target app

  • indexServer object
  • id int32
  • name string
  • contentAnalyzer object[]

    Content Analyzer Id`s for Entity Detection

  • id int32
  • name string
  • contentIndexing object

    Create Content Indexing Policy Model for DC Plan

  • extractTextFromImage boolean

    Enable OCR in Data Classification Plan

  • exactSearch boolean

    Enable Exact Seach in Data Classification Plan

  • copyPrecedence int32

    Set Content Indexing Copy Precedence

  • searchType ContentIndexingOperationType

    Possible values: [METADATA, METADATA_CONTENT, METADATA_CONTENT_PREVIEW]

    Describes the Content Indexing Operation Type for Data Classification Plan

  • contentLanguage DCPlanOCRLanguage

    Possible values: [NONE, ENGLISH, HEBREW, SPANISH, FRENCH, ITALIAN, DANISH]

    OCR Languages Supported By DC Plan

  • fileFilters object
  • includeDocTypes string
  • excludePaths string[]
  • minDocSize int32
  • maxDocSize int32

    Possible values: <= 500

  • backupCopy object[]
  • copyId int32
  • storagePoolId int32
  • entityDetection object

    Entity Extraction Model for Data Classification Plan

  • entities object[]

    Entity TagId for Extraction

  • id int32
  • name string
  • classifiers object[]

    Classifier TagId For Extraction

  • id int32
  • name string
  • copyPrecendence int32
  • schedule object

    Describes the Schedule object for Data Classification Plan

  • name string
  • pattern object

    Used to describe the frequency of backup

  • scheduleFrequencyType string

    Possible values: [MINUTES, DAILY, WEEKLY, MONTHLY, YEARLY]

    Default value: DAILY

    schedule frequency type

  • frequency int32

    Possible values: >= 1

    Default value: 1

    Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months

  • weeklyDays string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

    Days of the week for weekly frequency

  • dayOfMonth int32

    Possible values: >= 1 and <= 31

    Day on which to run the schedule, applicable for monthly, yearly

  • weekOfMonth string

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    Specific week of a month

  • dayOfWeek string

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

  • monthOfYear string

    Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]

  • startTime int32

    Default value: 75600

    start time of schedule in seconds for daily, weekly, monthly, yearly frequency

  • startDate int32

    start date of schedule in epoch format

  • exceptions object[]

    Exceptions to when a schedule should not run, either in dates or week of month and day

  • onDates int32[]

    Possible values: >= 1 and <= 31

    list of dates in a month. For ex: 1, 20

  • onWeekOfTheMonth string[]

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST]

    On which week of month, for ex: FIRST, LAST

  • onDayOfTheWeek string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, DAY, WEEKDAY, WEEKEND_DAYS]

    On which days, for ex: MONDAY, FRIDAY

Responses

Created

Schema
  • plan object
  • id int32
  • GUID string
  • name string
  • errors object[]
  • component string

    Plan Entity for which error occured

  • errorCode int32

    Error Code for plan

  • errorMessage string

    Error message for plan

POST /v4/dcplan

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "name": "string",

  "threatAnalysis": true,

  "application": "NOT_AVAILABLE",

  "indexServer": {

    "id": 0,

    "name": "string"

  },

  "contentAnalyzer": [

    {

      "id": 0,

      "name": "string"

    }

  ],

  "contentIndexing": {

    "extractTextFromImage": true,

    "exactSearch": true,

    "copyPrecedence": 0,

    "searchType": "METADATA",

    "contentLanguage": "NONE",

    "fileFilters": {

      "includeDocTypes": "string",

      "excludePaths": [

        "string"

      ],

      "minDocSize": 0,

      "maxDocSize": 0

    },

    "backupCopy": [

      {

        "copyId": 0,

        "storagePoolId": 0

      }

    ]

  },

  "entityDetection": {

    "entities": [

      {

        "id": 0,

        "name": "string"

      }

    ],

    "classifiers": [

      {

        "id": 0,

        "name": "string"

      }

    ],

    "copyPrecendence": 0

  },

  "schedule": {

    "name": "string",

    "pattern": {

      "scheduleFrequencyType": "DAILY",

      "frequency": 1,

      "weeklyDays": [

        "SUNDAY"

      ],

      "dayOfMonth": 0,

      "weekOfMonth": "FIRST",

      "dayOfWeek": "SUNDAY",

      "monthOfYear": "JANUARY",

      "startTime": 75600,

      "startDate": 0,

      "exceptions": [

        {

          "onDates": [

            0

          ],

          "onWeekOfTheMonth": [

            "FIRST"

          ],

          "onDayOfTheWeek": [

            "SUNDAY"

          ]

        }

      ]

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/DCPlan' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "threatAnalysis": true,
  "application": "NOT_AVAILABLE",
  "indexServer": {
    "id": 0,
    "name": "string"
  },
  "contentAnalyzer": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "contentIndexing": {
    "extractTextFromImage": true,
    "exactSearch": true,
    "copyPrecedence": 0,
    "searchType": "METADATA",
    "contentLanguage": "NONE",
    "fileFilters": {
      "includeDocTypes": "string",
      "excludePaths": [
        "string"
      ],
      "minDocSize": 0,
      "maxDocSize": 0
    },
    "backupCopy": [
      {
        "copyId": 0,
        "storagePoolId": 0
      }
    ]
  },
  "entityDetection": {
    "entities": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "classifiers": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "copyPrecendence": 0
  },
  "schedule": {
    "name": "string",
    "pattern": {
      "scheduleFrequencyType": "DAILY",
      "frequency": 1,
      "weeklyDays": [
        "SUNDAY"
      ],
      "dayOfMonth": 0,
      "weekOfMonth": "FIRST",
      "dayOfWeek": "SUNDAY",
      "monthOfYear": "JANUARY",
      "startTime": 75600,
      "startDate": 0,
      "exceptions": [
        {
          "onDates": [
            0
          ],
          "onWeekOfTheMonth": [
            "FIRST"
          ],
          "onDayOfTheWeek": [
            "SUNDAY"
          ]
        }
      ]
    }
  }
}'