オプション商品の登録

POST/partners/customers/{domainId}/option-products

オプション商品を登録(適用)する。

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

partner

HTTP Request

POSThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/option-products

Path Parameters

ParameterTypeDescription
domainIdinteger

ドメインID


required
example : 10000001

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required

Request Body

PropertyTypeDescription
optionProductIdstring

オプション商品ID

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

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

サブオプション商品ID

  • オプション商品IDが ACVの場合
    • ACV: アーカイブ
  • オプション商品IDが SSTGの場合
    • SSTG: 共有ストレージ
  • オプション商品IDが ACV2の場合
    • ACV201: アーカイブ(トーク)
  • オプション商品IDが ACV3の場合
    • ACV301: アーカイブ(メール)
  • オプション商品IDが DRVの場合
    • DRV01: Drive
  • オプション商品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万件まで)

required
Allowed values : ACV, SSTG, ACV201, ACV301, DRV01, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04

Request Example

追加ストレージ5TBを購入する場合

1{
2  "optionProductId": "SSTG2",
3  "subOptionId": "SSTG202"
4}

アーカイブ(トーク)を購入する場合

1{
2  "optionProductId": "ACV2",
3  "subOptionId": "ACV201"
4}

Response

HTTP 201

OK

PropertyTypeDescription
optionProductIdstring

オプション商品ID

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

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

サブオプション商品ID

  • オプション商品IDが ACVの場合
    • ACV: アーカイブ
  • オプション商品IDが SSTGの場合
    • SSTG: 共有ストレージ
  • オプション商品IDが ACV2の場合
    • ACV201: アーカイブ(トーク)
  • オプション商品IDが ACV3の場合
    • ACV301: アーカイブ(メール)
  • オプション商品IDが DRVの場合
    • DRV01: Drive
  • オプション商品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万件まで)

Allowed values : ACV, SSTG, ACV201, ACV301, DRV01, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04
appliedTimestring

適用(購入)日時


format : date-time
readOnly : true
quantityinteger

契約数

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

readOnly : true
nullable : true

Response Example

example

1{
2  "optionProductId": "SSTG2",
3  "subOptionId": "SSTG202",
4  "quantity": null,
5  "appliedTime": "2021-11-01T00:00:00.000Z"
6}