Master Data Reference of GS2-Distributor

Reference of the format of master data and various models to be imported

Master Data Format

{
  "version": "2019-03-01",
  "distributorModels": [
    {
      "name": "[string]Delivery setting name",
      "metadata": "[string?]Metadata",
      "inboxNamespaceId": "[string?]GS2-Inbox namespace GRN to transfer overflow resources",
      "whiteListTargetIds": [
        "[string]Target resources GRNs that can be processed through the distributor"
      ]
    }
  ]
}

	Type	Condition	Required	Default	Value Limits	Description
version	string		✓	2019-03-01		Format version of master data
distributorModels	List<DistributorModel>				~ 100 items	Delivery Setting Model A delivery setting is an entity that sets the policy when an entity’s acquisition exceeds its possession quota. By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages.

Model

DistributorModel

Delivery Setting Model

A delivery setting is an entity that sets the policy when an entity’s acquisition exceeds its possession quota. By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages.

	Type	Required	Default	Value Limits	Description
distributorModelId	string	✓		~ 1024 chars	Delivery Setting GRN
name	string	✓		~ 128 chars	Delivery setting name
metadata	string			~ 2048 chars	Metadata
inboxNamespaceId	string			~ 1024 chars	GS2-Inbox namespace GRN to transfer overflow resources
whiteListTargetIds	List<string>		[]	0 ~ 1000 items	Whitelist of target resource GRNs that can be processed through the distributor