Update a feature
patch
/crmRestApi/resources/11.13.18.05/iisFeatures/{FeatureCode}
Request
Path Parameters
-
FeatureCode(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AdditionalMetadata: string
The additional metadata of the feature.
-
DatasufficiencyReports: array
Feature Data Sufficiency Reports
Title:
Feature Data Sufficiency ReportsThe intelligence onboarding reports resources lets you view and add data sufficiency check reports. -
FeatureDescription: string
Maximum Length:
1024The description of the feature. -
FeatureName: string
Maximum Length:
512The name of the feature. -
FeatureOwnerName: string
Maximum Length:
200The owner name of the feature. -
FeatureRules: array
Intelligence in Sales Feature Rules
Title:
Intelligence in Sales Feature RulesThe intelligence feature rules resource lets you view and add the feature rules. -
FeatureStatus: string
Maximum Length:
100The status of the feature. -
IsActiveByDefaultFlag: boolean
Maximum Length:
1The active by default status of the feature. -
ReviewInProgressFlag: boolean
Maximum Length:
1The review status of the feature. -
SelectedToEnableFlag: boolean
Maximum Length:
1The selected attribute to enable status of the intelligent feature.
Nested Schema : Feature Data Sufficiency Reports
Type:
arrayTitle:
Feature Data Sufficiency ReportsThe intelligence onboarding reports resources lets you view and add data sufficiency check reports.
Show Source
Nested Schema : Intelligence in Sales Feature Rules
Type:
arrayTitle:
Intelligence in Sales Feature RulesThe intelligence feature rules resource lets you view and add the feature rules.
Show Source
Nested Schema : iisFeatures-DatasufficiencyReports-item-patch-request
Type:
Show Source
object-
AdditionalMetadata: string
The additional metadata of the Report.
Nested Schema : schema
Type:
Show Source
object-
ActivationThreshold: integer
(int64)
The activation threshold of the feature rule.
-
AdditionalMetadata: string
The additional metadata of the feature rule.
-
EmergingThreshold: integer
(int64)
The emerging threshold of the feature rule.
-
FeatureRuleName: string
Maximum Length:
1024The name of the feature rule.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : iisFeatures-item-response
Type:
Show Source
object-
ActivationThreshold: integer
(int64)
Read Only:
trueThe activation threshold of the feature. -
AdditionalMetadata: string
The additional metadata of the feature.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the feature. -
CreationDate: string
(date-time)
Read Only:
trueThe date and time when the feature was created. -
DatasufficiencyLevel: string
Read Only:
trueMaximum Length:32The data sufficiency level of the intelligent feature. -
DatasufficiencyReports: array
Feature Data Sufficiency Reports
Title:
Feature Data Sufficiency ReportsThe intelligence onboarding reports resources lets you view and add data sufficiency check reports. -
EmergingThreshold: integer
(int64)
Read Only:
trueThe emerging threshold of the feature. -
FeatureCode: string
Maximum Length:
200The unique code of the feature. -
FeatureDescription: string
Maximum Length:
1024The description of the feature. -
FeatureId: integer
(int64)
The feature identification number.
-
FeatureName: string
Maximum Length:
512The name of the feature. -
FeatureOwner: string
Maximum Length:
100The owner of the feature. -
FeatureOwnerName: string
Maximum Length:
200The owner name of the feature. -
FeatureResource: string
Maximum Length:
100The resource of the feature. -
FeatureRules: array
Intelligence in Sales Feature Rules
Title:
Intelligence in Sales Feature RulesThe intelligence feature rules resource lets you view and add the feature rules. -
FeatureStatus: string
Maximum Length:
100The status of the feature. -
IsActiveByDefaultFlag: boolean
Maximum Length:
1The active by default status of the feature. -
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time of the last update to the feature. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the feature. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the feature. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MRGReport: string
Read Only:
trueMost recently generated report of the feature. -
MRGReportId: integer
(int64)
Read Only:
trueMost recently generated report identification number of the feature. -
ReviewInProgressFlag: boolean
Maximum Length:
1The review status of the feature. -
SelectedToEnableFlag: boolean
Maximum Length:
1The selected attribute to enable status of the intelligent feature.
Nested Schema : Feature Data Sufficiency Reports
Type:
arrayTitle:
Feature Data Sufficiency ReportsThe intelligence onboarding reports resources lets you view and add data sufficiency check reports.
Show Source
Nested Schema : Intelligence in Sales Feature Rules
Type:
arrayTitle:
Intelligence in Sales Feature RulesThe intelligence feature rules resource lets you view and add the feature rules.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : iisFeatures-DatasufficiencyReports-item-response
Type:
Show Source
object-
AdditionalMetadata: string
The additional metadata of the Report.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the configuration for the AI data sufficiency job. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time when this configuration for the data sufficiency report is created. -
DataSufficiencyJobId: integer
(int64)
The job identification number of the data sufficiency report resource.
-
DataSufficiencyLevel: string
Read Only:
trueMaximum Length:32The data sufficiency level of the feature. -
DataSufficiencyReport: string
Read Only:
trueThe data sufficiency report of the feature. -
DataSufficiencyReportId: integer
(int64)
The report identification number of the AI data sufficiency report.
-
DataSufficiencyTotalScore: integer
(int64)
Read Only:
trueThe total score of the data sufficiency check for the feature. -
FeatureCode: string
Maximum Length:
200The unique code of the feature. -
FeatureOwner: string
Maximum Length:
100The owner of the feature. -
LastUpdateDate: string
(date-time)
Read Only:
trueIndicates the date and time of the last update to the configuration in the data sufficiency report. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the configuration in the data sufficiency report. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the configuration in data sufficiency report. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReportStatus: string
Read Only:
trueMaximum Length:100Default Value:DRAFTThe status of the report.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : iisFeatures-FeatureRules-item-response
Type:
Show Source
object-
ActivationThreshold: integer
(int64)
The activation threshold of the feature rule.
-
AdditionalMetadata: string
The additional metadata of the feature rule.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the feature rule. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time when the feature rule is created. -
EmergingThreshold: integer
(int64)
The emerging threshold of the feature rule.
-
FeatureCode: string
Maximum Length:
200The unique code of the feature. -
FeatureRuleCode: string
Maximum Length:
100The code of the feature rule. -
FeatureRuleId: integer
(int64)
The identification number of the feature rule.
-
FeatureRuleName: string
Maximum Length:
1024The name of the feature rule. -
FeatureRuleType: string
Maximum Length:
100The type of the feature rule. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe user who last updated the feature rule. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Indicates the date and time of the last update to the feature rule. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the feature rule. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DatasufficiencyReports
-
Parameters:
- FeatureCode:
$request.path.FeatureCode
The intelligence onboarding reports resources lets you view and add data sufficiency check reports. - FeatureCode:
- FeatureRules
-
Parameters:
- FeatureCode:
$request.path.FeatureCode
The intelligence feature rules resource lets you view and add the feature rules. - FeatureCode: