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": "9afa693a-fbd9-425b-8af4-337d64d04634", "_parent_id": "ee8812f1-4318-4356-9661-459e0c89f040", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "ae3291c2-bcbc-4006-8c30-0e9fa4086853", "project_reference_back_office": "sample string 5", "project": { "id": "a81e9cd1-a5c4-4e3d-aaa9-8e43eb16cadb", "_parent_id": "d8eb7da4-ded2-46b5-8378-b4bcb936ac81", "root_parent_id": "aa1297ef-5ef7-489d-818f-4d06060180a9", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "5a23a866-e334-4c3c-806d-1a6df46637ba", "equipment_family_code": "sample string 6", "equipment_family": { "id": "48d64c0e-c327-4634-b360-b76b9e507019", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "29c15a3f-6e32-496a-a11a-0838507ace50", "_parent_code": "sample string 6", "sales_organization_id": "4f1a9fb3-6861-4b1c-ac08-4e47f93f25c9", "sales_organization_code": "sample string 8", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+00:00" }, "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00" }, "equipment_model_id": "517de245-03b0-4426-ab50-650eff629ff5", "equipment_model_code": "sample string 8", "equipment_model": { "id": "ca0c194f-6d6c-48d1-958c-de7a7c538f26", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "e50d565b-84c2-40ce-b875-386bd8196b81", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "7fd3caa8-1087-42fe-b418-937c02d0246a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "43b9248d-9667-44a2-9cc7-b71928006ff7", "sales_organization_code": "sample string 5", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+00:00" }, "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00" }, "equipment_family_id": "db852dea-9a10-4eb2-b6dc-ee5e04d492e9", "equipment_family_code": "sample string 8", "equipment_family": { "id": "48d64c0e-c327-4634-b360-b76b9e507019", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "29c15a3f-6e32-496a-a11a-0838507ace50", "_parent_code": "sample string 6", "sales_organization_id": "4f1a9fb3-6861-4b1c-ac08-4e47f93f25c9", "sales_organization_code": "sample string 8", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+00:00" }, "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00" }, "date_in_production_since": "2025-10-02T16:32:40.7632196+00:00", "date_out_of_production_since": "2025-10-02T16:32:40.7632196+00:00", "date_end_support": "2025-10-02T16:32:40.7632196+00:00", "sales_organization_id": "130921bb-7419-4097-9b8c-778dd1fa0295", "sales_organization_code": "sample string 13", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+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-02T16:32:40.7632196+00:00" }, "project_status_id": "9a8c8268-a06c-48e9-b7b7-1d92c4424705", "project_status_code": "sample string 10", "project_status": { "id": "7f42ce48-5430-4a01-817c-674acd80fc08", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "6cf605fe-1853-4bf9-a2bb-a7c216b0ef5f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00" }, "company_id": "dbed080b-f730-4afc-80d9-7f42e76ae046", "company_code": "sample string 12", "db_address_id": "fdb61008-279b-4134-84d1-0df72fe38d0a", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "37c23574-bd8f-44bc-bdb0-7781f72e2e53", "contact_reference_back_office": "sample string 17", "owner_user_id": "b5f39117-2219-4bfd-8008-86b1e8f2710a", "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-02T16:32:40.7632196+00:00", "date_create": "2025-10-02T16:32:40.7632196+00:00", "date_update": "2025-10-02T16:32:40.7632196+00:00", "updated_by_user_id": "392233ea-671a-4145-806f-6a47991a725e", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-02T16:32:40.7632196+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-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-02T16:32:40.7632196+00:00", "date_last_job": "2025-10-02T16:32:40.7632196+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-02T16:32:40.7632196+00:00", "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00", "is_mobile_installation": true }, "job_type_id": "cd68fd45-6a8f-4bc2-8718-f8d05e48f512", "job_type_code": "sample string 7", "job_type": { "id": "d37c6401-d230-49cd-a836-a7205d82bd68", "name": "sample string 2", "sales_organization_id": "3c8412cb-53bd-4956-8704-217096c99a13", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00", "code": "sample string 7" }, "job_priority_id": "b6c50291-7a1f-45f2-9642-90bcd25e9d31", "job_priority_code": "sample string 9", "job_priority": { "id": "8b70f2a2-2f4f-44c1-bdae-296a840817de", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "54f4a593-7b23-4d3c-bf32-8aaa5c1c4994", "sales_organization_code": "sample string 6", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00" }, "job_status_id": "ad0a90c7-4639-4f8b-bf63-797f41e317ce", "job_status_code": "sample string 11", "db_address_id": "83d23886-3f0b-4d13-b771-2a18ee3965df", "contact_id": "9a831a84-f0e0-47e6-a8f1-56e31994a69b", "requested_by_company_id": "6f5bf40d-17bd-4610-8711-3d7e66539b8c", "requested_by_contact_id": "d9281b2c-2aa2-49e2-9cb0-2ec80ea56078", "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-02T16:32:40.7632196+00:00", "due_date": "2025-10-02T16:32:40.7632196+00:00", "date_create": "2025-10-02T16:32:40.7632196+00:00", "date_update": "2025-10-02T16:32:40.7632196+00:00", "date_closed": "2025-10-02T16:32:40.7632196+00:00", "suggested_user_id": "57563434-3a51-4221-a54e-96922fa15928", "suggested_user_code": "sample string 29", "suggested_user": { "id": "b40dc613-c415-4f82-8e45-7f7e2a6b6779", "db_language_id": "e41f727c-ef78-44fd-93ca-bc09fbe3672f", "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-02T16:32:40.7632196+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "7d21667b-410b-44f1-a19e-8ed378093122", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "9d01caeb-916e-49ee-bd5f-69dc6fbc51de", "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": "016754e5-e34f-458b-bc86-9d05735beb3f", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "8547cbbd-b74c-49cc-8816-6f1c8f916b36" }, "suggested_date_start": "2025-10-02T16:32:40.7632196+00:00", "skill_id": "ea3d4bbd-4c0b-4957-95c9-ba14f66dc6b2", "skill_code": "sample string 32", "skill": { "id": "c019087d-62be-4ee7-86e4-6335ef15839d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9b82d299-5c2d-4407-9bd1-fa4630cc3498", "sales_organization_code": "sample string 6", "sales_organization": { "id": "beae4d10-a994-4c5d-a703-93663c7b3888", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "38aa943a-86af-4794-9a40-ab2dd1404457", "db_currency_id": "98bb8484-16c1-4019-87d7-eea0e4c1d0b3", "db_language_id": "f870455d-ebc5-4240-be66-eb24d8ccb638", "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-02T16:32:40.7632196+00:00" }, "modified_dateutc": "2025-10-02T16:32:40.7632196+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "15d384a7-32d6-4154-9ca4-65568c2f9810", "date_reported_by_company": "2025-10-02T16:32:40.7632196+00:00", "id2": 36, "company_id": "39c1953b-38f1-4e82-aff5-6bcdd7da7d8b", "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": "0c5c10fb-5204-42fb-85da-61092f6e6c8e", "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-02T16:32:40.7632196+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.