Transaction Action of GS2-Formation

ConsumeAction

Gs2Formation:SubMoldCapacityByUserId

Subtract capacity of form storage area by user ID

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
moldModelNamestringForm storage area model name
capacityintCurrent Capacity
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Formation:SubMoldCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "moldModelName": "[string]Form storage area model name",
        "capacity": "[int]Current Capacity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Formation:SubMoldCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  moldModelName: "[string]Form storage area model name"
  capacity: "[int]Current Capacity"
  timeOffsetToken: "[string]Time offset token"
transaction.service("formation").consume.sub_mold_capacity_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    moldModelName="[string]Form storage area model name",
    capacity="[int]Current Capacity",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Formation:AddMoldCapacityByUserId

Add capacity for form storage area by specifying user ID

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
moldModelNamestringForm storage area model name
capacityintCurrent Capacity
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Formation:AddMoldCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "moldModelName": "[string]Form storage area model name",
        "capacity": "[int]Current Capacity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Formation:AddMoldCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  moldModelName: "[string]Form storage area model name"
  capacity: "[int]Current Capacity"
  timeOffsetToken: "[string]Time offset token"
transaction.service("formation").acquire.add_mold_capacity_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    moldModelName="[string]Form storage area model name",
    capacity="[int]Current Capacity",
    timeOffsetToken="[string]Time offset token",
})

Gs2Formation:SetMoldCapacityByUserId

Update capacity of form storage area with user ID

Actions for which quantity can be specified: YES

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
moldModelNamestringForm storage area model name
capacityintCurrent Capacity
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Formation:SetMoldCapacityByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "moldModelName": "[string]Form storage area model name",
        "capacity": "[int]Current Capacity",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Formation:SetMoldCapacityByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  moldModelName: "[string]Form storage area model name"
  capacity: "[int]Current Capacity"
  timeOffsetToken: "[string]Time offset token"
transaction.service("formation").acquire.set_mold_capacity_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    moldModelName="[string]Form storage area model name",
    capacity="[int]Current Capacity",
    timeOffsetToken="[string]Time offset token",
})

Gs2Formation:AcquireActionsToFormProperties

Apply get action to form properties

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
moldModelNamestringForm storage area model name
indexintIndex of storage area
acquireActionAcquireActionGet action to be applied to form properties
configConfig[]List of Acquisition config
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Formation:AcquireActionsToFormProperties",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "moldModelName": "[string]Form storage area model name",
        "index": "[int]Index of storage area",
        "acquireAction": {
            "action": "[string]Types of actions to be performed in the stamp sheet",
            "request": "[string]JSON of request"
        },
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Formation:AcquireActionsToFormProperties
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  moldModelName: "[string]Form storage area model name"
  index: "[int]Index of storage area"
  acquireAction: 
    action: "[string]Types of actions to be performed in the stamp sheet"
    request: "[string]JSON of request"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"
transaction.service("formation").acquire.acquire_actions_to_form_properties({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    moldModelName="[string]Form storage area model name",
    index="[int]Index of storage area",
    acquireAction={
        action="[string]Types of actions to be performed in the stamp sheet",
        request="[string]JSON of request"
    },
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Formation:SetFormByUserId

Update form with user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
moldModelNamestringForm storage area model name
indexintIndex of storage area
slotsSlot[]List of Slots
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Formation:SetFormByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "moldModelName": "[string]Form storage area model name",
        "index": "[int]Index of storage area",
        "slots": [
            {
                "name": "[string]Slot model name",
                "propertyId": "[string]Property ID",
                "metadata": "[string]metadata"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Formation:SetFormByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  moldModelName: "[string]Form storage area model name"
  index: "[int]Index of storage area"
  slots: 
    - name: "[string]Slot model name"
      propertyId: "[string]Property ID"
      metadata: "[string]metadata"
  timeOffsetToken: "[string]Time offset token"
transaction.service("formation").acquire.set_form_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    moldModelName="[string]Form storage area model name",
    index="[int]Index of storage area",
    slots={
        {
            name="[string]Slot model name",
            propertyId="[string]Property ID",
            metadata="[string]metadata"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Formation:AcquireActionsToPropertyFormProperties

Apply get action to property form properties

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
propertyFormModelNamestringProperty form model name
propertyIdstringProperty Id
acquireActionAcquireActionGet action to be applied to form properties
configConfig[]List of Acquisition config
timeOffsetTokenstringTime offset token
{
    "action": "Gs2Formation:AcquireActionsToPropertyFormProperties",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "propertyFormModelName": "[string]Property form model name",
        "propertyId": "[string]Property Id",
        "acquireAction": {
            "action": "[string]Types of actions to be performed in the stamp sheet",
            "request": "[string]JSON of request"
        },
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Formation:AcquireActionsToPropertyFormProperties
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  propertyFormModelName: "[string]Property form model name"
  propertyId: "[string]Property Id"
  acquireAction: 
    action: "[string]Types of actions to be performed in the stamp sheet"
    request: "[string]JSON of request"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"
transaction.service("formation").acquire.acquire_actions_to_property_form_properties({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    propertyFormModelName="[string]Property form model name",
    propertyId="[string]Property Id",
    acquireAction={
        action="[string]Types of actions to be performed in the stamp sheet",
        request="[string]JSON of request"
    },
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})