Skip to main content

Get Data Classification Plan By ID​

Select

SaaS
Customer Managed

Get Data Classification Plan details

Path Parameters
  • planId int32 required

    Id of the plan to fetch details

Responses

Success

Schema
  • id int32
  • name string
  • threatAnalysis boolean

    Whether Threat Analysis is enabled for plan

  • targetApplication string

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

    Content indexing target app

  • contentAnalyzer object[]

    Content Analyzer details for Data Classification plan

  • id int32
  • name string
  • indexServer object
  • id int32
  • name string
  • 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
  • contentIndexing object

    Describes the Content Indexing attributes related to a Data Classification Plan

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

    Possible values: <= 500

  • backupCopy object[]
  • copyId int32

    Copy Id of Copy used for Content Indexing Job

  • copyName string

    Copy Name of Copy used for Content Indexing

  • storagePoolId int32

    Storage Pool Id of Storage Pool Used for Content Indexing

  • storagePoolName string

    Storage Pool Name of Storage Pool Used for Content Indexing

  • copyRetentionPeriod int32

    Rentention Period of Copy

  • storagePoolType

    Possible values: [DEDUPLICATION, SECONDARY_COPY, NON_DEDUPLICATION, SCALE_OUT]

    Type of Storage Pool

  • planId int32
  • planType string

    Possible values: [Server, Laptop, FSIBMiVTL, ExchangeJournal, ExchangeUser, Office365, DataClassification, Archiver, CDM, ObjectStore, DLO, Database, Snap, FSServer, VSAServer, Dynamics365]

  • storageType StorageType

    Possible values: [ALL, DISK, CLOUD, HYPERSCALE, TAPE]

  • storageSubType StorageSubType

    Possible values: [ALL, IBMi_VTL, ALL_EXCEPT_IBMi_VTL, METALLIC, METALLIC_CLOUD_STORAGE, ALL_INCLUDING_METALLIC_CLOUD_STORAGE, ALL_EXCEPT_METALLIC_CLOUD_STORAGE]

  • exactSearch boolean

    Whether Exact Search is enabled or disabled

  • extractTextFromImage boolean

    Whether Image Extraction is Enabled

  • contentLanguage DCPlanOCRLanguage

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

    OCR Languages Supported By DC Plan

  • searchType ContentIndexingOperationType

    Possible values: [METADATA, METADATA_CONTENT, METADATA_CONTENT_PREVIEW]

    Describes the Content Indexing Operation Type for Data Classification Plan

  • previewPath string

    Describes the Preview path for Content Indexed Data when search type is METADATA_CONTENT_PREVIEW

  • domainName string

    Associated Domain of user having access to preview path

  • userName string

    Associated user name of user having access to preview path

  • permissions object[]
  • id int32
  • name string
  • associatedEntities object[]
  • id int32
  • name string
  • count 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

GET /v4/dcplan/:planid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
planId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/DCPlan/:planId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'