maas-schemas

subscriptionChangeState Schema

http://maasglobal.com/core/components/subscriptionChangeState.json

MaaS state schemas

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Develop	No	Forbidden	Permitted	core/components/subscriptionChangeState.json

Schema Hierarchy

• subscriptionChangeState http://maasglobal.com/core/components/subscriptionChangeState.json
  • units http://maasglobal.com/core/components/units.json

subscriptionChangeState Properties

Property	Type	Required	Nullable	Defined by
created	integer	Optional	No	subscriptionChangeState (this schema)
failureKey	enum	Optional	No	subscriptionChangeState (this schema)
id	string	Required	No	subscriptionChangeState (this schema)
state	enum	Required	No	subscriptionChangeState (this schema)
*	any	Additional	Yes	this schema allows additional properties

created

POSIX time in milliseconds, https://en.wikipedia.org/wiki/Unix_time

created

• is optional
• type: integer
• defined in this schema

created Type

integer

• minimum value: 1451606400
• maximum value: 9007199254740991

failureKey

Failure key enum, identifying reason for the failure

failureKey

• is optional
• type: enum
• defined in this schema

The value of this property must be equal to one of the known values below.

failureKey Known Values

Value	Description
UNKNOWN_ERROR
NOT_ELIGIBLE
EXISTING_TICKET

id

Subscription change state id

id

• is required
• type: string
• defined in this schema

id Type

string

All instances must conform to this regular expression

^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$

• test example: 4828507e-683f-41bf-9d87-689808fbf958

id Example

"4828507e-683f-41bf-9d87-689808fbf958"

state

State enum

state

• is required
• type: enum
• defined in this schema

The value of this property must be equal to one of the known values below.

state Known Values

Value	Description
IN_PROGRESS
COMPLETED
FAILED

This site is open source. Improve this page.