Get all balance consumption criteria
get
/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria
Request
Path Parameters
-
BalanceCode(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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
finder: string
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- BalanceCriteriaAltKey Finds the subscription balance consumption criterion with the specified alternative key.
Finder Variables- BalanceCriteriaNumber; string; The balance criteria number used to find balance consumption criteria alternative key.
- PrimaryKey Finds the subscription balance consumption criterion with the specified primary key.
Finder Variables- BalanceCriteriaId; integer; The unique identifier of the subscription balance consumption criterion.
- BalanceCriteriaAltKey Finds the subscription balance consumption criterion with the specified alternative key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- BalanceCriteriaId; integer; The consumption criteria identifier of the subscription balance code.
- BalanceCriteriaNumber; string; The consumption criteria number of the subscription balance code.
- BalanceCriteriaStatus; string; The status of the subscription balance consumption criterion.
- BalanceCriteriaUsage; string; The usage condition of subscription balance consumption criterion.
- CreatedBy; string; The user who created the subscription balance consumption criterion.
- CreationDate; string; The date when the subscription balance consumption criterion was created.
- CriteriaPrecedence; integer; The date when the subscription balance consumption criterion was last updated.
- LastUpdateDate; string; The date when the subscription balance consumption criterion was last updated.
- LastUpdateLogin; string; The login of the user who last updated the subscription balance consumption criterion.
- LastUpdatedBy; string; The user who has last updated the subscription balance consumption criterion.
- ObjectVersionNumber; integer; The object version number updated after every update of a subscription balance consumption criterion.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
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 : subscriptionBalanceCodes-consumptionCriteria
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceCodes-consumptionCriteria-item-response
Type:
Show Source
object-
BalanceCriteriaDescription: string
Title:
DescriptionMaximum Length:300The description of subscription balance consumption criterion. -
BalanceCriteriaId: integer
(int64)
The consumption criteria identifier of the subscription balance code.
-
BalanceCriteriaNumber: string
Title:
CriteriaMaximum Length:120The consumption criteria number of the subscription balance code. -
BalanceCriteriaStatus: string
Title:
StatusMaximum Length:30Default Value:ORA_OSS_DRAFTThe status of the subscription balance consumption criterion. -
BalanceCriteriaUsage: string
Title:
UsageMaximum Length:30The usage condition of subscription balance consumption criterion. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the subscription balance consumption criterion. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the subscription balance consumption criterion was created. -
CriteriaPrecedence: integer
Title:
SequenceThe date when the subscription balance consumption criterion was last updated. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription balance consumption criterion was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who has last updated the subscription balance consumption criterion. -
LastUpdateLogin: string
Maximum Length:
32The login of the user who last updated the subscription balance consumption criterion. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance consumption criterion.
-
subscriptionBalancePredicates: array
Subscription Balance Condition Predicates
Title:
Subscription Balance Condition PredicatesThe subscription balance predicates resource is used to view, create, update, and delete a balance predicate.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Balance Condition Predicates
Type:
arrayTitle:
Subscription Balance Condition PredicatesThe subscription balance predicates resource is used to view, create, update, and delete a balance predicate.
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 : subscriptionBalanceCodes-consumptionCriteria-subscriptionBalancePredicates-item-response
Type:
Show Source
object-
BalanceAttributeId: integer
(int64)
The unique identifier of the subscription balance consumption attribute.
-
BalanceAttributeName: string
Title:
Attribute NameMaximum Length:240The name of the subscription balance consumption attribute. -
BalanceCriteriaId: integer
(int64)
The balance criteria identifier of subscription balance consumption predicate.
-
BalanceObjectId: integer
(int64)
The balance object identifier of subscription balance consumption predicate.
-
BalanceObjectName: string
Title:
Object NameMaximum Length:120The balance object name of subscription balance consumption predicate. -
BalancePredicateCharacterValue: string
Title:
ValueMaximum Length:600The balance predicate character value of subscription balance consumption predicate. -
BalancePredicateDateValue: string
(date)
Title:
ValueThe balance predicate date value of subscription balance consumption predicate. -
BalancePredicateDecimalValue: number
Title:
ValueThe balance predicate decimal value of subscription balance consumption predicate. -
BalancePredicateId: integer
(int64)
The unique identifier of the subscription balance consumption predicate.
-
BalancePredicateNumber: string
Title:
NumberMaximum Length:120The unique number of the subscription balance consumption predicate. -
BalancePredicateNumberValue: integer
Title:
ValueThe number value of the subscription balance consumption predicate. -
BalancePredicateOperator: string
Title:
OperatorMaximum Length:30The operator value of the subscription balance consumption predicate. -
BalancePredicateSequence: integer
Title:
SequenceThe balance predicate sequence of the subscription balance consumption predicate. -
BalancePredicateSortBy: string
Title:
Sort OrderMaximum Length:30The sort by criterion of the subscription balance consumption predicate. -
BalancePredicateTimeValue: string
(date-time)
Title:
ValueThe time value of the subscription balance consumption predicate. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the subscription balance consumption predicate. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the subscription balance consumption predicate was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription balance consumption predicate was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who has last updated the subscription balance consumption predicate. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription balance consumption predicate. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe object version number of the subscription balance consumption predicate. -
SourceType: string
Title:
Source TypeMaximum Length:30Default Value:ORA_OSS_USERThe source type of the subscription balance predicate.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source