1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription AI Features

Get all product churn features

get

/crmRestApi/resources/11.13.18.05/subscriptionAiFeatures

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:

    • PrimaryKey: Finds the product churn features with the specified Subscription Product ID
      Finder Variables:
      • SubscriptionProductPuid; string; The unique identifier of the subscription product.
    • SubscriptionProductPuidAltKey: Finds the product churn features with the specified Subscription Product PUID
      Finder Variables:
      • SubscriptionProductPuid; string; The unique identifier of the subscription product.
  • 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:
    • AccountAreaCode; string; The area code associated with the acount.
    • AccountAutoRenewalFlag; boolean; Indicates if the account should be renewed automatically.
    • AccountAverageLastQtrBillAmount; number; The average last quarter bill amount for the account.
    • AccountAverageLastSixmthBillAmount; number; The six months average bill amount for the account.
    • AccountAverageLastYearBillAmount; number; The average bill amount for the account over the last year.
    • AccountBalance; number; The current balance of the account.
    • AccountChildIdList; string; The list with the account children.
    • AccountChildList; string; A list with the account children.
    • AccountCsmIdentifiedFlag; boolean; Indicates if the account is CSM identified.
    • AccountHasChildFlag; boolean; Indicates if the account has a child.
    • AccountLength; string; The length of the account.
    • AccountOpportunitiesLost; number; The number of opportunties lost by the acount.
    • AccountOpportunitiesOpen; number; The number of open opportunities associated with the account.
    • AccountOverdueInvoices; number; The number of overdue invoices for the acount.
    • AccountParent; string; The parent of the account.
    • AccountParentId; string; The unique identifier of the account parent.
    • AccountProductCount; number; The number of account products.
    • AccountProductDowngrades; number; The downgrades for the account product.
    • AccountProductTerminations; number; The terminations associated with the account product.
    • AccountStartDate; string; The start date of the account.
    • AccountState; string; The state associated with the acount.
    • AccountTotalSrs; number; The total service requests logged against the account.
    • AccountType; string; The type of the account.
    • AverageRenewalDuration; number; The average duration of renewal for the product.
    • BillToAccount; string; The bill to account assciated with the subscription.
    • BillToAccountId; integer; The unique identifier of the bill to account.
    • BillToSite; string; The bill to address.
    • BillToSiteUseId; integer; The unique identifier of the bill to side.
    • Churn; string; The churn for the subscritpion.
    • CloseReason; string; The reason to close the subscritpion.
    • ClosedDate; string; The date when the subscription was closed.
    • CorpCurrencyCode; string; The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • CurcyConvRateType; string; The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
    • CurrencyCode; string; The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
    • EndDate; string; The date when the subscription ends.
    • InventoryItemId; integer; The unique identifier for the inventory item.
    • InvoicingRule; string; The rule followed for invoicing the suscription.
    • InvoicingRuleId; integer; The unique identifier of the invoicing rule.
    • ItemNumber; string; The alternate unique identifier of the item.
    • ItemUOM; string; The unit of measure for the item.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • MonthlyRecurringRevenue; number; The monthly recurring revenue for the subscription.
    • PaymentMethod; string; The payment method associated with the subscription.
    • PaymentTerms; string; The terms of payment for the subscription, if any.
    • PaymentTermsId; integer; The unique identifier of the payment terms.
    • PrimaryParty; string; The primary party associated with the subscription.
    • PrimaryPartyId; integer; The unique identifier of the primary party.
    • ProductAnnivPricingFlag; boolean; The annual pricing of the product.
    • ProductBillingFrequency; string; The frequency of the product billing.
    • ProductBreachedRequests; number; The number of breached requests for the product.
    • ProductEvergreenFlag; boolean; Indicates if this is an evergreen product.
    • ProductName; string; The name of the product.
    • ProductNetPrice; number; The net price of the product subscribed.
    • ProductPastRenewals; number; The number of product renewals in the past.
    • ProductUsageChange; number; The Product Usage Change
    • Quantity; number; The quantity associated with the suscription.
    • RenewalType; string; The renewal type for the subscription.
    • SalesProductType; string; The type of the sales product.
    • StartDate; string; The date when the subscription starts.
    • Status; string; The status of the product.
    • SubscriptionId; integer; The unique identifier of the subscription.
    • SubscriptionProductId; integer; The unique identifier of the subscription product.
    • SubscriptionProductPuid; string; The public unique identifier of the suscription product.
    • UsageChargesLastNinetyDays; number; The user charges in the last 90 days.
    • UsageChargesLastThirtyDays; number; The user charges in the last 30 days.
    • UsageChargesMthToDate; number; The user charges in the last month.
  • 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 : subscriptionAiFeatures
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : subscriptionAiFeatures-item-response
Type: object
Show Source
Back to Top