GET/partners/customers/{domainId}/option-product-usages/{optionProductId}

顧客企業のオプション商品の利用内訳を取得する。

注意
この API は、将来の提供終了を予定しています。 今後は、オプション商品の利用内訳リストの取得 をご利用ください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/option-product-usages/{optionProductId}

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 
optionProductId string 

オプション商品 ID

  • ACV : アーカイブ (旧商品)
  • SSTG : 共有ストレージ (旧商品)
  • ACV2 : アーカイブ (トーク)
  • ACV3 : アーカイブ (メール)
  • DRV : Drive
  • SSTG2 : 追加ストレージ
  • BCT : アドレス帳登録数拡張

required
Allowed values : ACV, SSTG, ACV2, ACV3, SSTG2, DRV, BCT 

Query Parameters

ParameterTypeDescription
year integer 

取得年


required
example : 2021 
month integer 

取得月


required
minimum : 1
maximum : 12
example : 6 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

Option Product Usages Response

PropertyTypeDescription
optionProductUsages array (OptionProductUsages) 
 

OptionProductUsages

PropertyTypeDescription
optionProductId string 

オプション商品 ID

  • ACV : アーカイブ (旧商品)
  • SSTG : 共有ストレージ (旧商品)
  • ACV2 : アーカイブ (トーク)
  • ACV3 : アーカイブ (メール)
  • DRV : Drive
  • SSTG2 : 追加ストレージ
  • BCT : アドレス帳登録数拡張
  • CST_S : CXトーク 対応者5席の窓口
  • CST_M : CXトーク 対応者30席の窓口
  • CST_L : CXトーク 対応者100席の窓口

Allowed values : ACV, SSTG, ACV2, ACV3, DRV, SSTG2, BCT, CST_S, CST_M, CST_L 
subOptionId string 

サブオプション商品 ID

  • オプション商品 ID が ACV の場合
    • ACV : アーカイブ (旧商品)
  • オプション商品 ID が SSTG の場合
    • SSTG : 共有ストレージ (旧商品)
  • オプション商品 ID が ACV2 の場合
    • ACV200 : アーカイブ (トーク) Trial
    • ACV201 : アーカイブ (トーク)
  • オプション商品 ID が ACV3 の場合
    • ACV300 : アーカイブ (メール) Trial
    • ACV301 : アーカイブ (メール)
  • オプション商品 ID が DRV の場合
    • DRV00: Drive Trial (for STD)
    • DRV01: Drive (for STD)
    • DRV_PS_T: Drive Plus Trial (for STD)
    • DRV_PS: Drive Plus (for STD)
    • DRV_PA_T: Drive Plus Trial (for ADV)
    • DRV_PA: Drive Plus (for ADV)
  • オプション商品 ID が SSTG2 の場合
    • SSTG201 : 追加ストレージ (1TB)
    • SSTG202 : 追加ストレージ (5TB)
    • SSTG203 : 追加ストレージ (10TB)
    • SSTG204 : 追加ストレージ (25TB)
    • SSTG205 : 追加ストレージ (50TB)
    • SSTG206 : 追加ストレージ (100TB)
    • SSTG207 : 追加ストレージ (500TB)
  • オプション商品 ID が BCT の場合
    • BCT01 : アドレス帳登録数拡張 (25 万件まで)
    • BCT02 : アドレス帳登録数拡張 (50 万件まで)
    • BCT03 : アドレス帳登録数拡張 (150 万件まで)
    • BCT04 : アドレス帳登録数拡張 (500 万件まで)
  • オプション商品 ID が CST_S の場合
    • CST_S00 : CXトーク 対応者5席の窓口 Trial
    • CST_S01 : CXトーク 対応者5席の窓口
  • オプション商品 ID が CST_M の場合
    • CST_M00 : CXトーク 対応者30席の窓口 Trial
    • CST_M01 : CXトーク 対応者30席の窓口
  • オプション商品 ID が CST_L の場合
    • CST_L00 : CXトーク 対応者100席の窓口 Trial
    • CST_L01 : CXトーク 対応者100席の窓口

Allowed values : ACV, SSTG, ACV200, ACV201, ACV300, ACV301, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04, CST_S00, CST_S01, CST_M00, CST_M01, CST_L00, CST_L01 
usedDate string 

日付


format : date
readOnly : true 
plan string 

プラン

  • FREE : Free
  • TRIAL : Trial
  • MONTHLY : 月額契約 後払
  • ANNUAL_LICENSE : 年額契約 月払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い

Allowed values : FREE, TRIAL, MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
memberCount integer 

利用ユーザー数


readOnly : true 
licenseCount integer 

ライセンス数 (年額契約)


readOnly : true 
quantity integer 

契約数

  • optionProductId が SSTG の場合、単位は TB
  • その他は null

readOnly : true
nullable : true 

Response Example

example

1{2  "optionProductUsages": [3    {4      "optionProductId": "SSTG2",5      "subOptionId": "SSTG202",6      "usedDate": "2021-11-01",7      "plan": "MONTHLY",8      "memberCount": 100,9      "quantity": null10    },11    {12      "optionProductId": "ACV2",13      "subOptionId": "ACV201",14      "usedDate": "2021-11-01",15      "plan": "MONTHLY",16      "memberCount": 100,17      "quantity": null18    }19  ]20}