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": "c8eee25c-3819-4b0f-a9bb-a3dcf0ebd4e4", "_parent_id": "3feea345-364f-4ba1-b7ed-d6ba517c47c0", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "05a71837-7e4c-433f-b569-8cf14dd82e11", "project_reference_back_office": "sample string 5", "project": { "id": "364a771c-9719-441e-9a10-eca83fc66947", "_parent_id": "2d158a76-22e9-40bf-bdd7-ec8ab920e5f1", "root_parent_id": "6ab955c7-5b75-4745-b2e4-d1a5f0b88e1d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "c350f560-1783-4a38-aee4-dcb33651d8cc", "equipment_family_code": "sample string 6", "equipment_family": { "id": "a6877770-db70-49ad-a8c2-b5e3e051dbec", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f4152fa7-5e0f-44fa-8456-e25febe97148", "_parent_code": "sample string 6", "sales_organization_id": "4d3c60d5-a1d4-4fa6-b05d-7d52dc16bd85", "sales_organization_code": "sample string 8", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+00:00" }, "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00" }, "equipment_model_id": "6221d70f-1ed8-4a7d-8c61-e1ab7139c4d5", "equipment_model_code": "sample string 8", "equipment_model": { "id": "50dd6365-71ae-4e2f-ab87-de91ee362d23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "2e53c5bb-354b-42d8-add8-e33d514cbeec", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "444fb32a-c39b-4760-8e15-042b1c3794b0", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "974b3887-99fd-4180-b527-edfe616c1904", "sales_organization_code": "sample string 5", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+00:00" }, "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00" }, "equipment_family_id": "bc5285b7-655d-488a-a216-bf7619e96dfb", "equipment_family_code": "sample string 8", "equipment_family": { "id": "a6877770-db70-49ad-a8c2-b5e3e051dbec", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f4152fa7-5e0f-44fa-8456-e25febe97148", "_parent_code": "sample string 6", "sales_organization_id": "4d3c60d5-a1d4-4fa6-b05d-7d52dc16bd85", "sales_organization_code": "sample string 8", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+00:00" }, "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00" }, "date_in_production_since": "2025-10-14T02:44:46.9437272+00:00", "date_out_of_production_since": "2025-10-14T02:44:46.9437272+00:00", "date_end_support": "2025-10-14T02:44:46.9437272+00:00", "sales_organization_id": "1f9c4c6b-3d88-4e69-85b9-da25f106e638", "sales_organization_code": "sample string 13", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+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-10-14T02:44:46.9437272+00:00" }, "project_status_id": "14febd6b-36ae-4803-9854-2ebcbd09245e", "project_status_code": "sample string 10", "project_status": { "id": "4235abf8-43d7-4a47-8de8-9bcf36aab0fa", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "c90726dd-a7c2-4134-bf2b-e3971201fb67", "sales_organization_code": "sample string 6", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00" }, "company_id": "a0d22285-6161-4aa1-9480-c992b481eecb", "company_code": "sample string 12", "db_address_id": "b96a9fa5-b629-41b3-9aa4-0c83f6a16a6d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "6c15de84-f0be-4991-b615-380805a70c75", "contact_reference_back_office": "sample string 17", "owner_user_id": "12673c6e-fa77-4cf8-b6b4-5bbde1184a4d", "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-10-14T02:44:46.9437272+00:00", "date_create": "2025-10-14T02:44:46.9437272+00:00", "date_update": "2025-10-14T02:44:46.9437272+00:00", "updated_by_user_id": "022025ca-d977-4f41-95ff-64fd5c9de7b7", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-14T02:44:46.9437272+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-10-14T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-14T02:44:46.9437272+00:00", "date_last_job": "2025-10-14T02:44:46.9437272+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-14T02:44:46.9437272+00:00", "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00", "is_mobile_installation": true }, "job_type_id": "58b3ef26-50ea-4ee3-b882-51deaf936a20", "job_type_code": "sample string 7", "job_type": { "id": "ec620835-1ca2-49de-83b3-be249a9744d9", "name": "sample string 2", "sales_organization_id": "1cf93031-5e69-4bfa-8274-14ba89124d2f", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00", "code": "sample string 7" }, "job_priority_id": "b54e9851-fab1-49ad-9a97-6cdf262af148", "job_priority_code": "sample string 9", "job_priority": { "id": "4528d594-e4dd-4aae-8299-765485fa18ba", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "7f9b1c2f-8df6-4dd2-aed0-74858fca577d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00" }, "job_status_id": "3dab2493-1678-47a9-a755-d5695c8777b9", "job_status_code": "sample string 11", "db_address_id": "53d505d4-8825-44c2-8ba6-46fb42ee2dc0", "contact_id": "35471088-9fb0-4c87-b144-d1498f562fab", "requested_by_company_id": "a831bcf1-2598-48a3-8f7b-d96f8df20d07", "requested_by_contact_id": "de8e6ac4-817e-4c01-b42a-8e282330f7d2", "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-10-14T02:44:46.9437272+00:00", "due_date": "2025-10-14T02:44:46.9437272+00:00", "date_create": "2025-10-14T02:44:46.9437272+00:00", "date_update": "2025-10-14T02:44:46.9437272+00:00", "date_closed": "2025-10-14T02:44:46.9437272+00:00", "suggested_user_id": "8dd15bae-a6bd-4a43-b24b-40e4bd407f6c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "a3d99772-2b70-4dbf-827c-d6f54714f283", "db_language_id": "0fb79f42-6de4-46b1-ba74-7e9298daf99c", "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-10-14T02:44:46.9437272+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "6cb1ee90-0b49-4367-874d-51f4469eb144", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "adc4047a-b34f-4d4b-8506-f8d9383b85be", "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": "92ed3925-a2d9-485b-b6da-5e524b7076c7", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "a3a807d6-9073-4515-a64e-8d2bcd837e45" }, "suggested_date_start": "2025-10-14T02:44:46.9437272+00:00", "skill_id": "e69b032c-16bf-4081-8dd4-776c20495387", "skill_code": "sample string 32", "skill": { "id": "af8fac4e-9ed4-469f-8829-b5cc96325453", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "90449c36-eb58-454c-94ef-5f805eb98198", "sales_organization_code": "sample string 6", "sales_organization": { "id": "eabbbf46-1180-43fe-88bc-b6f11d354837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "42442ea0-3294-4dda-ae89-d4ef9561f254", "db_currency_id": "38027763-78eb-42ce-b95a-9b3f208b9131", "db_language_id": "f9eb9138-f9e5-4ec1-830f-fe3c180d6014", "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-10-14T02:44:46.9437272+00:00" }, "modified_dateutc": "2025-10-14T02:44:46.9437272+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fe44b0ac-c4f1-4671-a53c-33aabffb26fa", "date_reported_by_company": "2025-10-14T02:44:46.9437272+00:00", "id2": 36, "company_id": "6ac7594f-9283-4a64-98a9-e058b70d0744", "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": "e2164c93-a675-42e0-8c71-89cd07ed4e3b", "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-10-14T02:44:46.9437272+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.