Master Data Reference of GS2-Formation

{
  "version": "2019-09-09",
  "moldModels": [
    {
      "name": "[string]Form 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 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]Form 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	Require	Default
version	✓	2019-09-09	Format version of master data
moldModels	List<MoldModel>
propertyFormModels	List<PropertyFormModel>

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	Require	Limitation	Description
formModelId	string	✓	~ 1024 chars	Form model GRN
name	string	✓	~ 128 chars	Form 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	Require	Limitation	Description
moldModelId	string	✓	~ 1024 chars	Form storage area GRN
name	string	✓	~ 128 chars	Form 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	Require	Limitation	Description
propertyFormModelId	string	✓	~ 1024 chars	Property Form model GRN
name	string	✓	~ 128 chars	Form Name
metadata	string		~ 2048 chars	metadata
slots	List<SlotModel>	✓	1 ~ 10 items	List of Slot Model

Slot

	Type	Require	Limitation	Description
name	string	✓	~ 128 chars	Slot model name
propertyId	string	✓	~ 1024 chars	Property ID
metadata	string		~ 1024 chars	metadata

SlotModel

	Type	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

	Type	Require	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

AcquireAction

	Type	Condition	Require	Default	Limitation	Description
action	enum []		✓		~ 128 chars	Types of actions to be performed in the stamp sheet
request	string		✓		~ 1048576 chars	JSON of request