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": "649d7bb4-be63-449c-93e3-b5ac1268161e", "_parent_id": "7667762f-ab86-4da5-8bbc-8ecd8169d711", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "38f74931-36e3-4631-986f-30fe89ea5798", "project_reference_back_office": "sample string 5", "project": { "id": "da6c0491-6af6-4b04-b128-32cc30fdcc5c", "_parent_id": "8f028058-f838-48e9-bbec-426a41d0dd57", "root_parent_id": "b87da53d-9f1f-4aba-9854-94240cfbddc7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "f467c8f1-1cbe-4003-a95d-427ab21006c9", "equipment_family_code": "sample string 6", "equipment_family": { "id": "b5d8a727-e5f0-4e86-8ee6-3ac24796a20b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c6131743-ea9c-4298-8742-9e4a5b019b58", "_parent_code": "sample string 6", "sales_organization_id": "a835d1a3-6582-443b-b37e-f91b32ac4a3f", "sales_organization_code": "sample string 8", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+00:00" }, "modified_dateutc": "2025-04-25T15:54:10.0912286+00:00" }, "equipment_model_id": "6216ec9a-4b1b-445c-b6f9-470f6738f2d7", "equipment_model_code": "sample string 8", "equipment_model": { "id": "0c3e9311-275f-4203-a72c-9459f31e0c39", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "6237c97c-f353-4bb8-8a25-c830ce1f7d85", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "52b4d95c-ab74-4e5b-8df8-5d62e51c0d15", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3775c118-7840-4011-8d36-267e539c6d18", "sales_organization_code": "sample string 5", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+00:00" }, "modified_dateutc": "2025-04-25T15:54:10.0912286+00:00" }, "equipment_family_id": "ab55ac0c-1af7-477c-b885-c8da457c0b62", "equipment_family_code": "sample string 8", "equipment_family": { "id": "b5d8a727-e5f0-4e86-8ee6-3ac24796a20b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c6131743-ea9c-4298-8742-9e4a5b019b58", "_parent_code": "sample string 6", "sales_organization_id": "a835d1a3-6582-443b-b37e-f91b32ac4a3f", "sales_organization_code": "sample string 8", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+00:00" }, "modified_dateutc": "2025-04-25T15:54:10.0912286+00:00" }, "date_in_production_since": "2025-04-25T15:54:10.0912286+00:00", "date_out_of_production_since": "2025-04-25T15:54:10.0912286+00:00", "date_end_support": "2025-04-25T15:54:10.0912286+00:00", "sales_organization_id": "bdd3a9e0-dbdd-4eba-9e30-cc819b52eb02", "sales_organization_code": "sample string 13", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+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-04-25T15:54:10.0912286+00:00" }, "project_status_id": "c03208a1-822b-49e0-9158-234666d3fd34", "project_status_code": "sample string 10", "project_status": { "id": "ec1fee63-cd5a-4fd8-9874-f1bbc62b18a7", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "caf5788c-b3bc-43b6-a5be-80a02eb76b06", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T15:54:10.0912286+00:00" }, "company_id": "20a35e9f-bf3e-40af-ab73-48c058bed20a", "company_code": "sample string 12", "db_address_id": "beab8a23-467f-4d7d-b9f2-cc853d3e54e2", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "7f8cef25-d759-4f4a-ab8b-9453b155a8e2", "contact_reference_back_office": "sample string 17", "owner_user_id": "ef8d2a4c-baa2-44e5-bb21-70ddef755754", "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-04-25T15:54:10.0912286+00:00", "date_create": "2025-04-25T15:54:10.0912286+00:00", "date_update": "2025-04-25T15:54:10.0912286+00:00", "updated_by_user_id": "53ec08d2-f84b-4c39-b60a-9ad4366ebd94", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-25T15:54:10.0912286+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-04-25T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-25T15:54:10.0912286+00:00", "date_last_job": "2025-04-25T15:54:10.0912286+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-25T15:54:10.0912286+00:00", "modified_dateutc": "2025-04-25T15:54:10.0912286+00:00", "is_mobile_installation": true }, "job_type_id": "36ea4409-9415-4548-9603-89372e6b7f66", "job_type_code": "sample string 7", "job_type": { "id": "5ab07a81-af45-4af7-8b86-ff972e72b734", "name": "sample string 2", "sales_organization_id": "da67fb82-6597-4115-a662-b4a9ab11ba6a", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-25T15:54:10.0912286+00:00", "code": "sample string 7" }, "job_priority_id": "90b8eaa8-0f6f-4107-bf43-9833844dc76a", "job_priority_code": "sample string 9", "job_priority": { "id": "2f78e921-7080-4834-b674-fd89064fc416", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8dc47c66-65c7-4b12-a690-5762bf1f15f8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T15:54:10.0912286+00:00" }, "job_status_id": "38e1bd6d-c768-43e8-b4d4-a7b432801726", "job_status_code": "sample string 11", "db_address_id": "526e9ca2-4c36-464e-b65b-13f6c51ee853", "contact_id": "298ed8f4-5244-4963-aeba-5b638bd9f88a", "requested_by_company_id": "b4af12a2-0ef5-49b9-92c9-ee5083c56459", "requested_by_contact_id": "ba1996a8-89be-4978-92b6-6f761bb51de7", "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-04-25T15:54:10.0912286+00:00", "due_date": "2025-04-25T15:54:10.0912286+00:00", "date_create": "2025-04-25T15:54:10.0912286+00:00", "date_update": "2025-04-25T15:54:10.0912286+00:00", "date_closed": "2025-04-25T15:54:10.0912286+00:00", "suggested_user_id": "d6c1aa70-a996-467f-a6f0-fd0a094f2672", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6ba9ec35-d646-44e0-9c97-3935b5e40f9d", "db_language_id": "beff7f12-539f-419d-9156-fa6ba192d3bc", "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-04-25T15:54:10.1068543+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "36ecb9ea-99e5-411c-ac77-d7801f3fe7a1", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "2447da54-a7a7-4789-b725-71c03381bda0", "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": "8049688f-2a9c-4b2f-83cf-3e389f6546d6", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-25T15:54:10.1068543+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "5fb31900-dac3-4087-8016-06516946429b" }, "suggested_date_start": "2025-04-25T15:54:10.1068543+00:00", "skill_id": "e53dc2e9-2521-4e39-9e01-8fa4a9a87f11", "skill_code": "sample string 32", "skill": { "id": "6e0779b2-1568-4df0-9a86-3d029e8db380", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "c9faea15-19fb-4edb-803a-c65fc4aa9256", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2cb0275b-70ba-4d42-84b7-a6953a9a06dd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "89afabee-795c-4630-aa28-44de5322aad2", "db_currency_id": "dbeaec77-a661-4841-93c8-d4d53fe0785c", "db_language_id": "caf402b8-06e7-42b4-bfd4-1aade50f29e0", "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-04-25T15:54:10.0912286+00:00" }, "modified_dateutc": "2025-04-25T15:54:10.1068543+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "356b3448-6fc6-4d72-bf96-d0ba964a7086", "date_reported_by_company": "2025-04-25T15:54:10.1068543+00:00", "id2": 36, "company_id": "6a88db49-e821-4f8a-842a-092f1e482709", "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": "984e667c-f6df-4fe1-adfb-d5dcad21b1e8", "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-04-25T15:54:10.1068543+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.