Master Data Reference of GS2-Formation
{
"version": "2019-09-09",
"moldModels": [
{
"name": "[string]Form storage area model name",
"metadata": "[string?]metadata",
"initialMaxCapacity": "[int]Initial capacity to store forms",
"maxCapacity": "[int]Maximum capacity to store forms",
"formModel": {
"formModelId": "[string]Form model GRN",
"name": "[string]Form model name",
"metadata": "[string?]metadata",
"slots": [
{
"name": "[string]Slot model name",
"propertyRegex": "[string]Regular expressions for values that can be set as properties",
"metadata": "[string?]metadata"
}
]
}
}
],
"propertyFormModels": [
{
"name": "[string]Property form model name",
"metadata": "[string?]metadata",
"slots": [
{
"name": "[string]Slot model name",
"propertyRegex": "[string]Regular expressions for values that can be set as properties",
"metadata": "[string?]metadata"
}
]
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2019-09-09 | Format version of master data | |||
moldModels | List<MoldModel> | ~ 100 items | Area for storing form | |||
propertyFormModels | List<PropertyFormModel> | ~ 100 items | Property Form Model |
FormModel
Form Model
This entity represents the form status.
A slot
can be defined as an area that can be organized.
In the case of weapons and armor, a slot can be a part such as right hand',
left hand’, body',
arm’, etc., or it can be an area such as slot',
slot’, or `slot’, etc.
In the case of a party, positions such as “vanguard,” “middle guard,” and “rear guard” can be represented as slots.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
formModelId | string | ✓ | ~ 1024 chars | Form model GRN | ||
name | string | ✓ | ~ 128 chars | Form model name | ||
metadata | string | ~ 2048 chars | metadata | |||
slots | List<SlotModel> | ✓ | 1 ~ 10 items | List of Slot Model |
MoldModel
Area for storing form
If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”. The number of areas that can be saved can be limited or expanded individually.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
moldModelId | string | ✓ | ~ 1024 chars | Form storage area GRN | ||
name | string | ✓ | ~ 128 chars | Form storage area model name | ||
metadata | string | ~ 2048 chars | metadata | |||
initialMaxCapacity | int | ✓ | 1 ~ 2147483646 | Initial capacity to store forms | ||
maxCapacity | int | ✓ | 1 ~ 2147483646 | Maximum capacity to store forms | ||
formModel | FormModel | ✓ |
PropertyFormModel
Property Form Model
An entity that represents the composition status. The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot, and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
propertyFormModelId | string | ✓ | ~ 1024 chars | Property form model GRN | ||
name | string | ✓ | ~ 128 chars | Property form model name | ||
metadata | string | ~ 2048 chars | metadata | |||
slots | List<SlotModel> | ✓ | 1 ~ 10 items | List of Slot Model |
Slot
Slot
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Slot model name | ||
propertyId | string | ~ 1024 chars | Property ID | |||
metadata | string | ~ 1024 chars | metadata |
SlotModel
Slot Model
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Slot model name | ||
propertyRegex | string | ✓ | “.*” | ~ 512 chars | Regular expressions for values that can be set as properties | |
metadata | string | ~ 512 chars | metadata |
SlotWithSignature
Signature Slot
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Slot model name | ||
propertyType | enum { “gs2_inventory”, “gs2_simple_inventory”, “gs2_dictionary” } | ✓ | ~ 128 chars | Property Type | ||
body | string | ~ 1048576 chars | payload | |||
signature | string | ~ 1024 chars | Signature that proves ownership of the resource for the property ID | |||
metadata | string | ~ 1024 chars | metadata |
Enumeration type definition to specify as propertyType
Enumerator String Definition | Description |
---|---|
gs2_inventory | GS2-Inventory::ItemSet |
gs2_simple_inventory | GS2-Inventory::SimpleItem |
gs2_dictionary | GS2-Dictionary::Entry |
AcquireAction
Acquire Action
VerifyActionResult
Verify action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the verify task | ||
verifyRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
verifyResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
ConsumeActionResult
Consume action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the consume action | ||
consumeRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
consumeResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
AcquireActionResult
Acquire action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the acquire action | ||
acquireRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
acquireResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
TransactionResult
Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
transactionId | string | ✓ | 36 ~ 36 chars | Transaction ID | ||
verifyResults | List<VerifyActionResult> | ~ 10 items | List of verify action execution results | |||
consumeResults | List<ConsumeActionResult> | ~ 10 items | List of consume action execution results | |||
acquireResults | List<AcquireActionResult> | ~ 100 items | List of acquire action execution results |