Retrieves a suite by id.

GET

/api/v1/provision/admin/suites/{suiteId}

curl --request GET \
  --url https://example.com/api/v1/provision/admin/suites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Path Parameters

suiteId

required

string format: uuid

Suite id.

Responses

200

OK

A suite: an ordered set of member products sold together, and the owner of the usage plan sets (tiers) that configure them.

object

id

string format: uuid

code

string

name

string

description

string

members

Array<object>

One member product of a suite, in sell order.

object

productId

string format: uuid

productCode

string

productName

string

sortOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isImplicit

True for the suite auto-created behind a product the first time it is priced, rather than one an operator built. Listing excludes these by default; pass includeImplicit to see them. Becomes false permanently once a second product joins.

boolean

A suite: an ordered set of member products sold together, and the owner of the usage plan sets (tiers) that configure them.

object

id

string format: uuid

code

string

name

string

description

string

members

Array<object>

One member product of a suite, in sell order.

object

productId

string format: uuid

productCode

string

productName

string

sortOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isImplicit

True for the suite auto-created behind a product the first time it is priced, rather than one an operator built. Listing excludes these by default; pass includeImplicit to see them. Becomes false permanently once a second product joins.

boolean

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "code": "example",
  "name": "example",
  "description": "example",
  "members": [
    {
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productCode": "example",
      "productName": "example",
      "sortOrder": 1
    }
  ],
  "isImplicit": true
}

A suite: an ordered set of member products sold together, and the owner of the usage plan sets (tiers) that configure them.

object

id

string format: uuid

code

string

name

string

description

string

members

Array<object>

One member product of a suite, in sell order.

object

productId

string format: uuid

productCode

string

productName

string

sortOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isImplicit

True for the suite auto-created behind a product the first time it is priced, rather than one an operator built. Listing excludes these by default; pass includeImplicit to see them. Becomes false permanently once a second product joins.

boolean

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "code": "example",
  "name": "example",
  "description": "example",
  "members": [
    {
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productCode": "example",
      "productName": "example",
      "sortOrder": 1
    }
  ],
  "isImplicit": true
}

401

Unauthorized

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}