Skip to main content
POST
/
export-config
Create export config
curl --request POST \
  --url https://apiweb.mile.app/api/v3/export-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Report Daily",
  "collection": "task",
  "description": "Template for daily report with bill item detail",
  "flowIds": [
    "66a988d53ae08a7ab52867c2",
    "66c6a05440d39b2616275622",
    "66c6a05c40d39b2616275624",
    "66c6a06412d3f54e2f425e22"
  ],
  "fields": [
    {
      "component": "input",
      "id": "_id",
      "inputType": "string",
      "source": "reservedKey",
      "title": "Id",
      "uniqueTitle": "Id"
    },
    {
      "component": "input",
      "id": "flow",
      "inputType": "string",
      "source": "reservedKey",
      "title": "Flow",
      "uniqueTitle": "Flow"
    },
    {
      "component": "input",
      "id": "hub",
      "inputType": "string",
      "source": "reservedKey",
      "title": "Hub",
      "uniqueTitle": "Hub"
    },
    {
      "component": "input",
      "id": "title",
      "inputType": "string",
      "source": "reservedKey",
      "title": "Title",
      "uniqueTitle": "Title"
    },
    {
      "component": "input",
      "id": "status",
      "inputType": "string",
      "source": "reservedKey",
      "title": "Status",
      "uniqueTitle": "Status"
    },
    {
      "component": "input",
      "id": "orderNumber",
      "title": "Order Number",
      "inputType": "string",
      "default": null,
      "routeAs": null,
      "showAs": "title",
      "required": false,
      "visible": true,
      "page": "page0",
      "flowId": [
        "66a988d53ae08a7ab52867c2",
        "66c6a05440d39b2616275622",
        "66c6a05c40d39b2616275624",
        "66c6a06412d3f54e2f425e22"
      ],
      "flowName": [
        "Export Bill",
        "Flow A",
        "Flow B",
        "Flow C"
      ],
      "uniqueTitle": "Order Number"
    },
    {
      "component": "bill",
      "id": "billItem",
      "title": "Bill Item",
      "addNew": true,
      "required": false,
      "value": null,
      "editable": [],
      "costs": [
        "Discount",
        "Shipping Cost"
      ],
      "visible": true,
      "masterItems": [
        {
          "name": "Snack",
          "unit_price": 10000
        },
        {
          "name": "Cold Drink",
          "unit_price": 5000
        },
        {
          "name": "Bread",
          "unit_price": 7000
        },
        {
          "name": "Egg",
          "unit_price": 2500
        }
      ],
      "masterCosts": [
        {
          "type": "number",
          "name": "Discount",
          "amount": 10000
        },
        {
          "type": "number",
          "name": "Shipping Cost",
          "amount": 7000
        }
      ],
      "qtyRule": null,
      "page": "page1",
      "flowId": [
        "66a988d53ae08a7ab52867c2"
      ],
      "flowName": [
        "Export Bill"
      ],
      "additionalField": [
        "billItem.Discount",
        "billItem.Shipping Cost",
        "billItem.totalCost"
      ],
      "uniqueTitle": "Bill Item"
    }
  ]
}
'
{
  "status": true,
  "code": 201,
  "message": "Export Config has been added successfully.",
  "data": {
    "name": "Report Daily",
    "description": "Template for daily report with bill item detail",
    "collection": "task",
    "fields": [
      {
        "component": "input",
        "id": "_id",
        "inputType": "string",
        "source": "reservedKey",
        "title": "Id",
        "uniqueTitle": "Id"
      },
      {
        "component": "input",
        "id": "flow",
        "inputType": "string",
        "source": "reservedKey",
        "title": "Flow",
        "uniqueTitle": "Flow"
      },
      {
        "component": "input",
        "id": "hub",
        "inputType": "string",
        "source": "reservedKey",
        "title": "Hub",
        "uniqueTitle": "Hub"
      },
      {
        "component": "input",
        "id": "title",
        "inputType": "string",
        "source": "reservedKey",
        "title": "Title",
        "uniqueTitle": "Title"
      },
      {
        "component": "input",
        "id": "status",
        "inputType": "string",
        "source": "reservedKey",
        "title": "Status",
        "uniqueTitle": "Status"
      },
      {
        "component": "input",
        "id": "orderNumber",
        "title": "Order Number",
        "inputType": "string",
        "default": null,
        "routeAs": null,
        "showAs": "title",
        "required": false,
        "visible": true,
        "page": "page0",
        "flowId": [
          "66a988d53ae08a7ab52867c2",
          "66c6a05440d39b2616275622",
          "66c6a05c40d39b2616275624",
          "66c6a06412d3f54e2f425e22"
        ],
        "flowName": [
          "Export Bill",
          "Flow A",
          "Flow B",
          "Flow C"
        ],
        "uniqueTitle": "Order Number"
      },
      {
        "component": "bill",
        "id": "billItem",
        "title": "Bill Item",
        "addNew": true,
        "required": false,
        "value": null,
        "editable": [],
        "costs": [
          "Discount",
          "Shipping Cost"
        ],
        "visible": true,
        "masterItems": [
          {
            "name": "Snack",
            "unit_price": 10000
          },
          {
            "name": "Cold Drink",
            "unit_price": 5000
          },
          {
            "name": "Bread",
            "unit_price": 7000
          },
          {
            "name": "Egg",
            "unit_price": 2500
          }
        ],
        "masterCosts": [
          {
            "type": "number",
            "name": "Discount",
            "amount": 10000
          },
          {
            "type": "number",
            "name": "Shipping Cost",
            "amount": 7000
          }
        ],
        "qtyRule": null,
        "page": "page1",
        "flowId": [
          "66a988d53ae08a7ab52867c2"
        ],
        "flowName": [
          "Export Bill"
        ],
        "additionalField": [
          "billItem.Discount",
          "billItem.Shipping Cost",
          "billItem.totalCost"
        ],
        "uniqueTitle": "Bill Item"
      }
    ],
    "flowIds": [
      "66a988d53ae08a7ab52867c2",
      "66c6a05440d39b2616275622",
      "66c6a05c40d39b2616275624",
      "66c6a06412d3f54e2f425e22"
    ],
    "organizationId": "66791b2bf001a712b77b3622",
    "updatedTime": "2024-11-26T09:59:39.860000Z",
    "createdTime": "2024-11-26T09:59:39.860000Z",
    "_id": "67459c0b9778e36baa076802"
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json
ā€‹
name
string
required

The name of export config. Name must be unique. Example: Report Daily

ā€‹
collection
string
required

The collection from which the data will be exported. Example: task

ā€‹
flowIds
object[]
required

The flow identifier used to filter the components refers only to the selected flow IDs. Use Flow /flows API to get the list of flow id. Example: ['66a988d53ae08a7ab52867c2']

ā€‹
fields
object[]
required

The optional fields to be included in the exported data that ref to Flow reserved key and User fields. To see the details of reserved key of task, please follow this link

ā€‹
description
string

Response

Success

ā€‹
status
string

Status of response.

ā€‹
data
object

Detail object of created export config.