Entitlement Orders Count
The Entitlement Orders Count service returns the number of activatable line items that match specified criteria.
Endpoint
<HOST>/flexnet/operations/entitlementOrders/count
Method
POST
URL Params
None
Data Params
None
Example
{"queryParams":
{"parentBulkEntitlementId":
{"value":"[String to match all or part of the entitlement ID of the parent bulk entitlement
of a simple entitlement created when a web register key is redeemed]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"entitlementId":
{"value":"[String to match all or part of the entitlement ID]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"activationId":
{"value":"[String to match all or part of the activation ID]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"productName":
{"value":"[String to match all or part of the product name]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"productVersion":
{"value":"[String to match all or part of the product version]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"productType":[One of the following: LICENSED_PRODUCT, SUITE, or MAINTENANCE],
"partNumber":
{"value":"[String to match all or part of the part number]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]",
},
"startDate":
{"value":"[Date value to compare to the start date value]",
"searchType":"[One of the following: BEFORE, AFTER or ON]",
},
"isPermanent":[Set to true if the entitlement is permanent; false if the entitlement expires],
"expirationDate":
{"value":"[Date value to compare to the expiration date value]",
"searchType":"[One of the following: BEFORE, AFTER or ON]",
},
"versionDate":
{"value":"[Date value to compare to the version date value]",
"searchType":"[One of the following: BEFORE, AFTER or ON]",
},
"licenseTechnology":
{"value":"[String to match all or part of the entitlement ID]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]",
},
"orderId":
{"value":"[String to match all or part of the order ID]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"withNoOrderId":[Optional. If true, return only activatable items with no order ID. Since this
field is intended to return results without the specified attribute, setting
this to false will have no effect on query results.],
"restrictToItemsWithCount":[Optional. If true, return only activatable items that have a
non-zero remaining count. Since this field is intended to return
results without the specified attribute, setting this to false will
have no effect on query results.],
"fulfilledAmount":[The number of copies fulfilled],
"userId":[Set to the user name (login) of a portal user to return the activatable items that
this user can see if logged in to the portal UI],
"customAttributes":
{"attribute":[{
{"attributeName":"[The name of the custom attribute]",
[Choose one of the following]
"booleanValue":"[Optional. Depending on the attribute type, set either stringValue or
numberValue or booleanValue. Set to true or false if the custom attribute
is of type boolean.]",
"dateValue":
{"value":"[Optional. Date value to compare to the custom attribute date value]",
"searchType":"[One of the following: BEFORE, AFTER, ON]"
},
"numberValue":
{"value":"[Optional. An integer number to match part or all of the custom attribute
value.]",
"searchType":"[One of the following: GREATER_THAN, GREATER_THAN_EQUALS, LESS_THAN,
LESS_THAN_EQUALS, EQUALS, or NOT_EQUALS.]"
},
"stringValue":
{"value":"[Optional. A string to match part or all of the custom attribute value]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
}
}]
},
"soldTo":
{"value":"[Optional. A string to match part or all of the account that has the right to fulfill
or distribute activation IDs from this entitlement.]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"parentBulkEntSoldTo":
{"value":"[A string to match part or all of the account to which the bulk entitlement
was sold]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"activatableItemType":[One of the following: LINEITEM or WEBREGKEY],
"allowPortalLogin":[True if the entitlement ID can be used to log in to the self-service portal;
otherwise, false],
"currentOwnerName":
{"value":"[String to match all or part of the user name of the user who created the
entitlement]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]",
},
"lineItemParentLineItemId":
{"value":"[A string to match part or all of the line item ID (activation ID) of a
parent line item]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]"
},
"createdOnDateTime":
{"value":"[Date value to compare to the created date and time value]",
"searchType":"[One of the following: BEFORE, AFTER or ON]",
},
"lastModifiedDateTime":
{"value":"[Date value to compare to the last modified date and time value]",
"searchType":"[One of the following: BEFORE, AFTER or ON]",
},
"lineItemAttributes":
{"attributeName":"[Name of a text-type line item custom attribute by which to search for a
line item.]",
"stringValue":"[Value of the text-type line item custom attribute]",
},
"accountId":
{"value":"[The name of the account]",
"searchType":"[One of the following: STARTS_WITH, CONTAINS, ENDS_WITH, or EQUALS]",
"partnerTier":[Optional. The name of the tier in which the account exists or ANY.
If set to a named tier, the format partnerTier is
bo.constants.partnertiernames.tier_name. If not specified, the partner
tier searched is the End Customer tier.]
},
"restrictToItemsReadyToActivate":[Optional. Restricts the search to only items ready to activate.
One of the following: True or False.]
}
Response
{
"statusInfo": {
"status": "SUCCESS",
"reason": null
},
"count": 1869
}