FieldEx Developer
developer notes

Create Project

The ProjectCreate API allows you to create a new Project. The request body includes name, project type, and other relevant information.

Method API Endpoint
POST {{endpoint}}/api/ext/projects

Headers

Key Value
Content-Type application/json
Authorization Bearer {{token}}

Example Request

{
      "name": "efe",
      "description": "null",
      "attributes": "null",
      "productSku": "efe",
      "productNumber": "PROD-000122",
      "price": "0.0",
      "stockCount": "null",
      "createdDateTime": "2022-09-15T01:21:34Z",
      "modifiedDateTime": "2022-09-28T01:56:40.887Z",
      "lastStockUpdated": "2022-09-28T01:56:40.887Z",
      "currency": """",
      "isActive": "true",
      "hasTax": "false",
      "warranty": "null",
      "externalId": "EXT001",
      "remarks": "null",
      "manufactureYear": "null",
      "modelName": "null",
      "manufacturer": "null",
      "notForSale": "false",
      "productFamily": {
          "id": "16"
      },
      "accessories": "[]",
      "attachments": "[]",
      "accessoryStrValue": "null",
      "productType": {
          "id": "1",
          "code": "Product"
      },
      "productMeasureUnit": {
          "id": "4",
          "code": "Crate"
      }
}

Example Response

//status - 201
{
        "id": "19",
        "name": "efe",
        "description": "null",
        "attributes": "null",
        "productSku": "efe",
        "productNumber": "PROD-000019",
        "price": "0.0",
        "stockCount": "null",
        "createdDateTime": "2022-09-15T01:21:34Z",
        "modifiedDateTime": "2023-11-27T07:37:31.763Z",
        "lastStockUpdated": "2023-11-27T07:37:31.763Z",
        "currency": """",
        "isActive": "true",
        "hasTax": "false",
        "warranty": "null",
        "externalId": "EXT001",
        "remarks": "null",
        "manufactureYear": "null",
        "modelName": "null",
        "manufacturer": "null",
        "notForSale": "false"
        "createdBy": {
        "createdBy": "load.test1@trial.custella.com",
        "createdDate": "2023-05-02T09:45:27Z",
        "lastModifiedBy": "load.tech1@trial.custella.com",
        "lastModifiedDate": "2023-11-27T03:55:12Z",
        "id": "3",
        "login": "load.tech1@trial.custella.com",
        "firstName": "Technician",
        "lastName": "User",
        "email": "preeti@fieldex.com",
        "activated": "true",
        "status": "ACTIVE",
        "emailNotifications": "false",
        "smsNotifications": "false",
        "firstTimeLogin": "false",
        "isOnline": "false",
        "phone": "0122468589",
        "calendarStatus": "null",
        "langKey": "en",
        "imageUrl": "null",
        "resetDate": "2023-05-04T00:00:00Z",
        "dateOfBirth": "null",
        "joiningDate": "null",
        "position": "null",
        "location": "null",
        "locationLattitude": "6.944931",
        "locationLongitude": "80.775764",
        "gender": "null",
        "skill": "GENERAL",
        "timezone": "Asia/Kuala_Lumpur",
        "buffer": "15.0",
        "alertForTaskTime": "10.0",
        "isTaskAlert": "false",
        "startBuffer": "15.0",
        "endBuffer": "15.0",
        "maxShiftHousrsPerDay": "8.0",
        "shiftWorking": "0",
        "saleforceAccessToken": "null",
        "saleforceRefreshToken": "null",
        "saleforceInstanceId": "null",
        "dateFormatString": "dd-MM-yyyy",
        "isUserStateActive": "false",
        "defaultDashboard": "Pending Job Order",
        "employeeNo": "null"
        "authorityString": "manage_billing,inventory_deletefeature,productivity_updatefeature,scheduled_maintenance_updatefeature,drivers_deletefeature,assets_contracts_updatefeature,visit_createfeature,assets_createfeature,drivers_updatefeature,scheduled_maintenance_deletefeature,reports_updatefeature,overtime_createfeature,teams_updatefeature,job_order_deletefeature,products_createfeature,vehicles_deletefeature,delivery_orders_createfeature,products_readfeature,tickets_deletefeature,tasks_deletefeature,manage_announcement,assets_tracking_readfeature,packages_createfeature,inventory_updatefeature,assets_contracts_deletefeature,manage_import_export,sales_order_createfeature,delivery_orders_readfeature,planning_hub_deletefeature,drivers_readfeature,customers_readfeature,site_readfeature,attendance_createfeature,reports_createfeature,manage_users,manage_access,pmv_deletefeature,assets_tracking_createfeature,machine_specialist_updatefeature,shifts_createfeature,planning_hub_createfeature,customer_payment_deletefeature,manage_tickets,job_order_readfeature,overtime_readfeature,visit_updatefeature,productivity_deletefeature,customer_purchase_history_createfeature,project_createfeature,customer_payment_updatefeature,teams_deletefeature,vehicles_createfeature,customers_createfeature,pmv_readfeature,reports_readfeature,vehicles_readfeature,machine_specialist_deletefeature,tasks_createfeature,manage_licenses,job_order_updatefeature,delivery_orders_deletefeature,pmv_updatefeature,manage_org_detail,tickets_updatefeature,site_updatefeature,visit_deletefeature,delivery_orders_updatefeature,site_deletefeature,attendance_readfeature,customer_purchase_history_readfeature,sales_order_updatefeature,scheduled_maintenance_readfeature,packages_deletefeature,drivers_createfeature,products_updatefeature,teams_readfeature,assets_tracking_updatefeature,fleet_setup,tickets_readfeature,assets_readfeature,inventory_readfeature,products_deletefeature,sales_order_deletefeature,packages_updatefeature,assets_contracts_readfeature,manage_inventory,machine_specialist_readfeature,packages_readfeature,assets_deletefeature,productivity_createfeature,inventory_createfeature,productivity_readfeature,tasks_updatefeature,assets_tracking_deletefeature,shifts_deletefeature,vehicles_updatefeature,manage_workflow,customer_payment_createfeature,sales_order_readfeature,customer_purchase_history_updatefeature,project_updatefeature,tasks_readfeature,customers_updatefeature,assets_updatefeature,attendance_deletefeature,customer_payment_readfeature,attendance_updatefeature,overtime_updatefeature,shifts_updatefeature,machine_specialist_createfeature,teams_createfeature,customer_purchase_history_deletefeature,planning_hub_updatefeature,overtime_deletefeature,customers_deletefeature,manage_hierarchy,project_deletefeature,scheduled_maintenance_createfeature,visit_readfeature,assets_contracts_createfeature,job_order_createfeature,planning_hub_readfeature,reports_deletefeature,shifts_readfeature,tickets_createfeature,pmv_createfeature,manage_modules,project_readfeature,site_createfeature",
        "offlineEnable": "null",
        "roleId": "null",
        "roleName": "null",
        "profileId": "null",
        "profileName": "null",
        "superVisor": "null",
        "geoFence": "null",
        "userType": "null",
        "defaultDepot": "null",
        "tenantId": "41",
        "passwordText": "null",
        "allDays": "false",
        "maxShiftHousrType": "DAY",
        "myFullName": "Technician User",
        "online": "false",
        "fullName": "Technician User"
    },
    "modifiedBy": {
        "createdBy": "load.test1@trial.custella.com",
        "createdDate": "2023-05-02T09:45:27Z",
        "lastModifiedBy": "load.tech1@trial.custella.com",
        "lastModifiedDate": "2023-11-27T03:55:12Z",
        "id": "3",
        "login": "load.tech1@trial.custella.com",
        "firstName": "Technician",
        "lastName": "User",
        "email": "preeti@fieldex.com",
        "activated": "true",
        "status": "ACTIVE",
        "emailNotifications": "false",
        "smsNotifications": "false",
        "firstTimeLogin": "false",
        "isOnline": "false",
        "phone": "0122468589",
        "calendarStatus": "null",
        "langKey": "en",
        "imageUrl": "null",
        "resetDate": "2023-05-04T00:00:00Z",
        "dateOfBirth": "null",
        "joiningDate": "null",
        "position": "null",
        "location": "null",
        "locationLattitude": "6.944931",
        "locationLongitude": "80.775764",
        "gender": "null",
        "skill": "GENERAL",
        "timezone": "Asia/Kuala_Lumpur",
        "buffer": "15.0",
        "alertForTaskTime": "10.0",
        "isTaskAlert": "false",
        "startBuffer": "15.0",
        "endBuffer": "15.0",
        "maxShiftHousrsPerDay": "8.0",
        "shiftWorking": "0",
        "saleforceAccessToken": "null",
        "saleforceRefreshToken": "null",
        "saleforceInstanceId": "null",
        "dateFormatString": "dd-MM-yyyy",
        "isUserStateActive": "false",
        "defaultDashboard": "Pending Job Order",
        "employeeNo": "null"
        "authorityString": "manage_billing,inventory_deletefeature,productivity_updatefeature,scheduled_maintenance_updatefeature,drivers_deletefeature,assets_contracts_updatefeature,visit_createfeature,assets_createfeature,drivers_updatefeature,scheduled_maintenance_deletefeature,reports_updatefeature,overtime_createfeature,teams_updatefeature,job_order_deletefeature,products_createfeature,vehicles_deletefeature,delivery_orders_createfeature,products_readfeature,tickets_deletefeature,tasks_deletefeature,manage_announcement,assets_tracking_readfeature,packages_createfeature,inventory_updatefeature,assets_contracts_deletefeature,manage_import_export,sales_order_createfeature,delivery_orders_readfeature,planning_hub_deletefeature,drivers_readfeature,customers_readfeature,site_readfeature,attendance_createfeature,reports_createfeature,manage_users,manage_access,pmv_deletefeature,assets_tracking_createfeature,machine_specialist_updatefeature,shifts_createfeature,planning_hub_createfeature,customer_payment_deletefeature,manage_tickets,job_order_readfeature,overtime_readfeature,visit_updatefeature,productivity_deletefeature,customer_purchase_history_createfeature,project_createfeature,customer_payment_updatefeature,teams_deletefeature,vehicles_createfeature,customers_createfeature,pmv_readfeature,reports_readfeature,vehicles_readfeature,machine_specialist_deletefeature,tasks_createfeature,manage_licenses,job_order_updatefeature,delivery_orders_deletefeature,pmv_updatefeature,manage_org_detail,tickets_updatefeature,site_updatefeature,visit_deletefeature,delivery_orders_updatefeature,site_deletefeature,attendance_readfeature,customer_purchase_history_readfeature,sales_order_updatefeature,scheduled_maintenance_readfeature,packages_deletefeature,drivers_createfeature,products_updatefeature,teams_readfeature,assets_tracking_updatefeature,fleet_setup,tickets_readfeature,assets_readfeature,inventory_readfeature,products_deletefeature,sales_order_deletefeature,packages_updatefeature,assets_contracts_readfeature,manage_inventory,machine_specialist_readfeature,packages_readfeature,assets_deletefeature,productivity_createfeature,inventory_createfeature,productivity_readfeature,tasks_updatefeature,assets_tracking_deletefeature,shifts_deletefeature,vehicles_updatefeature,manage_workflow,customer_payment_createfeature,sales_order_readfeature,customer_purchase_history_updatefeature,project_updatefeature,tasks_readfeature,customers_updatefeature,assets_updatefeature,attendance_deletefeature,customer_payment_readfeature,attendance_updatefeature,overtime_updatefeature,shifts_updatefeature,machine_specialist_createfeature,teams_createfeature,customer_purchase_history_deletefeature,planning_hub_updatefeature,overtime_deletefeature,customers_deletefeature,manage_hierarchy,project_deletefeature,scheduled_maintenance_createfeature,visit_readfeature,assets_contracts_createfeature,job_order_createfeature,planning_hub_readfeature,reports_deletefeature,shifts_readfeature,tickets_createfeature,pmv_createfeature,manage_modules,project_readfeature,site_createfeature",
        "offlineEnable": "null",
        "roleId": "null",
        "roleName": "null",
        "profileId": "null",
        "profileName": "null",
        "superVisor": "null",
        "geoFence": "null",
        "userType": "null",
        "defaultDepot": "null",
        "tenantId": "41",
        "passwordText": "null",
        "allDays": "false",
        "maxShiftHousrType": "DAY",
        "myFullName": "Technician User",
        "online": "false",
        "fullName": "Technician User"
    },
    "productFamily": "null",
    "accessories": "[]",
    "attachments": "[]",
    "accessoryStrValue": "null",
    "productType": {
        "createdBy": "null",
        "createdDate": "2023-11-27T07:37:31Z",
        "lastModifiedBy": "null",
        "lastModifiedDate": "2023-11-27T07:37:31Z",
        "id": "1",
        "name": "null",
        "label": "null",
        "order": "null",
        "isDefault": "null",
        "active": "null",
        "systemValue": "null",
        "code": "Product"
    },
    "productMeasureUnit": {
        "createdBy": "null",
        "createdDate": "2023-11-27T07:37:31Z",
        "lastModifiedBy": "null",
        "lastModifiedDate": "2023-11-27T07:37:31Z",
        "id": "4",
        "name": "Crate",
        "shortName": "null",
        "label": "null",
        "order": "null",
        "isDefault": "null",
        "active": "null",
        "systemValue": "null",
        "code": "Crate"
    }
}