Work Area Activities
The Work Area Activity API allows you to create one or more System, VAS, or Manual activities in WFM.
URL
POST ..lgfapi/v10/entity/work_area_activity/
Fields
Name | Required | Type | Description |
facility_id | X | Integer | Facility ID |
code | X | String | Code of the System, VAS or Manual Work Area Activity |
name | X | String | Name of the System, VAS or Manual Work Area Activity |
work_area_activity_type_id | X | Integer | WFM Internal ID of the type of Work Area Activity. The supported types are System, VAS or Manual Activity |
work_area_id | X | integer | WFM Internal ID of Work Area associated to the System, VAS or Manual Activity |
Request Body Example (JSON)
Instance Create
{
"fields": {
"facility_id": 648,
"code”: "IBACT01",
"name": "Inbound Receiving Activity",
"work_area_activity_type_id": 0,
"work_area_id": 18
}
}
Bulk Create
{
"options":
{
"commit_frequency": 2
},
"fields": [
{
"facility_id": 648,
"code”: "IBACT01",
"name": "Inbound Receiving Activity",
"work_area_activity_type_id": 0,
"work_area_id": 18
},
{
"facility_id": 648,
"code”: "OBVAS01",
"name": "Outbound VAS Activity",
"work_area_activity_type_id": 1,
"work_area_id": 21
}
]
}
Request Body Example (XML)
Instance Create
<request>
<fields>
<facility_id>648</facility_id>
<code>IBACT01</code>
<name>Inbound Receiving Activity</name>
<work_area_activity_type_id>0</work_area_activity_type_id>
<work_area_id>18</work_area_id>
</fields>
</request>
Bulk Create
<request>
<fields>
<list-item>
<facility_id>648</facility_id>
<code>IBACT01</code>
<name>Inbound Receiving Activity</name>
<work_area_activity_type_id>0</work_area_activity_type_id>
<work_area_id>18</work_area_id>
</list-item>
<list-item>
<facility_id>648</facility_id>
<code>MISCACT</code>
<name>Maintenance Activities</name>
<work_area_activity_type_id>2</work_area_activity_type_id>
<work_area_id>27</work_area_id>
</list-item>
</fields>
<options>
<commit_frequency>2</commit_frequency>
</options>
</request>
Note: If the options parameter "commit_frequency" is not provided
in the payload, the behavior defaults to same behavior as commit_frequency = 0,
which is an all or nothing functionality. In other words, either all records are
processed (if successful) or none of the records are processed even if 1 record
fails validations.