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": "daef9658-e322-41e9-bf47-25d7083b361a", "_parent_id": "6e533d9d-6a6b-44f6-ac56-4b5354b8cc55", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "bd8f2fa8-264f-4615-bea1-b0aca5d231ec", "project_reference_back_office": "sample string 5", "project": { "id": "b6a185d8-ea34-40de-924a-6415212339a3", "_parent_id": "f2a6dddd-2c7c-42b7-b66b-2f438fefcf0d", "root_parent_id": "9231f925-8661-4dc1-8e84-a923dabc5585", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "5b63ea39-3c9c-4d5c-aafe-99a4f28d51c0", "equipment_family_code": "sample string 6", "equipment_family": { "id": "2132c4a3-8b5e-4c2b-bc41-840f20c70731", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "973f2180-5532-49e0-8c14-ab782c610416", "_parent_code": "sample string 6", "sales_organization_id": "a0930ce0-0c97-4d4a-8969-531c1a674193", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+00:00" }, "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00" }, "equipment_model_id": "2cf26fb9-9032-4f2d-a89e-cbb51dcf5ff9", "equipment_model_code": "sample string 8", "equipment_model": { "id": "c1e87505-9ad7-4301-ac0a-8682cf9858bd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "579fdda3-e1ac-41fc-8653-8a2152ed986d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "f7dd4461-60ba-459a-a1f4-bb05ec663572", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "44a20c64-4d97-429e-abb0-a5d3e2c545b1", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+00:00" }, "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00" }, "equipment_family_id": "ce299d5e-dc3b-44b6-9a72-e5eff09f5580", "equipment_family_code": "sample string 8", "equipment_family": { "id": "2132c4a3-8b5e-4c2b-bc41-840f20c70731", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "973f2180-5532-49e0-8c14-ab782c610416", "_parent_code": "sample string 6", "sales_organization_id": "a0930ce0-0c97-4d4a-8969-531c1a674193", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+00:00" }, "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00" }, "date_in_production_since": "2025-10-12T23:29:25.4707874+00:00", "date_out_of_production_since": "2025-10-12T23:29:25.4707874+00:00", "date_end_support": "2025-10-12T23:29:25.4707874+00:00", "sales_organization_id": "cd1d6c00-b42a-495a-9be1-0d2094c03bb7", "sales_organization_code": "sample string 13", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+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-12T23:29:25.4707874+00:00" }, "project_status_id": "c6e406eb-d142-4f0d-9899-216423f986cd", "project_status_code": "sample string 10", "project_status": { "id": "3837cfdf-2b6e-4644-9b4b-718022ff50d8", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "f2247a1f-9cc6-448c-b9c4-2a1d6753a8dc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00" }, "company_id": "014ce709-44fc-4158-a2cf-0079c6fff989", "company_code": "sample string 12", "db_address_id": "f53b0c2d-9e8d-4ef5-9122-3e5882b28ae3", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "ed1c3232-0a4a-44fb-94f2-8eb02b60c3af", "contact_reference_back_office": "sample string 17", "owner_user_id": "514ba67b-e806-4f71-9dbf-59db14e8cae8", "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-12T23:29:25.4707874+00:00", "date_create": "2025-10-12T23:29:25.4707874+00:00", "date_update": "2025-10-12T23:29:25.4707874+00:00", "updated_by_user_id": "e8dc089e-5c71-4c94-b1de-3091316d0f84", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-12T23:29:25.4707874+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-12T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-12T23:29:25.4707874+00:00", "date_last_job": "2025-10-12T23:29:25.4707874+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-12T23:29:25.4707874+00:00", "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00", "is_mobile_installation": true }, "job_type_id": "31c75cb1-2de6-4334-be84-cd4d43cd1ebc", "job_type_code": "sample string 7", "job_type": { "id": "a2088f4a-5267-4b0d-80a9-6c1b3d5ee160", "name": "sample string 2", "sales_organization_id": "617a59db-997b-48bf-b0e6-a3326cbf85b8", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00", "code": "sample string 7" }, "job_priority_id": "2af90bd3-6b4d-4b72-9f00-822a349aebc1", "job_priority_code": "sample string 9", "job_priority": { "id": "7300022a-4844-4697-ad5d-beb8a34fead8", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "4c45a479-b90e-43d9-a1ab-47cbc6518055", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00" }, "job_status_id": "b506eddf-fe45-47d3-8616-76dc38b7a842", "job_status_code": "sample string 11", "db_address_id": "4c024605-d686-4055-bddc-4e63855628e0", "contact_id": "537708a1-6815-4351-bb1b-63627bae20f1", "requested_by_company_id": "bee5d7c5-80f7-43c3-8d99-d7a0af501c3b", "requested_by_contact_id": "9be579b2-cd4c-4d43-b57e-e8daa9378e1f", "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-12T23:29:25.4707874+00:00", "due_date": "2025-10-12T23:29:25.4707874+00:00", "date_create": "2025-10-12T23:29:25.4707874+00:00", "date_update": "2025-10-12T23:29:25.4707874+00:00", "date_closed": "2025-10-12T23:29:25.4707874+00:00", "suggested_user_id": "dc03cd78-926d-402b-b549-50c0eeff954c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "d9384356-21a9-4346-bb79-33c6bc6dc43d", "db_language_id": "3789b230-3e9e-4c11-94a1-0cd71c0e8744", "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-12T23:29:25.4707874+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b040efd3-a361-4d73-ad7a-a84fbdc7ee62", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b9d962b9-bab8-4d38-967e-bc3af436671f", "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": "3b7a9d77-40c4-4e70-a8f4-0aff16c4eebe", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "6ecd1f2c-857a-437e-a6ac-29839ed08a9a" }, "suggested_date_start": "2025-10-12T23:29:25.4707874+00:00", "skill_id": "e611f8d1-1042-4240-8adf-3f4e7151dbdf", "skill_code": "sample string 32", "skill": { "id": "42b19d6c-8d50-4d44-96bf-0e554082add5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a0771875-a294-428f-ae62-c2b54d6fa912", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c29ae5fa-4d7b-406c-885f-b949ae5d8a00", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "37992371-bff1-45bb-81ec-213d939319f2", "db_currency_id": "db722ec9-d847-4754-9e89-10b3b750a53c", "db_language_id": "e79f2f56-45b9-491d-89cb-4884fc9908b6", "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-12T23:29:25.4707874+00:00" }, "modified_dateutc": "2025-10-12T23:29:25.4707874+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "29c06570-6baf-4dc8-80f8-c7595bebe8e8", "date_reported_by_company": "2025-10-12T23:29:25.4707874+00:00", "id2": 36, "company_id": "92af470d-f562-406c-a19f-f4d470f95aeb", "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": "1fa8f88d-c391-475b-9458-c2c6ec17362a", "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-12T23:29:25.4707874+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.