Get all child covered levels
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/childCoveredLevels
Request
Path Parameters
-
CoveredLevelPuid(required): string
The covered level PUID
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
-
SubscriptionProductPuid(required): string
The subscription product PUID.
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:- CoveredLevelPuidAltKey: Finds a child covered level with the specified child covered level PUID.
Finder Variables:- CoveredLevelPuid; string; The alternate primary identifier of the child covered level.
- PrimaryKey: Finds a child covered level with the specified child covered level ID.
Finder Variables:- CoveredLevelId; integer; The unique primary identifier of the child covered level.
- CoveredLevelPuidAltKey: Finds a child covered level with the specified child covered level PUID.
-
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:- AssetGroupId; integer; The unique identifier of the asset group.
- AssetId; integer; The unique identifier of the asset.
- AssetSerialNumber; string; The universal serial number associated with the asset.
- CalculatedCreditAmount; number; The calculated credit amount of the child covered level.
- CancelDescription; string; The cancel description associated with a child covered level.
- CanceledAmount; number; The amount that was cancelled.
- CloseDescription; string; The close description associated with a child covered level.
- ClosedAmount; number; The amount when the covered level 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.
- CoveredLevelId; integer; The unique identifier of the covered level.
- CoveredLevelPuid; string; The public unique identifier of the covered level.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CreditedAmount; number; The credited amount for the covered level.
- 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.
- CustomerAccountId; integer; The unique identifier of the customer account associated with child covered level.
- EndDate; string; The end date for the covered level.
- HierarchyTotal; number; The total when the covered level was closed.
- InventoryItemId; integer; The unique identifier of the inventory item.
- InvoiceText; string; The text to be included in the invoice.
- InvoicedAmount; number; The invoiced amount.
- ItemUnitOfMeasure; string; The unit of measure used by 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.
- OverrideCreditAmount; number; The override credit amount of the child covered level.
- ParentCoveredAssetId; integer; The unique identifier of the parent covered asset.
- ParentCoveredLevelId; integer; The parent level for the level.
- PartyId; integer; The unique identifier of the party associated with child covered level.
- PartySiteId; integer; The unique identifier of the party site associated with child covered level.
- PriceAsOf; string; The price of the covered level.
- PriceListId; integer; The unique identifier of the price list.
- PriceUnitOfMeasure; string; The unit of measure used by the item.
- PriceUnitOfMeasureName; string; The name of the unit of measure.
- PricingError; string; Any errors associated with the pricing.
- ProductGroupId; integer; The unique identifier of the product group.
- Quantity; number; The quantity for which the bill line was charged.
- RenewalType; string; The type of renewal.
- RenewedDate; string; The date when the covered level was renewed.
- RevenueOption; string; Revenue Option
- RollupTotal; number; The total when the covered level was closed.
- SerialNumber; string; The serial number of the child covered level.
- StartDate; string; The start date for the covered level.
- Status; string; The status of the covered level.
- StatusName; string; The description of the status.
- SubscriptionId; integer; The unique identifier of the associated subscription.
- SubscriptionProductId; integer; The unique identifier of the subscription product.
- SuppressedCreditAmount; number; The suppressed amount for the credit.
- SuspendCreditMethod; string; The suspend method for the credit after the covered level was closed.
- TaxAmount; number; The amount of tax to be deducted.
- TaxError; string; The tax error for the covered level.
- TotalContractValue; number; The total contract value
- Type; string; The type of the covered level.
-
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:
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.
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 : subscriptions-products-coveredLevels-childCoveredLevels
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:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-childCoveredLevels-item-response
Type:
Show Source
object
-
Address: string
Title:
Address
The address of the party site associated with child covered level. -
AssetGroupId: integer
(int64)
The unique identifier of the asset group.
-
AssetGroupName: string
Title:
Asset Group Name
The name of the asset group. -
AssetGroupNumber: string
Title:
Asset Group Number
The alternate identifier of an asset group. -
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Covered Level Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Covered Asset Serial Number
The universal serial number associated with the asset. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the child covered level. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancel description associated with a child covered level. -
CanceledAmount: number
The amount that was cancelled.
-
CanceledDate: string
(date)
Title:
Canceled Date
The date of cancellation. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason for cancellation. -
ClosedAmount: number
The amount when the covered level was closed.
-
ClosedDate: string
(date)
Title:
Covered Level Close Date
The date when the covered level was closed. -
CloseDescription: string
Title:
Covered Level Close Description
Maximum Length:2000
The close description associated with a child covered level. -
CloseReason: string
Title:
Covered Level Close Reason
Maximum Length:30
The reason when the covered level was closed. -
CorpCurrencyCode: string
Maximum Length:
15
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. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CoveredLevelName: string
Title:
Covered Level Name
Maximum Length:300
The name of the covered level. -
CoveredLevelParentPuid: string
The covered parent for the parent.
-
CoveredLevelPuid: string
Maximum Length:
120
The public unique identifier of the covered level. -
CoveredLevlName: string
Title:
Covered Level Name
The name of the covered level associated with child covered level. -
CoveredLevlNumber: string
Title:
Covered Level Number
The alternate identifier of the covered level associated with child covered level. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CreditedAmount: number
The credited amount for the covered level.
-
CurcyConvRateType: string
Maximum Length:
30
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
Maximum Length:
15
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. -
CustomerAccountId: integer
(int64)
The unique identifier of the customer account associated with child covered level.
-
CustomerName: string
Title:
Customer Account
The name of the customer associated with child covered level. -
CustomerNumber: string
Title:
Customer Account Number
The alternate unique identifier of the customer associated with child covered level. -
Description: string
Title:
Covered Level Description
The description of the covered level. -
Duration: integer
The duration for which the covered level is active.
-
EndDate: string
(date)
Title:
Covered Level End Date
The end date for the covered level. -
ExplodeAssetHierarchy: string
The explode hierarchy for the asset.
-
GenerateBillingSchedule: string
The schedule by the bill is generated.
-
HierarchyTotal: number
The total when the covered level was closed.
-
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
The invoiced amount.
-
InvoiceText: string
Maximum Length:
2000
The text to be included in the invoice. -
ItemUnitOfMeasure: string
Maximum Length:
15
The unit of measure used by the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
LineNumber: string
Title:
Number
Maximum Length:300
The line number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the child covered level. -
ParentCoveredAssetId: integer
(int64)
The unique identifier of the parent covered asset.
-
ParentCoveredLevelId: integer
(int64)
The parent level for the level.
-
PartyId: integer
(int64)
The unique identifier of the party associated with child covered level.
-
PartyName: string
Title:
Party Name
The name of the party associated with child covered level. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party associated with child covered level. -
PartySite: string
Title:
Party Site Number
The name of the party site associated with child covered level. -
PartySiteId: integer
(int64)
The unique identifier of the party site associated with child covered level.
-
Period: string
Maximum Length:
80
The period during which the covered level is used. -
PriceAsOf: string
(date)
The price of the covered level.
-
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceUnitOfMeasure: string
Maximum Length:
30
The unit of measure used by the item. -
PriceUnitOfMeasureName: string
Title:
Pricing UOM
The name of the unit of measure. -
PricingError: string
Maximum Length:
1000
Any errors associated with the pricing. -
ProductGroupId: integer
(int64)
The unique identifier of the product group.
-
ProductGroupName: string
Title:
Product Group Name
The name of the product group. -
ProductGroupNumber: string
Title:
Product Group Number
The alternate identifier of a product group. -
ProductName: string
Title:
Product Name
The name of the product. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
Quantity
Default Value:1
The quantity for which the bill line was charged. -
RemoveHoldFlag: boolean
Indicates if the covered level's hold has to be removed.
-
RenewalType: string
Title:
Renewal Type
Maximum Length:30
The type of renewal. -
RenewedDate: string
(date)
The date when the covered level was renewed.
-
RepriceFlag: boolean
Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.
-
ReturnCreditMethod: string
Title:
Close Credit Method
Maximum Length:230
The return method for the credit after the covered level was closed. -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RollupTotal: number
The total when the covered level was closed.
-
SerialNumber: string
Title:
Covered Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the child covered level. -
SourceKey: string
Maximum Length:
120
The source key of the child covered level. -
SourceLineKey: string
Maximum Length:
120
The source line key of the child covered level. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the child covered level. -
SourceNumber: string
Maximum Length:
120
The source number of the child covered level. -
SourceSystem: string
Maximum Length:
30
The source system of the child covered level. -
StartDate: string
(date)
Title:
Covered Level Start Date
The start date for the covered level. -
Status: string
Title:
Covered Level Status
Maximum Length:30
The status of the covered level. -
StatusName: string
Title:
Status
The description of the status. -
SubscriptionId: integer
(int64)
The unique identifier of the associated subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuppressedCreditAmount: number
The suppressed amount for the credit.
-
SuspendCreditMethod: string
Maximum Length:
30
The suspend method for the credit after the covered level was closed. -
SuspendedDate: string
(date)
Title:
Covered Level Suspend Date
The date when the covered level was suspended. -
SuspendReason: string
Title:
Covered Level Suspend Reason
Maximum Length:30
The reason when the covered level was suspended. -
TaxAmount: number
The amount of tax to be deducted.
-
TaxError: string
Maximum Length:
4000
The tax error for the covered level. -
TotalContractValue: number
Title:
Covered Level Contract Value
The total contract value -
Type: string
Title:
Type
Maximum Length:30
The type of the covered level. -
TypeName: string
Title:
Covered Level Type
The type name associated with the covered level. -
UnitPrice: number
Title:
Unit Price
The unit price of the covered level associated with child covered level.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.