Jump to

• Request
• Response

Get all negotiated entitlement plan estimates

get

/crmRestApi/resources/11.13.18.05/negotiatedEntitlementPlanEstimates

Request

Query Parameters

• 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
  
  

  • PrimaryKey Finds the subscription balance code for estimate entitlement plan with the specified primary key.
    Finder Variables
    • EntPlanEstimateId; integer; The unique estimate entitlement plan identifier of the subscription entitlement plan estimate used to find it.
• 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:
  

  • Amount; number; The amount of the subscription negotiated entitlement plan estimates.
  • BalanceCode; string; The balance code of the subscription negotiated entitlement plan estimates.
  • BalanceCodeDescription; string; The balance code description of the subscription negotiated entitlement plan estimates.
  • BalanceCodeId; integer; The unique identifier of balance code of the subscription negotiated entitlement plan estimates.
  • BalanceCodeType; string; The unique identifier of balance profile of the subscription entitlement plan estimates.
  • BalanceProfileId; integer; The unique identifier of charge definition of the subscription negotiated entitlement plan estimates.
  • ChargeDefinitionId; integer; The unique identifier of charge definition of the subscription negotiated entitlement plan estimates.
  • ConversionRate; number; The conversion rate of balance code of the subscription negotiated entitlement plan estimates.
  • CurrencyCode; string; The currency code of the subscription negotiated entitlement plan estimates.
  • EnableRolloverFlag; boolean; Indicates whether the rollover is enabled for the subscription negotiated entitlement plan estimates.
  • EntPlanEstimateId; integer; The unique identifier of the subscription negotiated entitlement plan estimates.
  • EntitlementPlanId; integer; The unique identifier of subscription entitlement plan of the subscription negotiated entitlement plan estimates.
  • Period; string; The estimate period of the subscription negotiated entitlement plan estimates.
  • PeriodBaseUom; string; The period base unit of measure of the subscription negotiated entitlement plan estimates.
  • ProductEntitlementPlanId; integer; The unique identifier of subscription product entitlement of the subscription negotiated entitlement plan estimates.
  • Quantity; number; The quantity of the subscription negotiated entitlement plan estimates.
  • RelatedChargeDefinitionId; integer; The unique identifier of related charge definition of the subscription negotiated entitlement plan estimates.
  • RolloverConversionRate; number; The rollover conversion rate of the subscription negotiated entitlement plan estimates.
  • RolloverPeriod; integer; The rollover period of the subscription negotiated entitlement plan estimates.
  • RolloverPeriodBaseUom; string; The rollover period base unit of measure of the subscription negotiated entitlement plan estimates.
  • RolloverPeriodUom; string; The rollover period unit of measure of the subscription negotiated entitlement plan estimates.
  • RoundedQuantity; number; The rounded quantity of the subscription negotiated entitlement plan estimates.
  • SubscriptionProductId; integer; The unique identifier of subscription product of the subscription negotiated entitlement plan estimates.
  • TrueupOverageFlag; boolean; Indicates whether a coverage is enabled for a given usage charge.
  • TrueupShortageFlag; boolean; Indicates whether a shortage is enabled for a given usage charge.
  • UnitOfMeasure; string; The unit of measure of the subscription negotiated entitlement plan estimates.
• 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 Top

Response

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.

Body ()

Root Schema : negotiatedEntitlementPlanEstimates

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/negotiatedEntitlementPlanEstimates-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object negotiatedEntitlementPlanEstimates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/negotiatedEntitlementPlanEstimates-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : negotiatedEntitlementPlanEstimates-item-response

Type: object

Show Source

• Amount: number
  Read Only: true

  The amount of the subscription negotiated entitlement plan estimates.
• BalanceCode: string
  Read Only: true

  Maximum Length: 30

  The balance code of the subscription negotiated entitlement plan estimates.
• BalanceCodeDescription: string
  Read Only: true

  Maximum Length: 120

  The balance code description of the subscription negotiated entitlement plan estimates.
• BalanceCodeId: integer (int64)
  Read Only: true

  The unique identifier of balance code of the subscription negotiated entitlement plan estimates.
• BalanceCodeType: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of balance profile of the subscription entitlement plan estimates.
• BalanceProfileId: integer (int64)
  Read Only: true

  The unique identifier of charge definition of the subscription negotiated entitlement plan estimates.
• ChargeDefinitionId: integer (int64)
  Read Only: true

  The unique identifier of charge definition of the subscription negotiated entitlement plan estimates.
• ConversionRate: number
  Read Only: true

  The conversion rate of balance code of the subscription negotiated entitlement plan estimates.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The currency code of the subscription negotiated entitlement plan estimates.
• EnableRolloverFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the rollover is enabled for the subscription negotiated entitlement plan estimates.
• EntitlementPlanId: integer (int64)
  Read Only: true

  The unique identifier of subscription entitlement plan of the subscription negotiated entitlement plan estimates.
• EntPlanEstimateId: integer
  Read Only: true

  The unique identifier of the subscription negotiated entitlement plan estimates.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Period: string
  Read Only: true

  Maximum Length: 30

  The estimate period of the subscription negotiated entitlement plan estimates.
• PeriodBaseUom: string
  Read Only: true

  Maximum Length: 30

  The period base unit of measure of the subscription negotiated entitlement plan estimates.
• ProductEntitlementPlanId: integer (int64)
  Read Only: true

  The unique identifier of subscription product entitlement of the subscription negotiated entitlement plan estimates.
• Quantity: number
  Read Only: true

  The quantity of the subscription negotiated entitlement plan estimates.
• RelatedChargeDefinitionId: integer (int64)
  Read Only: true

  The unique identifier of related charge definition of the subscription negotiated entitlement plan estimates.
• RolloverConversionRate: number
  Read Only: true

  The rollover conversion rate of the subscription negotiated entitlement plan estimates.
• RolloverPeriod: integer
  Read Only: true

  The rollover period of the subscription negotiated entitlement plan estimates.
• RolloverPeriodBaseUom: string
  Read Only: true

  Maximum Length: 30

  The rollover period base unit of measure of the subscription negotiated entitlement plan estimates.
• RolloverPeriodUom: string
  Read Only: true

  Maximum Length: 3

  The rollover period unit of measure of the subscription negotiated entitlement plan estimates.
• RoundedQuantity: number
  Read Only: true

  The rounded quantity of the subscription negotiated entitlement plan estimates.
• SubscriptionProductId: integer (int64)
  Read Only: true

  The unique identifier of subscription product of the subscription negotiated entitlement plan estimates.
• TrueupOverageFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether a coverage is enabled for a given usage charge.
• TrueupShortageFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether a shortage is enabled for a given usage charge.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 3

  The unit of measure of the subscription negotiated entitlement plan estimates.

{
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"The amount of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCode":{
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeDescription":{
            "maxLength":120,
            "type":"string",
            "description":"The balance code description of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of balance code of the subscription negotiated entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of balance profile of the subscription entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription negotiated entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription negotiated entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConversionRate":{
            "type":"number",
            "description":"The conversion rate of balance code of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableRolloverFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rollover is enabled for the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntPlanEstimateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription entitlement plan of the subscription negotiated entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Period":{
            "maxLength":30,
            "type":"string",
            "description":"The estimate period of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodBaseUom":{
            "maxLength":30,
            "type":"string",
            "description":"The period base unit of measure of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductEntitlementPlanId":{
            "type":"integer",
            "description":"The unique identifier of subscription product entitlement of the subscription negotiated entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "type":"integer",
            "description":"The unique identifier of related charge definition of the subscription negotiated entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RolloverConversionRate":{
            "type":"number",
            "description":"The rollover conversion rate of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverPeriod":{
            "type":"integer",
            "description":"The rollover period of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverPeriodBaseUom":{
            "maxLength":30,
            "type":"string",
            "description":"The rollover period base unit of measure of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverPeriodUom":{
            "maxLength":3,
            "type":"string",
            "description":"The rollover period unit of measure of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoundedQuantity":{
            "type":"number",
            "description":"The rounded quantity of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The unique identifier of subscription product of the subscription negotiated entitlement plan estimates.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TrueupOverageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a coverage is enabled for a given usage charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrueupShortageFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a shortage is enabled for a given usage charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the subscription negotiated entitlement plan estimates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top