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": "dd735a52-faae-4b44-bad6-49d23c4623be", "_parent_id": "5d9c19e7-5059-42bf-9fd9-dc90f7458489", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "149f65fc-6968-4ff7-b6a6-ea6088845524", "project_reference_back_office": "sample string 5", "project": { "id": "045faed9-2ea7-4b06-8df4-c04cf13a5358", "_parent_id": "866f178a-b287-49c9-afa6-70a1142b95d4", "root_parent_id": "f2a0110b-0b8c-4878-84b2-cf397aa3cdc5", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "ff3d7670-6fa4-4344-94be-3ce731ae6636", "equipment_family_code": "sample string 6", "equipment_family": { "id": "03cf6507-ff1a-417a-8cca-35af78586a53", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1df8904e-4a4b-4f9e-8e8a-068e6b420cb7", "_parent_code": "sample string 6", "sales_organization_id": "58a99fdf-4348-4b49-82c0-bd79eb24da21", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+00:00" }, "modified_dateutc": "2025-05-28T01:02:54.5246569+00:00" }, "equipment_model_id": "20c15d36-4e4a-4440-b305-43c363dd2969", "equipment_model_code": "sample string 8", "equipment_model": { "id": "b8ad9a18-a01c-4f42-a597-f0a98f13cd53", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "cdd1deb4-b427-410d-be39-939e4ae67baf", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "1e4d6146-dc5e-4aed-9b7f-c82c4fe13047", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3d227da8-2310-4d9a-a35d-e3055b1880b2", "sales_organization_code": "sample string 5", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+00:00" }, "modified_dateutc": "2025-05-28T01:02:54.5246569+00:00" }, "equipment_family_id": "7465e6ce-9424-42eb-8007-9c52da0c9dbf", "equipment_family_code": "sample string 8", "equipment_family": { "id": "03cf6507-ff1a-417a-8cca-35af78586a53", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1df8904e-4a4b-4f9e-8e8a-068e6b420cb7", "_parent_code": "sample string 6", "sales_organization_id": "58a99fdf-4348-4b49-82c0-bd79eb24da21", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+00:00" }, "modified_dateutc": "2025-05-28T01:02:54.5246569+00:00" }, "date_in_production_since": "2025-05-28T01:02:54.5246569+00:00", "date_out_of_production_since": "2025-05-28T01:02:54.5246569+00:00", "date_end_support": "2025-05-28T01:02:54.5246569+00:00", "sales_organization_id": "8e32a15a-7f51-4f05-9369-8c53a755d4b0", "sales_organization_code": "sample string 13", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+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-05-28T01:02:54.5402837+00:00" }, "project_status_id": "4ee40574-f4d9-4b5a-a585-943109f5b203", "project_status_code": "sample string 10", "project_status": { "id": "60b44338-b3f6-4641-a808-3bafa4cb79cf", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "81059126-0c2d-4d1a-89b2-b2a81dbca184", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-28T01:02:54.5402837+00:00" }, "company_id": "0621b882-1143-422f-8459-7dd39827c0ba", "company_code": "sample string 12", "db_address_id": "eb9b9ce5-325a-4be1-a1bb-2f3bad803422", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "1254be51-9182-4f30-a8b5-e332fb8c9841", "contact_reference_back_office": "sample string 17", "owner_user_id": "7498e721-5143-407c-96f3-70c58fa0e982", "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-05-28T01:02:54.5402837+00:00", "date_create": "2025-05-28T01:02:54.5402837+00:00", "date_update": "2025-05-28T01:02:54.5402837+00:00", "updated_by_user_id": "f8b68757-8edc-4a5c-931a-f21a39d1a4c8", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-28T01:02:54.5402837+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-05-28T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-28T01:02:54.5402837+00:00", "date_last_job": "2025-05-28T01:02:54.5402837+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-28T01:02:54.5402837+00:00", "modified_dateutc": "2025-05-28T01:02:54.5402837+00:00", "is_mobile_installation": true }, "job_type_id": "18e962d9-ab75-4d9e-adfe-9b2cfee34f33", "job_type_code": "sample string 7", "job_type": { "id": "2fc3e41e-b422-4349-827b-375f8a19cf10", "name": "sample string 2", "sales_organization_id": "688901ad-3820-48d7-8abf-084ab790f1f0", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-28T01:02:54.5402837+00:00", "code": "sample string 7" }, "job_priority_id": "ac1c533a-f8fc-40de-bc8f-e6c7c3ccca5c", "job_priority_code": "sample string 9", "job_priority": { "id": "1832bafb-9116-4a4b-853b-cff5cf53b9b3", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "53e508e8-c40a-47d7-aadc-2305e898fad0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-28T01:02:54.5402837+00:00" }, "job_status_id": "41c55a50-d519-442b-ada0-013955fe5329", "job_status_code": "sample string 11", "db_address_id": "7cc56964-321b-4ded-a048-d14ca4417bdb", "contact_id": "bd595a91-8f96-40f1-b7bb-eed86854e874", "requested_by_company_id": "87453a9b-2512-46a1-ac36-fc43f0d6736b", "requested_by_contact_id": "e55ed7be-f182-4b00-9a7e-264a8f5fc4a7", "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-05-28T01:02:54.5402837+00:00", "due_date": "2025-05-28T01:02:54.5402837+00:00", "date_create": "2025-05-28T01:02:54.5402837+00:00", "date_update": "2025-05-28T01:02:54.5402837+00:00", "date_closed": "2025-05-28T01:02:54.5402837+00:00", "suggested_user_id": "58d20348-d799-40f2-9a43-551ff13092ae", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6a89f7e8-b7d9-4324-b77e-80e8d2c0fb36", "db_language_id": "97238af1-a33d-477e-b476-7f5e936f5d65", "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-05-28T01:02:54.5402837+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "d43b9a09-f87d-45f4-b5c6-24de3adf66de", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b1f8ff25-45b3-4088-8f99-3181a2f5b099", "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": "bc460121-a253-4ab2-b297-15de7bbf4c49", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-28T01:02:54.5402837+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "daa55b81-bcbc-40b8-9ca3-fb268572e7dd" }, "suggested_date_start": "2025-05-28T01:02:54.5402837+00:00", "skill_id": "f5dec179-f7a9-423b-b859-b985bb98c401", "skill_code": "sample string 32", "skill": { "id": "71131af9-9f17-4b2f-9469-f5cfca75ea13", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a65506f2-3f90-4083-952b-4e40249d467c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e263f5ac-573e-44be-85a9-120ef5953a7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "564163a3-86c4-436e-9f37-598159971f73", "db_currency_id": "7e6b10bb-74c0-4f0e-8604-1394e6a97a0e", "db_language_id": "6ee4237e-cee7-47c8-b194-5976177f1491", "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-05-28T01:02:54.5246569+00:00" }, "modified_dateutc": "2025-05-28T01:02:54.5402837+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "8eb49f97-0132-4c8d-847c-d6edca39cdf9", "date_reported_by_company": "2025-05-28T01:02:54.5402837+00:00", "id2": 36, "company_id": "c2d63ba0-5b0f-41a5-8176-a405edca7efb", "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": "f30dc134-9b70-4e14-b89e-3646256f377d", "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-05-28T01:02:54.5402837+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.