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": "fb2c3d8b-136d-4a71-b2f7-e5b95cde5514", "_parent_id": "9e7d71ff-7799-49dc-a824-286953b12879", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "e3835114-4eb8-4933-88bd-76f87583a42a", "project_reference_back_office": "sample string 5", "project": { "id": "33962a60-ec47-421c-b5ce-e7710728b358", "_parent_id": "ffee3f87-dc9f-4b17-ab9f-11b60ea59221", "root_parent_id": "c245e566-288b-4b43-8960-22d541958cc6", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "c3dcb089-0cda-44d2-9a44-d4821fe2c1dc", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d7bff34d-9478-4b23-9d10-5069974d750f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5b2b8bd1-c999-4f89-88fb-a54cf68f5397", "_parent_code": "sample string 6", "sales_organization_id": "9b6f7672-389b-4419-a39b-838060cb7c80", "sales_organization_code": "sample string 8", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+00:00" }, "modified_dateutc": "2024-11-18T05:43:00.1847686+00:00" }, "equipment_model_id": "7965fe7d-e2d9-4a4c-9a50-b479e337be1f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "dc75db8b-069c-423a-bd9e-8807916ee4e4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "70fb8767-f1de-4212-b1a6-ec97c9fc7c93", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "3343dd0a-172b-421f-aaca-45211443a9fc", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "fd163183-b8e0-4d87-8f2a-9bff6ea1be82", "sales_organization_code": "sample string 5", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+00:00" }, "modified_dateutc": "2024-11-18T05:43:00.1847686+00:00" }, "equipment_family_id": "207f9780-54e9-4aa4-b445-7a7a8a928b79", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d7bff34d-9478-4b23-9d10-5069974d750f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5b2b8bd1-c999-4f89-88fb-a54cf68f5397", "_parent_code": "sample string 6", "sales_organization_id": "9b6f7672-389b-4419-a39b-838060cb7c80", "sales_organization_code": "sample string 8", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+00:00" }, "modified_dateutc": "2024-11-18T05:43:00.1847686+00:00" }, "date_in_production_since": "2024-11-18T05:43:00.1847686+00:00", "date_out_of_production_since": "2024-11-18T05:43:00.1847686+00:00", "date_end_support": "2024-11-18T05:43:00.1847686+00:00", "sales_organization_id": "01975321-78a7-4011-b6fa-868f69a3ac09", "sales_organization_code": "sample string 13", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+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-11-18T05:43:00.1847686+00:00" }, "project_status_id": "5ce733d8-9bed-43c5-b712-c75a25c23d8d", "project_status_code": "sample string 10", "project_status": { "id": "d0a79150-111d-4933-bafa-24830618168b", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "fc5147f5-e9ca-4bd3-9491-a00ad846f9ba", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-18T05:43:00.2003961+00:00" }, "company_id": "54d18fb6-d483-4fa1-9dad-1add3efbda6b", "company_code": "sample string 12", "db_address_id": "3698e135-ab3c-4d59-bc04-19e8dd34208f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b22305f0-e47f-4ba6-8147-6971154c2722", "contact_reference_back_office": "sample string 17", "owner_user_id": "4f6006b8-6380-44da-a8b9-a996051f3476", "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-11-18T05:43:00.2003961+00:00", "date_create": "2024-11-18T05:43:00.2003961+00:00", "date_update": "2024-11-18T05:43:00.2003961+00:00", "updated_by_user_id": "4125df51-1c6e-40d9-b891-e422c5bc17f7", "customer_reference": "sample string 28", "warranty_date_until": "2024-11-18T05:43:00.2003961+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-11-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-11-18T05:43:00.2003961+00:00", "date_last_job": "2024-11-18T05:43:00.2003961+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-11-18T05:43:00.2003961+00:00", "modified_dateutc": "2024-11-18T05:43:00.2003961+00:00", "is_mobile_installation": true }, "job_type_id": "66f95fa1-5705-4926-b485-304f879d6d17", "job_type_code": "sample string 7", "job_type": { "id": "74dd9a9e-8292-4c05-86f7-550c45355bb7", "name": "sample string 2", "sales_organization_id": "c5130e1c-fc4e-412b-8968-eb401a0a4d38", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-11-18T05:43:00.2003961+00:00", "code": "sample string 7" }, "job_priority_id": "7d0c091a-6f7c-419c-8686-5bb3029a97f9", "job_priority_code": "sample string 9", "job_priority": { "id": "2fedcc53-0864-484a-ab71-62b455c0a020", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "84b2593a-26e8-4c49-8a3f-f93efa0c139c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-18T05:43:00.2003961+00:00" }, "job_status_id": "6ee23ee7-b57b-4658-83ac-57206359897d", "job_status_code": "sample string 11", "db_address_id": "5984aa7b-d62f-4a64-9614-9f4843635a07", "contact_id": "11ae054e-0807-4843-b5d5-b44bd1a0cdf1", "requested_by_company_id": "e83ae1a5-22fe-4593-92b5-35bbfcd0c76c", "requested_by_contact_id": "ecd5a8f9-1eca-4a08-88eb-16661bb8dd75", "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-11-18T05:43:00.2003961+00:00", "due_date": "2024-11-18T05:43:00.2003961+00:00", "date_create": "2024-11-18T05:43:00.2003961+00:00", "date_update": "2024-11-18T05:43:00.2003961+00:00", "date_closed": "2024-11-18T05:43:00.2003961+00:00", "suggested_user_id": "e16d6d43-e9ce-4141-b7ed-8c22c188c1c4", "suggested_user_code": "sample string 29", "suggested_user": { "id": "1be359e7-e1b9-4b7b-a47d-8f185775bd9f", "db_language_id": "d39db893-c90e-4018-821e-836101693595", "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-11-18T05:43:00.2003961+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b0f73712-7810-4ea9-915f-c2afe9c6b589", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "9d410c0b-a3ba-4154-8924-0c586ab39fd3", "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": "408bf83b-01c4-47f6-9953-34306c90fc68", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-11-18T05:43:00.2003961+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "bcaae321-037c-45d7-8345-8fa82295ace1" }, "suggested_date_start": "2024-11-18T05:43:00.2003961+00:00", "skill_id": "1d3935ba-ef19-4a77-ac12-3f9dea1434eb", "skill_code": "sample string 32", "skill": { "id": "34742080-1486-4b45-b684-3f3c3e3c6d61", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "eb6641e5-88ba-40ba-968f-5bc1d5e0d1a0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2c0f1300-90a7-4e7f-b3e6-d790b2585837", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "555be3db-d9d7-4406-baf8-0320dc039b52", "db_currency_id": "a62ef636-85b6-408b-b566-d776fe4f3e63", "db_language_id": "9857b579-e2de-4687-9dfa-b210f506d574", "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-11-18T05:43:00.1847686+00:00" }, "modified_dateutc": "2024-11-18T05:43:00.2003961+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fbfba4ba-4ba4-4b60-9467-b0a0ca3fcd0d", "date_reported_by_company": "2024-11-18T05:43:00.2003961+00:00", "id2": 36, "company_id": "cb8bb71e-d2f8-4aa8-9ba0-4d8c3aa4e5dc", "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": "850229cd-87d9-4e7e-8058-64b43b948142", "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-11-18T05:43:00.2003961+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.