⬇️Customer custom form import schedule

You can add a related schedule by specifying an existing 'customer custom field import template'. The schedule will import according to the specified time, file, and other information. To avoid data conflicts at the same time slot, if there are schedules for the same period, they will be executed according to the import order.

Create

POST https://{API_HOST}/api/v1/relation-import-task

curl -X POST
    '{"recipe_id":5,"has_header":0,"description":"test upload"}'
    -H "Content-Type: application/json"
    -F file=@/home/user/import.csv
    "https://{API_HOST}/api/v1/relation-import-task"

Request params

Parameter	Required	Default	Type	Description
recipe_id	true	NULL	Number	ID of the custom table import template to use
has_header	false	false	Boolean	Whether to ignore the first row header
description	false	NULL	String	Task description
file	true	NULL	binary	Upload file for import (under 100MB)

Response

Property	Type	Description
data	Object	Custom table import schedule

{
    "data": {
        "id": 4,
        "has_header": 0,
        "file": "relation-import/1629345399-ct import.csv",
        "size": 44,
        "total_amount": 3,
        "description": "dddd",
        "status": 2,
        "current_sheet_index": 1,
        "current_row_index": 3,
        "job_turns": 1,
        "executed_start_at": "2021-08-19 11:56:39",
        "executed_end_at": "2021-08-19 11:56:40",
        "recipe_id": 1,
        "creater_id": 1,
        "error": null,
        "created_at": "2021-08-19T03:56:39.000000Z",
        "updated_at": "2021-08-19T03:56:40.000000Z",
        "restart_at": null,
        "recipe": {
            "id": 1,
            "name": "Customer ct detection import",
            "description": null,
            "headers": [
                {
                    "value": "contacts.membership_no"
                },
                {
                    "id": 11,
                    "type": 0,
                    "value": "cz_relation_information.11",
                    "text": "measurement number",
                    "isMatchField": true,
                    "category_id": 5
                }
            ],
            "unique_columns": [
                "contacts.membership_no"
            ],
            "relation_unique_column": "-1",
            "creater_id": 1,
            "cz_col_category_id": 5,
            "created_at": "2021-08-18T05:56:20.000000Z",
            "updated_at": "2021-08-18T05:56:20.000000Z",
            "importable_type": "App\\Contact",
            "cz_col_category": {
                "id": 5,
                "name": "ct value",
                "description": null,
                "creater_id": null,
                "created_at": "2021-08-18T05:51:16.000000Z",
                "updated_at": "2021-08-18T05:51:16.000000Z",
                "type": 1
            }
        }
    }
}

List

Http Request

GET https://{API_HOST}/api/v1/relation-import-task

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/relation-import-task?per_page=15&page=1"

Parameter	Required	Default	Type	Description
page	false	1	Number	Which page is currently on
per_page	false	15	Number	How many items to display per page

Response

Property	Type	Description
data	Array of objects	Custom table import schedule
meta	Object	Pagination meta

{
    "data": [
        {
            "id": 3,
            "has_header": 0,
            "file": "relation-import/1629266607-ct import.csv",
            "size": 44,
            "total_amount": 3,
            "description": "dddd",
            "status": 2,
            "current_sheet_index": 1,
            "current_row_index": 3,
            "job_turns": 1,
            "executed_start_at": "2021-08-18 14:03:27",
            "executed_end_at": "2021-08-18 14:03:27",
            "recipe_id": 1,
            "creater_id": 1,
            "error": null,
            "created_at": "2021-08-18T06:03:27.000000Z",
            "updated_at": "2021-08-18T06:03:27.000000Z",
            "restart_at": null,
            "recipe": {
                "id": 1,
                "name": "Customer ct detection import",
                "description": null,
                "headers": [
                    {
                        "value": "contacts.membership_no"
                    },
                    {
                        "id": 11,
                        "type": 0,
                        "value": "cz_relation_information.11",
                        "text": "measurement number",
                        "isMatchField": true,
                        "category_id": 5
                    }
                ],
                "unique_columns": [
                    "contacts.membership_no"
                ],
                "relation_unique_column": "-1",
                "creater_id": 1,
                "cz_col_category_id": 5,
                "created_at": "2021-08-18T05:56:20.000000Z",
                "updated_at": "2021-08-18T05:56:20.000000Z",
                "importable_type": "App\\Contact",
                "cz_col_category": {
                    "id": 5,
                    "name": "ct value",
                    "description": null,
                    "creater_id": null,
                    "created_at": "2021-08-18T05:51:16.000000Z",
                    "updated_at": "2021-08-18T05:51:16.000000Z",
                    "type": 1
                }
            }
        },
        {
            "id": 2,
            "has_header": 0,
            "file": "relation-import/1629266289-ct import.csv",
            "size": 41,
            "total_amount": 3,
            "description": "null",
            "status": 2,
            "current_sheet_index": 1,
            "current_row_index": 3,
            "job_turns": 1,
            "executed_start_at": "2021-08-18 13:58:11",
            "executed_end_at": "2021-08-18 13:58:11",
            "recipe_id": 1,
            "creater_id": 1,
            "error": null,
            "created_at": "2021-08-18T05:58:09.000000Z",
            "updated_at": "2021-08-18T05:58:11.000000Z",
            "restart_at": null,
            "recipe": {
                "id": 1,
                "name": "Customer ct detection import",
                "description": null,
                "headers": [
                    {
                        "value": "contacts.membership_no"
                    },
                    {
                        "id": 11,
                        "type": 0,
                        "value": "cz_relation_information.11",
                        "text": "measurement number",
                        "isMatchField": true,
                        "category_id": 5
                    }
                ],
                "unique_columns": [
                    "contacts.membership_no"
                ],
                "relation_unique_column": "-1",
                "creater_id": 1,
                "cz_col_category_id": 5,
                "created_at": "2021-08-18T05:56:20.000000Z",
                "updated_at": "2021-08-18T05:56:20.000000Z",
                "importable_type": "App\\Contact",
                "cz_col_category": {
                    "id": 5,
                    "name": "ct value",
                    "description": null,
                    "creater_id": null,
                    "created_at": "2021-08-18T05:51:16.000000Z",
                    "updated_at": "2021-08-18T05:51:16.000000Z",
                    "type": 1
                }
            }
        },
        {
            "id": 1,
            "has_header": 0,
            "file": "relation-import/1629266192-ct import.csv",
            "size": 41,
            "total_amount": 3,
            "description": "null",
            "status": 2,
            "current_sheet_index": 1,
            "current_row_index": 3,
            "job_turns": 1,
            "executed_start_at": "2021-08-18 13:56:34",
            "executed_end_at": "2021-08-18 13:56:35",
            "recipe_id": 1,
            "creater_id": 1,
            "error": null,
            "created_at": "2021-08-18T05:56:32.000000Z",
            "updated_at": "2021-08-18T05:56:35.000000Z",
            "restart_at": null,
            "recipe": {
                "id": 1,
                "name": "Customer ct detection import",
                "description": null,
                "headers": [
                    {
                        "value": "contacts.membership_no"
                    },
                    {
                        "id": 11,
                        "type": 0,
                        "value": "cz_relation_information.11",
                        "text": "measurement number",
                        "isMatchField": true,
                        "category_id": 5
                    }
                ],
                "unique_columns": [
                    "contacts.membership_no"
                ],
                "relation_unique_column": "-1",
                "creater_id": 1,
                "cz_col_category_id": 5,
                "created_at": "2021-08-18T05:56:20.000000Z",
                "updated_at": "2021-08-18T05:56:20.000000Z",
                "importable_type": "App\\Contact",
                "cz_col_category": {
                    "id": 5,
                    "name": "ct value",
                    "description": null,
                    "creater_id": null,
                    "created_at": "2021-08-18T05:51:16.000000Z",
                    "updated_at": "2021-08-18T05:51:16.000000Z",
                    "type": 1
                }
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://firstline.localhost/api/v1/relation-import-task",
        "per_page": 15,
        "to": 3,
        "total": 3
    }
}

View

Http Request

GET https://{API_HOST}/api/v1/relation-import-task/{id}

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1//relation-import-task/{id}"

Response

Property	Type	Description
data	Object	Custom table import schedule

{
    "data": {
        "id": 4,
        "has_header": 0,
        "file": "relation-import/1629345399-ct import.csv",
        "size": 44,
        "total_amount": 3,
        "description": "dddd",
        "status": 2,
        "current_sheet_index": 1,
        "current_row_index": 3,
        "job_turns": 1,
        "executed_start_at": "2021-08-19 11:56:39",
        "executed_end_at": "2021-08-19 11:56:40",
        "recipe_id": 1,
        "creater_id": 1,
        "error": null,
        "created_at": "2021-08-19T03:56:39.000000Z",
        "updated_at": "2021-08-19T03:56:40.000000Z",
        "restart_at": null,
        "recipe": {
            "id": 1,
            "name": "Customer ct detection import",
            "description": null,
            "headers": [
                {
                    "value": "contacts.membership_no"
                },
                {
                    "id": 11,
                    "type": 0,
                    "value": "cz_relation_information.11",
                    "text": "measurement number",
                    "isMatchField": true,
                    "category_id": 5
                }
            ],
            "unique_columns": [
                "contacts.membership_no"
            ],
            "relation_unique_column": "-1",
            "creater_id": 1,
            "cz_col_category_id": 5,
            "created_at": "2021-08-18T05:56:20.000000Z",
            "updated_at": "2021-08-18T05:56:20.000000Z",
            "importable_type": "App\\Contact",
            "cz_col_category": {
                "id": 5,
                "name": "ct value",
                "description": null,
                "creater_id": null,
                "created_at": "2021-08-18T05:51:16.000000Z",
                "updated_at": "2021-08-18T05:51:16.000000Z",
                "type": 1
            }
        }
    }
}

Template list

You can find the matching template ID for the schedule via the API, or check related information through the system interface.

Http Request

GET https://{API_HOST}/api/v1/relation-import-recipe?importable_type=App\Contact

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/relation-import-recipe?importable_type=App\Contact"

Query Parameters

Parameter	Required	Default	Type	Description
page	false	1	Number	Which page is currently on
per_page	false	15	Number	How many items to display per page
importable_type	true	NULL	String	Template type, here you need to pass App\Contact

Response

{
    "data": [
        {
            "id": 1,
            "name": "Medical visit record",
            "importable_type": "App\\Contact",
            "description": null,
            "headers": [
                {
                    "value": "contacts.identity_no"
                },
                {
                    "value": "cz_relation_information.9"
                },
                {
                    "value": "cz_relation_information.10"
                },
                {
                    "value": "cz_relation_information.11"
                }
            ],
            "cz_col_category_id": 7,
            "cz_col_category": {
                "id": 7,
                "name": "Treatment record",
                "type": 1,
                "description": null,
                "creater_id": null
            },
            "unique_columns": [
                "contacts.identity_no"
            ],
            "relation_unique_column": "9",
            "creater_id": 2,
            "creater": {
                "id": 2,
                "name": "eason d",
                "first_name": "eason",
                "last_name": "d",
                "employee_no": "eason",
                "photo_url": "/employee/2/photo?t=1629339225",
                "identity_no": null,
                "job_title_id": -1,
                "department_id": 1,
                "extension_id": 2,
                "extension": {
                    "id": 2,
                    "type": 3,
                    "extension": "8002",
                    "webrtc_password": "540939228002",
                    "description": null,
                    "media_cluster_id": null
                },
                "profile_id": 284,
                "group_id": 2,
                "group": {
                    "id": 2,
                    "name": "Sales team",
                    "description": null,
                    "supervisor_id": 26
                },
                "cti_agent_account": "ag8002",
                "cti_agent": {
                    "id": 2,
                    "account": "ag8002",
                    "group_id": null
                },
                "cti_agent_id": 2,
                "created_at": "2018-11-09 13:21:17",
                "updated_at": "2021-07-28 15:29:39"
            },
            "tasks_count": 6
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Template view

Http Request

GET https://{API_HOST}/api/v1/relation-import-recipe/{id}

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/relation-import-recipe/1"

URL Parameters

Parameter	Description
id	Custom table batch import template id

Response

{
    "data": {
        "id": 1,
        "name": "Medical visit record",
        "importable_type": "App\\Contact",
        "description": null,
        "headers": [
            {
                "value": "contacts.identity_no"
            },
            {
                "value": "cz_relation_information.9"
            },
            {
                "value": "cz_relation_information.10"
            },
            {
                "value": "cz_relation_information.11"
            }
        ],
        "cz_col_category_id": 7,
        "cz_col_category": {
            "id": 7,
            "name": "Treatment record",
            "type": 1,
            "description": null,
            "creater_id": null
        },
        "unique_columns": [
            "contacts.identity_no"
        ],
        "relation_unique_column": "9",
        "creater_id": 2,
        "creater": {
            "id": 2,
            "name": "eason d",
            "first_name": "eason",
            "last_name": "d",
            "employee_no": "eason",
            "photo_url": "/employee/2/photo?t=1629339612",
            "identity_no": null,
            "job_title_id": -1,
            "department_id": 1,
            "extension_id": 2,
            "extension": {
                "id": 2,
                "type": 3,
                "extension": "8002",
                "webrtc_password": "540939228002",
                "description": null,
                "media_cluster_id": null
            },
            "profile_id": 284,
            "group_id": 2,
            "group": {
                "id": 2,
                "name": "Sales team",
                "description": null,
                "supervisor_id": 26
            },
            "cti_agent_account": "ag8002",
            "cti_agent": {
                "id": 2,
                "account": "ag8002",
                "group_id": null
            },
            "cti_agent_id": 2,
            "created_at": "2018-11-09 13:21:17",
            "updated_at": "2021-07-28 15:29:39"
        },
        "tasks_count": 6
    }
}