// removed jquery ui css and js

Update Contract

Details

API Details
Name

Update Contract

Description
MethodPUT
URIvi/tenants/tenantId/contracts/contractId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.tenants.tenantId.contracts.contractId

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/5/contracts/6"

Request Body

{
      "id": "6",
      "resource": null,
      "perms": [],
      "name": "Docs Contract",
      "description": "",
      "tenantId": "5",
      "length": 12,
      "terms": "This is a contract for the Doc team with a 10% discount.",
      "discountRate": 10,
      "disabled": false,
      "showOnlyToAdmin": true,
      "numberOfUsers": 0
}

 

Response

{
  "id": "6",
  "resource": "<HOST>:<PORT>/v1/tenants/5/contracts/6",
  "perms": [],
  "name": "Docs Contract",
  "description": "",
  "tenantId": "5",
  "length": 12,
  "terms": "This is a contract for the Doc team with a 10% discount.",
  "discountRate": 10,
  "disabled": false,
  "showOnlyToAdmin": true,
  "numberOfUsers": 0
} 

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

Response Attributes

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