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": "7e60fd05-1c08-4886-b483-9f631f943287", "_parent_id": "95c70f4b-6876-4036-95ba-da05df5f3ec6", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "f9b7f1d5-917f-4032-b13e-cbb06893b71c", "project_reference_back_office": "sample string 5", "project": { "id": "7493a982-f2a0-4b89-9089-9a2be724bdb4", "_parent_id": "686cc4c4-1055-4ea4-9d54-6e91de3929e6", "root_parent_id": "a4621154-7801-4586-b6d8-abcb07520d04", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "66c393a1-524c-4ea5-874a-b83444568f91", "equipment_family_code": "sample string 6", "equipment_family": { "id": "580e3bf6-8212-406f-b470-328fb7704dc5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d62f8d37-feb3-4971-beed-f25d1437a444", "_parent_code": "sample string 6", "sales_organization_id": "3e828f6c-7a9c-4c39-a985-d7f2c0ec489b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+00:00" }, "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00" }, "equipment_model_id": "0e20a463-ace5-4de1-aada-9eb1922699be", "equipment_model_code": "sample string 8", "equipment_model": { "id": "e8c20e30-92ac-4f64-b7f6-bca76c7087a6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "56f32247-2c09-4462-b149-ff180065f161", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "f9da6a35-a2fa-4d4f-b8ad-5ee60c961c01", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "e48673c7-c421-4271-8b87-c023c6d9bfdd", "sales_organization_code": "sample string 5", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+00:00" }, "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00" }, "equipment_family_id": "7393ecc2-e8f9-4877-856f-8b34c373669d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "580e3bf6-8212-406f-b470-328fb7704dc5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d62f8d37-feb3-4971-beed-f25d1437a444", "_parent_code": "sample string 6", "sales_organization_id": "3e828f6c-7a9c-4c39-a985-d7f2c0ec489b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+00:00" }, "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00" }, "date_in_production_since": "2025-09-05T04:59:14.9225515+00:00", "date_out_of_production_since": "2025-09-05T04:59:14.9225515+00:00", "date_end_support": "2025-09-05T04:59:14.9225515+00:00", "sales_organization_id": "f8a7b356-62c0-4949-ad82-a5654383aa1d", "sales_organization_code": "sample string 13", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+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-05T04:59:14.9225515+00:00" }, "project_status_id": "9d07bce8-e404-4f77-a2ea-16d67c8a11f9", "project_status_code": "sample string 10", "project_status": { "id": "3bded89a-004f-40b9-9cb5-eb33519df675", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "04ec6cde-ccfe-474e-ab68-d9abb7804484", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00" }, "company_id": "ba011910-4560-490a-84cd-8a8ac5dbdd2d", "company_code": "sample string 12", "db_address_id": "ad94800f-1f0b-4b2d-b105-e74b51030320", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "cb3bcaa3-6f10-4669-9b0e-2ead5d91238b", "contact_reference_back_office": "sample string 17", "owner_user_id": "ab82b83b-a9d3-41c5-9c15-546a94b57e24", "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-05T04:59:14.9225515+00:00", "date_create": "2025-09-05T04:59:14.9225515+00:00", "date_update": "2025-09-05T04:59:14.9225515+00:00", "updated_by_user_id": "54bc5ec7-0de4-4e5e-a9fa-f437ea837ffb", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-05T04:59:14.9225515+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-05T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-05T04:59:14.9225515+00:00", "date_last_job": "2025-09-05T04:59:14.9225515+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-05T04:59:14.9225515+00:00", "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00", "is_mobile_installation": true }, "job_type_id": "5549bfb5-a237-407c-b9ea-bf7b3ce279eb", "job_type_code": "sample string 7", "job_type": { "id": "72dc3e9c-8a41-46e7-8a5e-e9bf27014417", "name": "sample string 2", "sales_organization_id": "c4f130bd-69aa-4dfc-9df3-ea6710aabfae", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00", "code": "sample string 7" }, "job_priority_id": "26f58fe1-9bcb-4529-af03-759010f4a46b", "job_priority_code": "sample string 9", "job_priority": { "id": "19f9664b-49ac-4b65-9d0c-aa33062c2294", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "0f59f5ed-fc14-44ce-951e-64fe1af3f5cb", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00" }, "job_status_id": "8433f23d-5c6e-4a5a-b11e-330d64bd3ef0", "job_status_code": "sample string 11", "db_address_id": "48a10e20-b8aa-48c7-9372-17326aec6589", "contact_id": "e5409172-a26b-49e6-b960-b68c819dcdd4", "requested_by_company_id": "385f8202-efda-4818-a160-e3a65e34b408", "requested_by_contact_id": "7dc5ade3-88d0-4a4e-b1f6-c2e6e554fbc8", "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-05T04:59:14.9225515+00:00", "due_date": "2025-09-05T04:59:14.9225515+00:00", "date_create": "2025-09-05T04:59:14.9225515+00:00", "date_update": "2025-09-05T04:59:14.9225515+00:00", "date_closed": "2025-09-05T04:59:14.9225515+00:00", "suggested_user_id": "c6f75ac2-3bfa-4508-8808-e7f47e03a85c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "ed614c6a-2996-472b-8c62-db96eae9a958", "db_language_id": "2ce28475-e755-484f-b12a-8cb1cb94fa6e", "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-05T04:59:14.9225515+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2674be8a-504f-4c9b-bfa7-41fbebc0bddd", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "010e3e10-a79c-48f0-8ac5-ad22721b96ee", "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": "7eeab9a3-57f9-4e3c-8598-85de1fbbb028", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "21d86bfd-ca57-4422-96b2-8d5267a30036" }, "suggested_date_start": "2025-09-05T04:59:14.9225515+00:00", "skill_id": "d1ad961c-28e7-48a3-9bcf-a4f8edb2ce5f", "skill_code": "sample string 32", "skill": { "id": "d05b6ad8-5265-4c3a-8c1c-12604cfea064", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e2a58452-1765-4ea0-a0a9-72d5f5115d82", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ae67c91b-7f03-4d92-a95e-33d587bc0d90", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3c6e6d4c-0cb6-4682-9c61-d0cb09b40dcb", "db_currency_id": "4061cdd3-5d59-4817-8ca6-ea1691f271eb", "db_language_id": "8e82228a-f75e-4ccf-9a39-359689480ed4", "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-05T04:59:14.9225515+00:00" }, "modified_dateutc": "2025-09-05T04:59:14.9225515+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fca38456-7fdd-4247-b51a-fa26b20fe2a7", "date_reported_by_company": "2025-09-05T04:59:14.9225515+00:00", "id2": 36, "company_id": "79c35905-1444-478d-beaf-de09f500782c", "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": "e7dff469-097a-4f41-bcbf-dfd56c8f049f", "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-05T04:59:14.9225515+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.