Skip to main content
POST
/
data-type
Create data type
curl --request POST \
  --url https://apiweb.mile.app/api/v3/data-type \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "OutletDetail",
  "fields": [
    {
      "id": "dataId",
      "title": "Data ID",
      "type": "string",
      "optionData": [],
      "required": true,
      "primaryKey": true
    },
    {
      "id": "outletName",
      "title": "Outlet Name",
      "type": "string",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletHours",
      "title": "Outlet Hours",
      "default": 12,
      "type": "number",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletType",
      "title": "Outlet Type",
      "type": "string",
      "optionData": [
        "minimarket",
        "supermarket",
        "vending machine",
        "warung"
      ],
      "required": true
    },
    {
      "id": "outletOpen",
      "title": "Outlet Open",
      "default": "09:00:00 AM",
      "type": "string",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletClosed",
      "title": "Outlet Closed",
      "default": "09:00:00 PM",
      "type": "string",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletContractExpired",
      "title": "Outlet Contract Expired",
      "type": "string",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletOpenInWeekend",
      "title": "Outlet Open In Weekend",
      "type": "boolean",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletGeolocation",
      "title": "Outlet Geolocation",
      "description": "Contoh inputan  \"-6.171702325136309,106.81775093078615\"",
      "type": "string",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletPhoneNumber",
      "title": "Outlet Phone Number",
      "description": "Example format  \"+628 456 7890 or +62 123 456 789 or 0123456789\"",
      "type": "string",
      "optionData": [],
      "required": true
    },
    {
      "id": "outletCloseOrder",
      "title": "Outlet Close Order",
      "description": "Example format  \"2024-11-01 15:30:45 or 2024-11-01T15:30:45.123+02:00 or 2024-11-01T15:30:45+02:00\"",
      "type": "string",
      "format": "date-time",
      "optionData": [],
      "required": true
    }
  ]
}
'
{
  "status": true,
  "message": "Success",
  "data_type": {
    "_id": "640a45dd089dc95a0a09ef14",
    "name": "OutletDetail",
    "fields": [
      {
        "id": "dataId",
        "title": "Data ID",
        "type": "string",
        "default": "true",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletName",
        "title": "Outlet Name",
        "type": "string",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletHours",
        "title": "Outlet Hours",
        "default": 12,
        "type": "number",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletType",
        "title": "Outlet Type",
        "type": "string",
        "optionData": [
          "minimarket",
          "supermarket",
          "vending machine",
          "warung"
        ],
        "required": true
      },
      {
        "id": "outletOpen",
        "title": "Outlet Open",
        "default": "09:00",
        "type": "string",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletClosed",
        "title": "Outlet Closed",
        "default": "17:00",
        "type": "string",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletContractExpired",
        "title": "Outlet Contract Expired",
        "type": "string",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletOpenInWeekend",
        "title": "Outlet Open In Weekend",
        "type": "string",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletCoordinate",
        "title": "Outlet Coordinate",
        "description": "Contoh inputan  \"-6.171702325136309,106.81775093078615\"",
        "type": "string",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletPhoneNumber",
        "title": "Outlet Phone Number",
        "description": "Example format  \"+628 456 7890 or +62 123 456 789 or 0123456789\"",
        "type": "string",
        "optionData": [],
        "required": true
      },
      {
        "id": "outletCloseOrder",
        "title": "Outlet Close Order",
        "description": "Example format  \"2024-11-01 15:30:45 or 2024-11-01T15:30:45.123+02:00 or 2024-11-01T15:30:45+02:00\"",
        "type": "string",
        "format": "date-time",
        "optionData": [],
        "required": true
      }
    ],
    "createdBy": "john.doe@mile.app",
    "organizationId": "63c61d865347e356d05e3052",
    "updatedTime": "2023-03-09 20:47:24",
    "createdTime": "2023-03-09 20:47:24",
    "provider": "internal",
    "providerConfig": null
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json
ā€‹
name
string
required

Name of data type. Example: OutletDetail

ā€‹
fields
object[]
required

List of fields to data type . Example: { 'id': 'dataId', 'title': 'Data ID', 'type': 'text', 'optionData': [], 'required': true, 'primaryKey': true }

ā€‹
limitUser
boolean

Setting to limit data source usage by users. Default: false

ā€‹
commonData
boolean

Settings to define the data source to be unique by hub or shared across all hubs. This setting is not changeable after creation. Default: false

ā€‹
provider
enum<string>
default:internal

The data source provider type. Default: internal Available values: internal, external-api (external GET API)

Available options:
internal,
external-api
ā€‹
providerConfig
object

Provider-specific configuration. Required when provider is external-api, should be null for internal provider.

  • Option 1
  • Option 2

Response

Success

ā€‹
status
boolean

Status of response.

ā€‹
message
string

Message of API response.

ā€‹
data_type
object

Detail of object data type.