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": "03545188-1df1-4dd6-8eed-41129679f6ad", "_parent_id": "cf106dc6-7817-4d2e-a5b0-2d241768cfe6", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "88b1fe79-7366-4bae-a29a-146c8a94e1c8", "project_reference_back_office": "sample string 5", "project": { "id": "f1106d3b-4463-46b7-9fa7-84f7e4c76b98", "_parent_id": "c56510ae-e716-4aff-8126-76b78cfeec10", "root_parent_id": "eca6ffb8-1797-41ed-801c-d73ce5cdd102", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "da766203-9411-46bf-95d2-dfe2146a9ece", "equipment_family_code": "sample string 6", "equipment_family": { "id": "fcdd770d-0183-4a0e-b342-0be1b05d363e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "928d201a-a6bc-4c4f-b543-c3aff7b67ed9", "_parent_code": "sample string 6", "sales_organization_id": "ea92252d-9ab2-4268-9087-cc671160fb48", "sales_organization_code": "sample string 8", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+00:00" }, "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00" }, "equipment_model_id": "d2f1411b-a709-4933-b7bf-23173b651c73", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f6d2bd60-b043-4c76-ad58-f618e30897f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "7306ed86-46b6-425a-9a61-19daa721421f", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "361bb093-af27-458b-a2b6-c792da576e3a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "472c0375-39dd-4f2f-8607-793860da9b04", "sales_organization_code": "sample string 5", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+00:00" }, "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00" }, "equipment_family_id": "b081c2d9-e892-4b43-99c1-01e3328e7eed", "equipment_family_code": "sample string 8", "equipment_family": { "id": "fcdd770d-0183-4a0e-b342-0be1b05d363e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "928d201a-a6bc-4c4f-b543-c3aff7b67ed9", "_parent_code": "sample string 6", "sales_organization_id": "ea92252d-9ab2-4268-9087-cc671160fb48", "sales_organization_code": "sample string 8", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+00:00" }, "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00" }, "date_in_production_since": "2025-01-22T01:18:55.7780977+00:00", "date_out_of_production_since": "2025-01-22T01:18:55.7780977+00:00", "date_end_support": "2025-01-22T01:18:55.7780977+00:00", "sales_organization_id": "8078110e-38d2-4d3a-b9ba-bf7e35b206db", "sales_organization_code": "sample string 13", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+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-01-22T01:18:55.7780977+00:00" }, "project_status_id": "89278c9e-e12a-4581-bcba-b336dd663898", "project_status_code": "sample string 10", "project_status": { "id": "2d337f33-fd3c-4288-97c7-99685a850467", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "fb425a78-3e88-442d-8d4a-8161b3d8975e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00" }, "company_id": "654f1709-da8a-4197-88a9-b5c01466f89c", "company_code": "sample string 12", "db_address_id": "acfc6c0d-29dc-4ea0-ad12-a083f130d667", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "7c692017-fdcf-4dd7-8672-fc8884fe870b", "contact_reference_back_office": "sample string 17", "owner_user_id": "6526fe81-a347-4d9c-8022-50d571609384", "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-01-22T01:18:55.7780977+00:00", "date_create": "2025-01-22T01:18:55.7780977+00:00", "date_update": "2025-01-22T01:18:55.7780977+00:00", "updated_by_user_id": "d5e5fc19-3139-4a47-ba48-7ab93fc2db21", "customer_reference": "sample string 28", "warranty_date_until": "2025-01-22T01:18:55.7780977+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-01-22T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-01-22T01:18:55.7780977+00:00", "date_last_job": "2025-01-22T01:18:55.7780977+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-01-22T01:18:55.7780977+00:00", "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00", "is_mobile_installation": true }, "job_type_id": "a8097156-fd29-49de-8962-77863d6e41b1", "job_type_code": "sample string 7", "job_type": { "id": "5b5ab2d9-56e3-4fd3-9481-1b25279fc2de", "name": "sample string 2", "sales_organization_id": "849001d2-ad21-42f2-a75a-5cc397b63e9a", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00", "code": "sample string 7" }, "job_priority_id": "0670bc4f-5553-49bf-9481-a7348c14747e", "job_priority_code": "sample string 9", "job_priority": { "id": "50caaee5-0abc-44a1-bf1b-5f57363b9cdc", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "fbf91c49-6c10-41b8-bbc4-1f375089017b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00" }, "job_status_id": "7b337e5e-d0bc-41f4-bc52-88b6e6275619", "job_status_code": "sample string 11", "db_address_id": "87245d89-509a-4968-ae44-b027d504f523", "contact_id": "21700c24-6f48-4ee6-bfa3-f8511294af9e", "requested_by_company_id": "0d33fd86-f9e6-4f15-a4f7-db71ff6f2ed3", "requested_by_contact_id": "4280280b-c423-481b-9324-13c35e44bd43", "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-01-22T01:18:55.7780977+00:00", "due_date": "2025-01-22T01:18:55.7780977+00:00", "date_create": "2025-01-22T01:18:55.7780977+00:00", "date_update": "2025-01-22T01:18:55.7780977+00:00", "date_closed": "2025-01-22T01:18:55.7780977+00:00", "suggested_user_id": "d3c39a90-00fb-4db9-85e3-b6fbbc0f53ef", "suggested_user_code": "sample string 29", "suggested_user": { "id": "0827a67f-4da8-4339-8764-2ae58ca32e33", "db_language_id": "921cf6b6-3f85-4e52-a86f-6b6629c7c068", "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-01-22T01:18:55.7780977+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2a9c331d-1b29-4984-b3c5-9ad715ac13c5", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "ef75e7c0-79c9-4da2-ad72-5c3b90fefaa5", "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": "5e456c2b-682e-4962-bdd4-da798095f8d8", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "b60a432e-f4b0-43e6-b331-7ada0b81551a" }, "suggested_date_start": "2025-01-22T01:18:55.7780977+00:00", "skill_id": "0f8be53c-70c6-42b5-adf2-5ee583aac9c5", "skill_code": "sample string 32", "skill": { "id": "1cf480b2-8451-4907-b6ad-0b5994076ef8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "cd00458c-7504-4123-ae44-d3de5ea20fea", "sales_organization_code": "sample string 6", "sales_organization": { "id": "73dbdad4-5041-49cc-8290-bcd934298bdf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "46e4f74f-0317-4159-893f-54bae67b95e2", "db_currency_id": "69b2ae6b-e89d-4748-866a-fe1daf90a628", "db_language_id": "507048a9-f401-4135-9854-f3e0ccb162ea", "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-01-22T01:18:55.7780977+00:00" }, "modified_dateutc": "2025-01-22T01:18:55.7780977+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "402ea77a-0d0d-4da5-8ee1-66347503586f", "date_reported_by_company": "2025-01-22T01:18:55.7780977+00:00", "id2": 36, "company_id": "03687cef-4f03-40d0-a2e5-13c1d74dfda6", "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": "1eb5dad9-e173-4863-82c9-973d2047cf56", "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-01-22T01:18:55.7780977+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.