Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
jobsName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier | |
_parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
_parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
_parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
name |
Name of the Job |
string |
Required Max length: 255 |
description |
Description of the job |
string |
Max length: 4000 |
working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
due_date |
Deadline of Max date for the planning (Not After) |
date | |
date_create |
Creation date+time |
date | |
date_update |
Update date+time |
date | |
date_closed |
Date+time job goes to completed |
date | |
suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
skill |
Embedded entity "skill" when adding/updating job |
skill | |
customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
date_reported_by_company |
Date+time when company reported the problem |
date | |
id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
company_code |
This field will be filled automatically based on the project_id |
string | |
db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_street2 |
It is sub street |
string |
Max length: 50 |
db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
db_address_db_country_code |
When mobile equipment, the address to use |
string | |
db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
db_address_latitude_decimal |
Latitude |
decimal number | |
db_address_longitude_decimal |
Latitude |
decimal number | |
estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{ "id": "1d79d897-4352-499a-97cb-a99f1761d2e3", "_parent_id": "1ed9995d-08be-48fb-b323-cbd56d299c1a", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "555df187-53c9-4f2a-a4c7-47dcbeadf951", "project_reference_back_office": "sample string 5", "project": { "id": "a373e8e5-3124-4a3a-831a-0b0a3ec2426a", "_parent_id": "ed62c13b-b2fa-4664-9685-37a20c84819e", "root_parent_id": "d721087e-5341-42f5-9ef8-cfc99f2e91ce", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "00983cc3-0a9c-42f4-aab2-1c20145ca55a", "equipment_family_code": "sample string 6", "equipment_family": { "id": "721f2b4c-be3f-452f-83d4-db15b4f55db5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ae163876-491b-46c5-b062-52e166eb26d7", "_parent_code": "sample string 6", "sales_organization_id": "120ed600-98e4-4561-b73d-cfbb8815d296", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "equipment_model_id": "b5a28c44-ab28-4b6e-9726-1317d101695d", "equipment_model_code": "sample string 8", "equipment_model": { "id": "171bf91c-dfbb-460b-9ea5-098c6e6f9ad9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "cf9e9170-c510-4bfd-b37d-ec02b988f8f2", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "5d894761-5245-44df-9e60-119572374e5a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3d9f519a-3489-420f-89ce-975cf901884f", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "equipment_family_id": "a9ccf6b6-957f-4e43-bf7e-6714781dd0bc", "equipment_family_code": "sample string 8", "equipment_family": { "id": "721f2b4c-be3f-452f-83d4-db15b4f55db5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ae163876-491b-46c5-b062-52e166eb26d7", "_parent_code": "sample string 6", "sales_organization_id": "120ed600-98e4-4561-b73d-cfbb8815d296", "sales_organization_code": "sample string 8", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "date_in_production_since": "2025-09-03T08:24:16.3247326+00:00", "date_out_of_production_since": "2025-09-03T08:24:16.3247326+00:00", "date_end_support": "2025-09-03T08:24:16.3247326+00:00", "sales_organization_id": "ef474b49-966e-41bc-932b-36154cc984f5", "sales_organization_code": "sample string 13", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "replacement_period_nb_months": 14, "warranty_period_nb_months": 15, "translations": [ { "field_name": "sample string 1", "language_code": "sample string 2", "value_translated": "sample string 3" }, { "field_name": "sample string 1", "language_code": "sample string 2", "value_translated": "sample string 3" } ], "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "project_status_id": "af774f6f-5162-41fc-8164-66be03ace78a", "project_status_code": "sample string 10", "project_status": { "id": "93ff9573-ad1d-4bd9-ae5c-27afb0fa4113", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "2d4c4179-3f93-4268-adf8-6b1ec287468c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "company_id": "b0330c32-621b-4b10-a95f-f43090945cb7", "company_code": "sample string 12", "db_address_id": "ed29d193-56df-491e-b200-91a3e700f7ae", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "a890e100-980c-4d0e-8a88-7e500393601d", "contact_reference_back_office": "sample string 17", "owner_user_id": "3b894458-2d0e-4abf-8b11-d8327533acce", "name": "sample string 19", "description": "sample string 20", "reference_back_office": "sample string 21", "serial_number": "sample string 22", "barcode": "sample string 23", "date_start_production": "2025-09-03T08:24:16.3247326+00:00", "date_create": "2025-09-03T08:24:16.3247326+00:00", "date_update": "2025-09-03T08:24:16.3247326+00:00", "updated_by_user_id": "ee3cefec-7282-4938-9a27-543a84709584", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-03T08:24:16.3247326+00:00", "last_standard_result_score_1": "sample string 30", "last_standard_result_score_2": "sample string 31", "target_standard_result_score_1": "sample string 32", "target_standard_result_score_2": "sample string 33", "date_built": "2025-09-03T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-03T08:24:16.3247326+00:00", "date_last_job": "2025-09-03T08:24:16.3247326+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-03T08:24:16.3247326+00:00", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00", "is_mobile_installation": true }, "job_type_id": "c73f0b13-ea09-4b2c-9887-84212d814bdb", "job_type_code": "sample string 7", "job_type": { "id": "d78dfd4a-3e76-4da7-a95a-57cbb6b4438e", "name": "sample string 2", "sales_organization_id": "86e8d5cf-c496-41cf-88ca-4a8ac12236af", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00", "code": "sample string 7" }, "job_priority_id": "7345740d-98f3-4204-9c32-43ed8258d657", "job_priority_code": "sample string 9", "job_priority": { "id": "3e3edd8b-7c98-43c8-aeb7-3754e38017f3", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "5d6e93ad-0963-4966-9f6d-6eed870f2fab", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "job_status_id": "7c4d2f27-f4d8-4007-a80a-3d3221dbcb18", "job_status_code": "sample string 11", "db_address_id": "221b9567-6084-40b8-bf8d-59a2dc1a455d", "contact_id": "c2a8ae9b-db12-45d0-8a4c-717f524565d4", "requested_by_company_id": "dbcf2d34-ae12-4ab1-b8d3-3f43646c0b85", "requested_by_contact_id": "0ca02875-bcd5-43db-b3cc-7aff5659ee7d", "reference_back_office": "sample string 16", "name": "sample string 17", "description": "sample string 18", "working_sequence": 19, "internal_memo": "sample string 20", "prejob_information": "sample string 21", "estimated_time": 22, "earliest_date_plannable": "2025-09-03T08:24:16.3247326+00:00", "due_date": "2025-09-03T08:24:16.3247326+00:00", "date_create": "2025-09-03T08:24:16.3247326+00:00", "date_update": "2025-09-03T08:24:16.3247326+00:00", "date_closed": "2025-09-03T08:24:16.3247326+00:00", "suggested_user_id": "d69268f4-2e96-4485-a09d-e53c7543653b", "suggested_user_code": "sample string 29", "suggested_user": { "id": "9a87c8b2-92e3-4714-8097-557bd1e72a54", "db_language_id": "1b751fa0-d0b2-468c-8019-cdccd45a33ed", "username": "sample string 3", "firstname": "sample string 4", "lastname": "sample string 5", "code": "sample string 6", "archived": true, "disabled": true, "emergency_contact": "sample string 9", "bankaccount": "sample string 10", "social_security": "sample string 11", "place_of_birth": "sample string 12", "nationality": "sample string 13", "functions": "sample string 14", "birthdate": "2025-09-03T08:24:16.3247326+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "45738679-ad84-4e3a-bf51-6cf820d0150f", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "708dac84-5e3a-46c0-8e7d-6a4eb8b4dda9", "email": "sample string 22", "phone": "sample string 23", "fax": "sample string 24", "mobile": "sample string 25", "private_email": "sample string 26", "private_phone": "sample string 27", "private_fax": "sample string 28", "private_mobile": "sample string 29", "private_street": "sample string 30", "private_street_number": "sample string 31", "private_city": "sample string 32", "private_zip": "sample string 33", "private_db_country_id": "b5f04240-884a-4275-87c5-d569b966bd36", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "bc2568a5-8cea-4583-9f84-f26d05e095c8" }, "suggested_date_start": "2025-09-03T08:24:16.3247326+00:00", "skill_id": "65a1c9c6-c991-436a-9d51-bb1958713e5d", "skill_code": "sample string 32", "skill": { "id": "11af0a0a-9fdc-495b-9979-f5b8c84c7871", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "ebf924f6-9183-4313-87a3-404b5a45c0e5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "a645be8e-dbfb-48b9-aad3-aea927f4070d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "df30caa5-05a2-42e3-95e5-edc3c4a313e9", "db_currency_id": "bd21ce22-a82d-434d-a71e-0956561ae235", "db_language_id": "13e18800-0e60-4a19-a848-64d10f4ecbb9", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "4bd3e66f-3e9a-473d-bcad-ed146e86191c", "date_reported_by_company": "2025-09-03T08:24:16.3247326+00:00", "id2": 36, "company_id": "f49b8195-4773-4e92-b7c9-956cd47c3059", "company_code": "sample string 38", "db_address_name": "sample string 39", "db_address_street": "sample string 40", "db_address_street2": "sample string 41", "db_address_street_number": "sample string 42", "db_address_city": "sample string 43", "db_address_zip": "sample string 44", "db_address_db_country_id": "f499cfc7-8e20-432a-9865-7d273888e551", "db_address_db_country_code": "sample string 46", "db_address_phone": "sample string 47", "db_address_email": "sample string 48", "db_address_latitude_decimal": 49.0, "db_address_longitude_decimal": 50.0, "estimated_quantity_remark": "sample string 51", "modified_dateutc": "2025-09-03T08:24:16.3247326+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.