Skip to main content
PUT
/
data-type
/
{dataTypeId}
Update data type by ID
curl --request PUT \
  --url https://apiweb.mile.app/api/v3/data-type/{dataTypeId} \
  --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",
      "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": "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
    }
  ]
}
'
import requests

url = "https://apiweb.mile.app/api/v3/data-type/{dataTypeId}"

payload = {
    "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",
            "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": "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
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
        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: '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
      }
    ]
  })
};

fetch('https://apiweb.mile.app/api/v3/data-type/{dataTypeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apiweb.mile.app/api/v3/data-type/{dataTypeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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',
                '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' => '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
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apiweb.mile.app/api/v3/data-type/{dataTypeId}"

	payload := strings.NewReader("{\n  \"name\": \"OutletDetail\",\n  \"fields\": [\n    {\n      \"id\": \"dataId\",\n      \"title\": \"Data ID\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true,\n      \"primaryKey\": true\n    },\n    {\n      \"id\": \"outletName\",\n      \"title\": \"Outlet Name\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletHours\",\n      \"title\": \"Outlet Hours\",\n      \"default\": 12,\n      \"type\": \"number\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletType\",\n      \"title\": \"Outlet Type\",\n      \"type\": \"string\",\n      \"optionData\": [\n        \"minimarket\",\n        \"supermarket\",\n        \"vending machine\",\n        \"warung\"\n      ],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletOpen\",\n      \"title\": \"Outlet Open\",\n      \"default\": \"09:00\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletClosed\",\n      \"title\": \"Outlet Closed\",\n      \"default\": \"17:00\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletContractExpired\",\n      \"title\": \"Outlet Contract Expired\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletOpenInWeekend\",\n      \"title\": \"Outlet Open In Weekend\",\n      \"type\": \"boolean\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletGeolocation\",\n      \"title\": \"Outlet Geolocation\",\n      \"description\": \"Contoh inputan  \\\"-6.171702325136309,106.81775093078615\\\"\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletPhoneNumber\",\n      \"title\": \"Outlet Phone Number\",\n      \"description\": \"Example format  \\\"+628 456 7890 or +62 123 456 789 or 0123456789\\\"\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletCloseOrder\",\n      \"title\": \"Outlet Close Order\",\n      \"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\\\"\",\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"optionData\": [],\n      \"required\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://apiweb.mile.app/api/v3/data-type/{dataTypeId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"OutletDetail\",\n  \"fields\": [\n    {\n      \"id\": \"dataId\",\n      \"title\": \"Data ID\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true,\n      \"primaryKey\": true\n    },\n    {\n      \"id\": \"outletName\",\n      \"title\": \"Outlet Name\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletHours\",\n      \"title\": \"Outlet Hours\",\n      \"default\": 12,\n      \"type\": \"number\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletType\",\n      \"title\": \"Outlet Type\",\n      \"type\": \"string\",\n      \"optionData\": [\n        \"minimarket\",\n        \"supermarket\",\n        \"vending machine\",\n        \"warung\"\n      ],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletOpen\",\n      \"title\": \"Outlet Open\",\n      \"default\": \"09:00\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletClosed\",\n      \"title\": \"Outlet Closed\",\n      \"default\": \"17:00\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletContractExpired\",\n      \"title\": \"Outlet Contract Expired\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletOpenInWeekend\",\n      \"title\": \"Outlet Open In Weekend\",\n      \"type\": \"boolean\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletGeolocation\",\n      \"title\": \"Outlet Geolocation\",\n      \"description\": \"Contoh inputan  \\\"-6.171702325136309,106.81775093078615\\\"\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletPhoneNumber\",\n      \"title\": \"Outlet Phone Number\",\n      \"description\": \"Example format  \\\"+628 456 7890 or +62 123 456 789 or 0123456789\\\"\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletCloseOrder\",\n      \"title\": \"Outlet Close Order\",\n      \"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\\\"\",\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"optionData\": [],\n      \"required\": true\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://apiweb.mile.app/api/v3/data-type/{dataTypeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"OutletDetail\",\n  \"fields\": [\n    {\n      \"id\": \"dataId\",\n      \"title\": \"Data ID\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true,\n      \"primaryKey\": true\n    },\n    {\n      \"id\": \"outletName\",\n      \"title\": \"Outlet Name\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletHours\",\n      \"title\": \"Outlet Hours\",\n      \"default\": 12,\n      \"type\": \"number\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletType\",\n      \"title\": \"Outlet Type\",\n      \"type\": \"string\",\n      \"optionData\": [\n        \"minimarket\",\n        \"supermarket\",\n        \"vending machine\",\n        \"warung\"\n      ],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletOpen\",\n      \"title\": \"Outlet Open\",\n      \"default\": \"09:00\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletClosed\",\n      \"title\": \"Outlet Closed\",\n      \"default\": \"17:00\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletContractExpired\",\n      \"title\": \"Outlet Contract Expired\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletOpenInWeekend\",\n      \"title\": \"Outlet Open In Weekend\",\n      \"type\": \"boolean\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletGeolocation\",\n      \"title\": \"Outlet Geolocation\",\n      \"description\": \"Contoh inputan  \\\"-6.171702325136309,106.81775093078615\\\"\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletPhoneNumber\",\n      \"title\": \"Outlet Phone Number\",\n      \"description\": \"Example format  \\\"+628 456 7890 or +62 123 456 789 or 0123456789\\\"\",\n      \"type\": \"string\",\n      \"optionData\": [],\n      \"required\": true\n    },\n    {\n      \"id\": \"outletCloseOrder\",\n      \"title\": \"Outlet Close Order\",\n      \"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\\\"\",\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"optionData\": [],\n      \"required\": true\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "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
  }
}
{
  "status": false,
  "message": "Bad request - invalid parameters provided."
}
{
  "status": false,
  "message": "Data not found"
}
{
  "status": false,
  "message": "Internal server error, please contact support@mile.app."
}

Authorizations

​
Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

​
_id
string
required

Unique identifier for the data that generated by system. Example: 640a45dd089dc95a0a09ef14

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 }

​
deleteFields
array

This parameter is list of fields to data type id for delete the field on collection of data source. Example: [ 'outletPhoneNumber', 'outletCloseOrder' ]

​
limitUser
boolean

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

​
provider
enum<string>

The data source provider type. Cannot be changed after creation.

Available options:
internal,
external-api
​
providerConfig
object

For internal provider

Response

Success

​
status
boolean

Status of response.

​
message
string

Message of API response.

​
data_type
object

Detail of object data type.