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": "02d89859-aa33-4618-840b-ad019cf1386a", "_parent_id": "3aa9932d-9a36-48c3-b945-d281e5a16bc2", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c16ab59c-7685-462d-beea-c92a5cb78ea3", "project_reference_back_office": "sample string 5", "project": { "id": "597df97c-2ae1-4d69-b7bd-dd00a53e36d5", "_parent_id": "b7234f7a-f906-48ba-a232-c46d18ac5104", "root_parent_id": "b90fbf71-ca79-44d9-897a-51717c737110", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "8a2f6ada-0c25-486f-99a8-31c70faa1496", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f5693d69-f374-4fb1-88e1-a5ea466f72f4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5d516b2d-f079-42fc-8f80-8c029ee32be7", "_parent_code": "sample string 6", "sales_organization_id": "e501f500-f8d5-4a16-89c8-34d3a6c39399", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+00:00" }, "modified_dateutc": "2024-12-27T03:21:25.7110729+00:00" }, "equipment_model_id": "ed104c3e-8f2c-4603-b825-5e61fc129165", "equipment_model_code": "sample string 8", "equipment_model": { "id": "8917b7d8-2406-4c26-b41d-b11d3e487bbd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "af9a7703-f05d-45ef-8c46-276da4009cb1", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a53b2044-4109-4993-9715-b4393f927e3e", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "1c1f627d-e172-4351-8362-423ad8912921", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+00:00" }, "modified_dateutc": "2024-12-27T03:21:25.7110729+00:00" }, "equipment_family_id": "b5321e26-06a0-4e48-9030-7c52683a04a0", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f5693d69-f374-4fb1-88e1-a5ea466f72f4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5d516b2d-f079-42fc-8f80-8c029ee32be7", "_parent_code": "sample string 6", "sales_organization_id": "e501f500-f8d5-4a16-89c8-34d3a6c39399", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+00:00" }, "modified_dateutc": "2024-12-27T03:21:25.7110729+00:00" }, "date_in_production_since": "2024-12-27T03:21:25.7110729+00:00", "date_out_of_production_since": "2024-12-27T03:21:25.7110729+00:00", "date_end_support": "2024-12-27T03:21:25.7110729+00:00", "sales_organization_id": "f25c25c7-6ff0-4faa-8f2e-8b75fc6645e9", "sales_organization_code": "sample string 13", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+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": "2024-12-27T03:21:25.7110729+00:00" }, "project_status_id": "14f19760-086d-4111-b1cc-0934cface2fe", "project_status_code": "sample string 10", "project_status": { "id": "d60b9372-80e7-4da2-857c-6b8f0229150c", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "6e314db1-1457-400f-a230-f2a7c0e2c3eb", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-27T03:21:25.7110729+00:00" }, "company_id": "66d4bdbe-e157-4fbc-8855-e4281a5efaa2", "company_code": "sample string 12", "db_address_id": "659afa6c-2edf-48b9-b758-d3a79afb7d4c", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "2e627aaf-ed82-410e-bef1-1bb2faa4ab89", "contact_reference_back_office": "sample string 17", "owner_user_id": "d99534de-8f1b-4557-a2d2-43a8f7e6dd58", "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": "2024-12-27T03:21:25.7266998+00:00", "date_create": "2024-12-27T03:21:25.7266998+00:00", "date_update": "2024-12-27T03:21:25.7266998+00:00", "updated_by_user_id": "99045131-2bb5-4435-a6c5-61e19c88a19e", "customer_reference": "sample string 28", "warranty_date_until": "2024-12-27T03:21:25.7266998+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": "2024-12-27T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-12-27T03:21:25.7266998+00:00", "date_last_job": "2024-12-27T03:21:25.7266998+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-12-27T03:21:25.7266998+00:00", "modified_dateutc": "2024-12-27T03:21:25.7266998+00:00", "is_mobile_installation": true }, "job_type_id": "2b26e5e2-a9d3-4f78-a221-e022f47a9c4c", "job_type_code": "sample string 7", "job_type": { "id": "79f0d28d-ccfa-4033-a8da-7dd10e549156", "name": "sample string 2", "sales_organization_id": "2de95057-a133-4f90-b2e4-73f81d80b93d", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-12-27T03:21:25.7266998+00:00", "code": "sample string 7" }, "job_priority_id": "d8d44f63-5836-4a89-adb4-47db5cdd58a3", "job_priority_code": "sample string 9", "job_priority": { "id": "054fae1f-a252-4827-b8a3-2f1b6f61a817", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9aaac495-7473-4662-ae18-4dee474c9a0b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-27T03:21:25.7266998+00:00" }, "job_status_id": "49c36396-ec8c-49d2-9b95-7f19e222edef", "job_status_code": "sample string 11", "db_address_id": "2c20272a-0225-44d7-81b5-80c556181e47", "contact_id": "91cfa03d-cb22-45c0-ba3c-3cf4d2219b27", "requested_by_company_id": "715aa171-6e82-46f1-a10f-b9d7f926a2dd", "requested_by_contact_id": "fb468d1d-8ebf-43fb-b9fb-a4807ff3178c", "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": "2024-12-27T03:21:25.7266998+00:00", "due_date": "2024-12-27T03:21:25.7266998+00:00", "date_create": "2024-12-27T03:21:25.7266998+00:00", "date_update": "2024-12-27T03:21:25.7266998+00:00", "date_closed": "2024-12-27T03:21:25.7266998+00:00", "suggested_user_id": "206f933d-6130-4eb7-af2c-93fd10fc3f2f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "422538e7-b445-4eae-a027-9f765a56a075", "db_language_id": "17e4d8a3-ac99-4f71-aee9-682619d10e29", "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": "2024-12-27T03:21:25.7266998+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "7a025be1-f5bb-499e-9514-315154fdeaa4", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "2f8ce8c3-3297-4bb9-8c93-15c90eac93fb", "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": "1d093371-050d-4503-a4e6-b0c0661fa1fb", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-12-27T03:21:25.7266998+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "023d86d2-fdc0-49e8-b912-bbd7f41b644b" }, "suggested_date_start": "2024-12-27T03:21:25.7266998+00:00", "skill_id": "36d21202-0619-4532-a700-86aa80db70d6", "skill_code": "sample string 32", "skill": { "id": "c10a4262-a5a8-4d2d-a21e-168926dd980f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "7c0fcccd-d783-49f0-94a4-55d652a4c388", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c2498336-e235-4047-b858-3afa293c1cd5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "74831478-2239-4a2f-9470-ed6cb23c3d4c", "db_currency_id": "bdf0bfef-52d0-4045-ab37-8a3b7a776765", "db_language_id": "b094da88-be01-42e2-b9f0-8e573a6a73a1", "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": "2024-12-27T03:21:25.7110729+00:00" }, "modified_dateutc": "2024-12-27T03:21:25.7266998+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "f31955d8-c4c9-4e45-849a-809342ca7b1d", "date_reported_by_company": "2024-12-27T03:21:25.7266998+00:00", "id2": 36, "company_id": "062432b3-c110-4aca-979d-1b557b34a84f", "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": "ac3c2572-d8de-4dbc-9e79-6fa557d285d9", "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": "2024-12-27T03:21:25.7266998+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.