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": "25c7be42-051a-4f96-b853-14e5e0acc870", "_parent_id": "1ea8d2b2-35f7-4ed9-92ac-18872648b3f7", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "06efea70-02b3-4623-b41c-9c763c0bc358", "project_reference_back_office": "sample string 5", "project": { "id": "8c81a436-958e-4ece-8917-57b2e0ce208a", "_parent_id": "18609ae7-2612-4476-91da-78d456534fd9", "root_parent_id": "3db067f2-2df4-4505-86b1-af9bb7bbbafe", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "626fbcfa-820e-407c-9b73-2322826195fb", "equipment_family_code": "sample string 6", "equipment_family": { "id": "38d65a32-f6f6-4ed2-9766-112fed7f352c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "94ad3f4e-9c6d-4fb9-b7a1-2567542f1c17", "_parent_code": "sample string 6", "sales_organization_id": "0165c24a-bcaa-4dea-a153-267687f9c637", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+00:00" }, "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00" }, "equipment_model_id": "14d18575-726a-4bcb-9cc0-2729865da6a2", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b89d67a7-57e2-49fd-bba0-e02d71aadc3a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "9903cc95-69cf-4242-850a-481cd30928ec", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "86c9981a-d53f-4d37-b255-f11d33c4403e", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "b228d36a-6ca6-4475-99b4-78f09e8c492d", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+00:00" }, "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00" }, "equipment_family_id": "b55d600e-39cf-4b9b-ab4e-eda4a271acc0", "equipment_family_code": "sample string 8", "equipment_family": { "id": "38d65a32-f6f6-4ed2-9766-112fed7f352c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "94ad3f4e-9c6d-4fb9-b7a1-2567542f1c17", "_parent_code": "sample string 6", "sales_organization_id": "0165c24a-bcaa-4dea-a153-267687f9c637", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+00:00" }, "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00" }, "date_in_production_since": "2025-09-18T11:06:54.3305518+00:00", "date_out_of_production_since": "2025-09-18T11:06:54.3305518+00:00", "date_end_support": "2025-09-18T11:06:54.3305518+00:00", "sales_organization_id": "48f7d830-fce6-4f1b-92a5-b52b8b28da3e", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+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-18T11:06:54.3305518+00:00" }, "project_status_id": "231a7398-f4a4-4308-9d67-72aa6dd900f9", "project_status_code": "sample string 10", "project_status": { "id": "fac10a7a-29c9-4085-8d22-bfe7e1787523", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "b756d461-14bb-4861-94d3-5fe0efd774fd", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00" }, "company_id": "3132ae84-77ba-4097-9986-e90ab695daab", "company_code": "sample string 12", "db_address_id": "aa145eef-b206-410b-a957-de7ff12d6f8d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "01d5e771-b531-49ae-9bee-b20cab2ce278", "contact_reference_back_office": "sample string 17", "owner_user_id": "2be498ca-14ce-4f0e-a98a-e574a43e098e", "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-18T11:06:54.3305518+00:00", "date_create": "2025-09-18T11:06:54.3305518+00:00", "date_update": "2025-09-18T11:06:54.3305518+00:00", "updated_by_user_id": "f202ed62-c492-4422-8a55-74867533fe09", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-18T11:06:54.3305518+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-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-18T11:06:54.3305518+00:00", "date_last_job": "2025-09-18T11:06:54.3305518+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-18T11:06:54.3305518+00:00", "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00", "is_mobile_installation": true }, "job_type_id": "52925daa-0d7a-4404-b101-66c633587f37", "job_type_code": "sample string 7", "job_type": { "id": "7ce4dee7-0097-411e-ac1d-45f13d372a95", "name": "sample string 2", "sales_organization_id": "50a11725-350e-4d79-ba10-7d556caed0cc", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00", "code": "sample string 7" }, "job_priority_id": "bfdbd964-04a4-4566-9feb-7273f8dc6d78", "job_priority_code": "sample string 9", "job_priority": { "id": "bc332e4a-bf21-4282-b12e-784c2d41d24b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "372a69d7-2715-42d3-908d-7421bf580e3e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00" }, "job_status_id": "fd91856e-195e-4f96-90aa-418666bde651", "job_status_code": "sample string 11", "db_address_id": "96207480-cf87-4dce-b1e7-b5b51ff5577e", "contact_id": "74e254fc-781d-4474-926e-6f45d260a778", "requested_by_company_id": "63c9acc5-8ac4-4852-a049-c9362198c59e", "requested_by_contact_id": "1a42eef5-eb20-4103-a03e-3a2062eb4d78", "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-18T11:06:54.3305518+00:00", "due_date": "2025-09-18T11:06:54.3305518+00:00", "date_create": "2025-09-18T11:06:54.3305518+00:00", "date_update": "2025-09-18T11:06:54.3305518+00:00", "date_closed": "2025-09-18T11:06:54.3305518+00:00", "suggested_user_id": "aaf174d6-459b-4fde-902c-28aac8cba183", "suggested_user_code": "sample string 29", "suggested_user": { "id": "7aeaa809-5821-4d97-b5a3-df008a9009bf", "db_language_id": "e2770468-6cb2-46ea-9050-11b476eb3e46", "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-18T11:06:54.3305518+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "113eb665-e6dd-43dc-b2d0-557b6bfb59ac", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "80604064-9fe6-4544-9f1a-5e98619d2427", "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": "160f8ef3-70ae-4b92-a15c-19152b8ac53d", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "2cb20932-f8cb-4a0c-8c34-2004937149a6" }, "suggested_date_start": "2025-09-18T11:06:54.3305518+00:00", "skill_id": "9e53a35a-15ae-48dc-85c1-e5473bba2e90", "skill_code": "sample string 32", "skill": { "id": "4b9848a4-2c0d-422e-a93b-2cd08a8a8e23", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "c6ed35cd-9083-47fe-a760-062df584446d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1337266a-7524-4991-977f-cd2c0c5cb38d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71858475-1c4d-43ad-b1a8-9bfc27615701", "db_currency_id": "6dd81d74-b829-4a2c-891e-432ed250514d", "db_language_id": "2b7fad72-bf77-4d86-993e-1b50c588dac9", "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-18T11:06:54.3305518+00:00" }, "modified_dateutc": "2025-09-18T11:06:54.3305518+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "b98edd05-ff7f-4b6f-8e08-15f3d4e94cc9", "date_reported_by_company": "2025-09-18T11:06:54.3305518+00:00", "id2": 36, "company_id": "d969a7c6-6f9a-47e6-ad3b-bb551cf18f85", "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": "6f91c140-b7e7-4763-b269-a29ab4b6044a", "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-18T11:06:54.3305518+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.