CliQr is now part of Cisco Learn More About Cisco

View Contracts

Details

API Details
Name

View Contracts

Description
MethodGET
URI
  • v1/tenants/tenantId/contracts
  • v1/tenants/tenantId/contracts/contractId 
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview > Pagination  section for additional context.
  • If you include a contractId to identify a contract, the response includes information for that contract only.
ESB Header
  • action: get.tenants.tenantId.contracts
  • action: get.tenants.tenantId.contracts.contractId 

Example

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/contracts"
Response

 

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String
contractId
  • DescriptionUnique, system-generated identifier for a contract belonging to this tenant.
  • Type: String

Response Attributes

resource
  • Description: Unique URL to access this resource
  • Type: String
See pageResource or Pagination for additional context
contracts
  • Description: Identifies details about each contract
  • Type: Array of contracts

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String
    resource
    • Description: Unique URL to access this resource
    • Type: String
    perms (click for additional details)

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    Required

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String

    tenantId
    • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

    • Type: String

    Required

    length
    • DescriptionThe length of the contract (Contract Period). See Financial Overview for additional context.
    • Type: Integer

    Required

    terms
    • DescriptionThe text of this contract
    • Type: String

    Required

    discountRate
    • Description: Discount rate applied to this contract. Provides users an incentive to sign a longer contract. Typically, a longer contract length has a deeper discount rate. This discount is applied to a plan's base one-time fee, annual fee, bundle price, and monthly subscription fee, but not the overage and storage fees.
    • Type: Decimal

    Required

    disabled
    • Description: Indicates whether this resource is disabled.
      • True = resource is disabled
      • false = resource is not disabled
    • Type: Boolean
    showOnlyToAdmin
    • Description: Indicates whether this resource is visible only to an administrator.
      • true = visibility of the resource is restricted to an administrator
      • false = visibility of the resource is not restricted to an administrator
    • Type: Boolean
    numberOfUsers
    • Description: Number of users that are currently using this resource
    • Type: Long