Get Data Classification Plan By ID
Select
Get Data Classification Plan details
Path Parameters
- planId int32 required
Id of the plan to fetch details
- 200
- 400
- 403
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
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 int32name stringindexServer object
id int32name stringentityDetection object
Entity Extraction Model for Data Classification Plan
entities object[]
Entity TagId for Extraction
id int32name stringclassifiers object[]
Classifier TagId For Extraction
id int32name stringcopyPrecendence int32contentIndexing object
Describes the Content Indexing attributes related to a Data Classification Plan
fileFilters object
includeDocTypes stringexcludePaths string[]minDocSize int32maxDocSize int32Possible values:
<= 500
backupCopy object[]
copyId int32Copy Id of Copy used for Content Indexing Job
copyName stringCopy Name of Copy used for Content Indexing
storagePoolId int32Storage Pool Id of Storage Pool Used for Content Indexing
storagePoolName stringStorage Pool Name of Storage Pool Used for Content Indexing
copyRetentionPeriod int32Rentention Period of Copy
storagePoolTypePossible values: [
DEDUPLICATION
,SECONDARY_COPY
,NON_DEDUPLICATION
,SCALE_OUT
]Type of Storage Pool
planId int32planType stringPossible values: [
Server
,Laptop
,FSIBMiVTL
,ExchangeJournal
,ExchangeUser
,Office365
,DataClassification
,Archiver
,CDM
,ObjectStore
,DLO
,Database
,Snap
,FSServer
,VSAServer
,Dynamics365
]storageType StorageTypePossible values: [
ALL
,DISK
,CLOUD
,HYPERSCALE
,TAPE
]storageSubType StorageSubTypePossible values: [
ALL
,IBMi_VTL
,ALL_EXCEPT_IBMi_VTL
,METALLIC
,METALLIC_CLOUD_STORAGE
,ALL_INCLUDING_METALLIC_CLOUD_STORAGE
,ALL_EXCEPT_METALLIC_CLOUD_STORAGE
]exactSearch booleanWhether Exact Search is enabled or disabled
extractTextFromImage booleanWhether Image Extraction is Enabled
contentLanguage DCPlanOCRLanguagePossible values: [
NONE
,ENGLISH
,HEBREW
,SPANISH
,FRENCH
,ITALIAN
,DANISH
]OCR Languages Supported By DC Plan
searchType ContentIndexingOperationTypePossible values: [
METADATA
,METADATA_CONTENT
,METADATA_CONTENT_PREVIEW
]Describes the Content Indexing Operation Type for Data Classification Plan
previewPath stringDescribes the Preview path for Content Indexed Data when search type is METADATA_CONTENT_PREVIEW
domainName stringAssociated Domain of user having access to preview path
userName stringAssociated user name of user having access to preview path
permissions object[]
id int32name stringassociatedEntities object[]
id int32name stringcount int32schedule object
Describes the Schedule object for Data Classification Plan
name stringpattern object
Used to describe the frequency of backup
scheduleFrequencyType stringPossible values: [
MINUTES
,DAILY
,WEEKLY
,MONTHLY
,YEARLY
]Default value:
DAILY
schedule frequency type
frequency int32Possible 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 int32Possible values:
>= 1
and<= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth stringPossible values: [
FIRST
,SECOND
,THIRD
,FOURTH
,LAST
]Specific week of a month
dayOfWeek stringPossible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
,DAY
,WEEKDAY
,WEEKEND_DAYS
]monthOfYear stringPossible values: [
JANUARY
,FEBRUARY
,MARCH
,APRIL
,MAY
,JUNE
,JULY
,AUGUST
,SEPTEMBER
,OCTOBER
,NOVEMBER
,DECEMBER
]startTime int32Default value:
75600
start time of schedule in seconds for daily, weekly, monthly, yearly frequency
startDate int32start 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
{
"id": 0,
"name": "string",
"threatAnalysis": true,
"targetApplication": "NOT_AVAILABLE",
"contentAnalyzer": [
{
"id": 0,
"name": "string"
}
],
"indexServer": {
"id": 0,
"name": "string"
},
"entityDetection": {
"entities": [
{
"id": 0,
"name": "string"
}
],
"classifiers": [
{
"id": 0,
"name": "string"
}
],
"copyPrecendence": 0
},
"contentIndexing": {
"fileFilters": {
"includeDocTypes": "string",
"excludePaths": [
"string"
],
"minDocSize": 0,
"maxDocSize": 0
},
"backupCopy": [
{
"copyId": 0,
"copyName": "string",
"storagePoolId": 0,
"storagePoolName": "string",
"copyRetentionPeriod": 0,
"storagePoolType": "DEDUPLICATION",
"planId": 0,
"planType": "Server",
"storageType": "ALL",
"storageSubType": "ALL"
}
],
"exactSearch": true,
"extractTextFromImage": true,
"contentLanguage": "NONE",
"searchType": "METADATA",
"previewPath": "string",
"domainName": "string",
"userName": "string"
},
"permissions": [
{
"id": 0,
"name": "string"
}
],
"associatedEntities": [
{
"id": 0,
"name": "string",
"count": 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"
]
}
]
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Requested Details not found
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}