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": "417dbada-477d-46f7-a67f-07f7930484e4", "_parent_id": "cad7d710-a35d-40ae-8283-792159aa3e26", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "b8adbac6-3925-469c-8abe-35623d66811f", "project_reference_back_office": "sample string 5", "project": { "id": "dc5a90a0-a9ca-4c67-9f5a-1590385eeab8", "_parent_id": "ca05b995-3ea7-4b59-ac9d-51263e3989ca", "root_parent_id": "7f4af621-e9c0-45e2-8d79-f09d9833b2db", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "0b782fc9-ece7-4188-b86a-7bd722add7aa", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e7f2055d-f82f-46b3-b6f7-c7b4045a149f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "158f98e5-0555-4efa-8092-1498a89b54de", "_parent_code": "sample string 6", "sales_organization_id": "2a0d1b1e-5690-48ee-8b1d-7ec0dd2446d3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+00:00" }, "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00" }, "equipment_model_id": "ac048182-32ff-4a43-aad7-cb43d4f343a9", "equipment_model_code": "sample string 8", "equipment_model": { "id": "d6901021-ba8d-404d-ab31-b22aaa8d588c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "f61fe3e3-fbcc-48ed-b0ff-2502201307e8", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "162b80f0-c8a9-43b6-a308-c17d96f78b3a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "1da6ca88-f2ea-4434-ba54-94fb0ecfba2b", "sales_organization_code": "sample string 5", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+00:00" }, "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00" }, "equipment_family_id": "734f7ac0-1d65-4833-b58c-ff16416a4f85", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e7f2055d-f82f-46b3-b6f7-c7b4045a149f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "158f98e5-0555-4efa-8092-1498a89b54de", "_parent_code": "sample string 6", "sales_organization_id": "2a0d1b1e-5690-48ee-8b1d-7ec0dd2446d3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+00:00" }, "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00" }, "date_in_production_since": "2025-03-31T13:23:30.4870728+00:00", "date_out_of_production_since": "2025-03-31T13:23:30.4870728+00:00", "date_end_support": "2025-03-31T13:23:30.4870728+00:00", "sales_organization_id": "04a345b3-70bc-45da-8555-f34b10fc65be", "sales_organization_code": "sample string 13", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+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-03-31T13:23:30.4870728+00:00" }, "project_status_id": "666d00ac-98e7-4a3b-b24a-e9d27ad4c85e", "project_status_code": "sample string 10", "project_status": { "id": "16e52aed-fcde-48d8-903a-848163a1e820", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "23d59118-06bc-4a91-9345-c2596b639e3b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00" }, "company_id": "ee6e93e3-7874-4fe0-a62e-7b8fd8c0ed36", "company_code": "sample string 12", "db_address_id": "49b49ba8-c761-4adc-8897-b8000246651f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "1e8920c8-9f33-4981-87f2-62f5ee5ec776", "contact_reference_back_office": "sample string 17", "owner_user_id": "da560203-f2e7-44a8-968e-d2caa43d02b7", "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-03-31T13:23:30.4870728+00:00", "date_create": "2025-03-31T13:23:30.4870728+00:00", "date_update": "2025-03-31T13:23:30.4870728+00:00", "updated_by_user_id": "b5ab6bda-b207-4894-ac76-1b3e4b6a728b", "customer_reference": "sample string 28", "warranty_date_until": "2025-03-31T13:23:30.4870728+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-03-31T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-03-31T13:23:30.4870728+00:00", "date_last_job": "2025-03-31T13:23:30.4870728+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-03-31T13:23:30.4870728+00:00", "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00", "is_mobile_installation": true }, "job_type_id": "450e54c1-0376-4ddf-ab2f-6a8d90773cb3", "job_type_code": "sample string 7", "job_type": { "id": "7b112999-065a-4b98-acff-a494b4bf5731", "name": "sample string 2", "sales_organization_id": "5860e7e5-4132-43c5-8047-c5ae60eed93f", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00", "code": "sample string 7" }, "job_priority_id": "340bab31-2c07-4315-b6e6-d5b0e66e5aff", "job_priority_code": "sample string 9", "job_priority": { "id": "5ab0e6b0-7d71-4e65-b3ba-bd5b4f799bf7", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "fe612979-f256-4845-acaa-56daeefd4b9a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00" }, "job_status_id": "c3a3fb60-3172-4ff7-831e-b141eb66fef8", "job_status_code": "sample string 11", "db_address_id": "359ac6cd-6882-4df1-a98a-3cea5cc5058f", "contact_id": "887a3cd9-c28a-4c7e-a66d-99a345042a6a", "requested_by_company_id": "3b7ff48a-2e83-471b-8b0d-35a58d876916", "requested_by_contact_id": "f94e83ae-176a-477b-95cf-e3c11eb80479", "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-03-31T13:23:30.4870728+00:00", "due_date": "2025-03-31T13:23:30.4870728+00:00", "date_create": "2025-03-31T13:23:30.4870728+00:00", "date_update": "2025-03-31T13:23:30.4870728+00:00", "date_closed": "2025-03-31T13:23:30.4870728+00:00", "suggested_user_id": "f05a01e9-552d-41a3-bec1-417d1deec815", "suggested_user_code": "sample string 29", "suggested_user": { "id": "db73eee5-7aff-4c6a-b28e-648356532bcc", "db_language_id": "01f6488a-8d06-42cb-8760-b3125b545dff", "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-03-31T13:23:30.4870728+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "d682a89c-a3ef-4331-adb1-6fe11c18f9fe", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b9be4a08-a922-43c6-90be-0bb7f1d8135e", "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": "049469b7-2c3d-4520-9733-52bcb3f81fcd", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "241e4d23-0e85-4855-935b-a4c835c61f33" }, "suggested_date_start": "2025-03-31T13:23:30.4870728+00:00", "skill_id": "6d9ae05f-e82e-43e2-a888-3b35b1319c98", "skill_code": "sample string 32", "skill": { "id": "0a02c408-1a81-46a6-9352-f3d1298b6875", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "2109412c-2fae-491a-95c3-3b08459347d8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d9d05857-2732-481d-9a7f-d76a8b96e075", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7ff79e-bad0-4cc2-8cad-534367637214", "db_currency_id": "ed59af06-9051-456e-8005-efda9da8db5e", "db_language_id": "14e97260-f2d2-4c03-ac54-ad4286104395", "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-03-31T13:23:30.4870728+00:00" }, "modified_dateutc": "2025-03-31T13:23:30.4870728+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "ee030162-b518-4159-bc58-03bdccfecd18", "date_reported_by_company": "2025-03-31T13:23:30.4870728+00:00", "id2": 36, "company_id": "4004f80c-d7a8-4699-89ff-99aa2a1f958b", "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": "5cdf3c48-52c8-4477-9ce4-66b396c84f3f", "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-03-31T13:23:30.4870728+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.