Get all features

get

/crmRestApi/resources/11.13.18.05/iisFeatures

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • AltKey Finds feature with the specified alternate key.
      Finder Variables
      • FeatureCode; string; The unique code identifier of the feature.
    • PrimaryKey Find feature by the specified primary key.
      Finder Variables
      • FeatureCode; string; The feature code to find the feature.
      • FeatureId; integer; The feature identification number to find the feature.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActivationThreshold; integer; The activation threshold of the feature.
    • CreatedBy; string; The user who created the feature.
    • CreationDate; string; The date and time when the feature was created.
    • DatasufficiencyLevel; string; The data sufficiency level of the intelligent feature.
    • EmergingThreshold; integer; The emerging threshold of the feature.
    • FeatureCode; string; The unique code of the feature.
    • FeatureDescription; string; The description of the feature.
    • FeatureId; integer; The feature identification number.
    • FeatureName; string; The name of the feature.
    • FeatureOwner; string; The owner of the feature.
    • FeatureOwnerName; string; The owner name of the feature.
    • FeatureResource; string; The resource of the feature.
    • FeatureStatus; string; The status of the feature.
    • IsActiveByDefaultFlag; boolean; The active by default status of the feature.
    • LastUpdateDate; string; Indicates the date and time of the last update to the feature.
    • LastUpdateLogin; string; The login of the user who last updated the feature.
    • LastUpdatedBy; string; The user who last updated the feature.
    • MRGReport; string; Most recently generated report of the feature.
    • MRGReportId; integer; Most recently generated report identification number of the feature.
    • ReviewInProgressFlag; boolean; The review status of the feature.
    • SelectedToEnableFlag; boolean; The selected attribute to enable status of the intelligent feature.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : iisFeatures
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : iisFeatures-item-response
Type: object
Show Source
Nested Schema : Feature Data Sufficiency Reports
Type: array
Title: Feature Data Sufficiency Reports
The intelligence onboarding reports resources lets you view and add data sufficiency check reports.
Show Source
Nested Schema : Intelligence in Sales Feature Rules
Type: array
Title: Intelligence in Sales Feature Rules
The intelligence feature rules resource lets you view and add the feature rules.
Show Source
Nested Schema : iisFeatures-DatasufficiencyReports-item-response
Type: object
Show Source
Nested Schema : iisFeatures-FeatureRules-item-response
Type: object
Show Source
Back to Top