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": "fa29ff56-d143-4d35-b330-a2e2d4b4018b", "_parent_id": "4d46476f-3407-42b2-8d72-d76df058b5e8", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3798337d-9bed-4c86-8fcb-964088ca5a76", "project_reference_back_office": "sample string 5", "project": { "id": "b8672722-1e1a-4820-b648-0dc15eeb7e67", "_parent_id": "f98df319-6458-4d68-8751-d2b683de0e9a", "root_parent_id": "10712c44-82f3-4b21-8608-c957d4394f86", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "00f9322a-f2ad-4abe-aed7-597adff171a6", "equipment_family_code": "sample string 6", "equipment_family": { "id": "fa05efbe-7f3d-4c5d-81d0-303f406c4f99", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a1e022f2-62e9-4217-8b49-60ee3012fd81", "_parent_code": "sample string 6", "sales_organization_id": "a16e087f-5d2f-4324-abec-a9aaf597eb84", "sales_organization_code": "sample string 8", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+00:00" }, "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00" }, "equipment_model_id": "c4f76b54-5b49-40c8-b10d-4412046fe5cc", "equipment_model_code": "sample string 8", "equipment_model": { "id": "6454d9cf-a8f9-4e2b-8c90-957002e9911d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "98acf9a4-2be8-4cf1-b94f-8d4c3f594b6f", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a98d16c7-7867-46b6-b73e-60d3c827753f", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "8abdb273-d354-4a4a-9d8c-b3ca8f76b70a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+00:00" }, "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00" }, "equipment_family_id": "ba344742-2210-467a-9843-c5d8d4c978f3", "equipment_family_code": "sample string 8", "equipment_family": { "id": "fa05efbe-7f3d-4c5d-81d0-303f406c4f99", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "a1e022f2-62e9-4217-8b49-60ee3012fd81", "_parent_code": "sample string 6", "sales_organization_id": "a16e087f-5d2f-4324-abec-a9aaf597eb84", "sales_organization_code": "sample string 8", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+00:00" }, "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00" }, "date_in_production_since": "2025-07-03T02:05:38.5144644+00:00", "date_out_of_production_since": "2025-07-03T02:05:38.5144644+00:00", "date_end_support": "2025-07-03T02:05:38.5144644+00:00", "sales_organization_id": "7cbdcdaa-6544-485b-b3b0-603c1df753f3", "sales_organization_code": "sample string 13", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+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-07-03T02:05:38.5144644+00:00" }, "project_status_id": "65e1ca4b-6ac9-4a7a-a649-4e85bf99d4d2", "project_status_code": "sample string 10", "project_status": { "id": "9d153924-2125-4547-91fa-9c80620f8326", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "9acfe4f4-3279-4ade-8eaa-258935ef4cab", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00" }, "company_id": "ae6051c9-22cf-45e5-9d38-d573f2fa506e", "company_code": "sample string 12", "db_address_id": "1b49d258-716b-4ee7-8902-60edbc749499", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "f77eba40-faba-4f4a-9eb5-67349b2a44c4", "contact_reference_back_office": "sample string 17", "owner_user_id": "bf86707e-4a35-437f-8c76-8e3f17b1824d", "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-07-03T02:05:38.5144644+00:00", "date_create": "2025-07-03T02:05:38.5144644+00:00", "date_update": "2025-07-03T02:05:38.5144644+00:00", "updated_by_user_id": "ec686af5-814b-4f1d-89c0-2399a7ebacf1", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-03T02:05:38.5144644+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-07-03T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-03T02:05:38.5144644+00:00", "date_last_job": "2025-07-03T02:05:38.5144644+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-03T02:05:38.5144644+00:00", "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00", "is_mobile_installation": true }, "job_type_id": "545b2756-e895-4c5f-b263-3c9790d08470", "job_type_code": "sample string 7", "job_type": { "id": "2345cb3d-c414-47da-8dbd-370bd5d34d07", "name": "sample string 2", "sales_organization_id": "6d48dabd-59ef-4261-a336-2378be0e4a56", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00", "code": "sample string 7" }, "job_priority_id": "844c1d51-b9d0-43fd-831b-1cd91da6d66d", "job_priority_code": "sample string 9", "job_priority": { "id": "cdae29f8-2209-4eb3-a505-e1b71692b801", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8187f9dc-ee8d-411e-80d7-733529eef2a9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00" }, "job_status_id": "057bbd6f-2f5f-4a12-8b87-516b6e46df2e", "job_status_code": "sample string 11", "db_address_id": "6e9d02c7-52a6-4eeb-a945-0c5137596d95", "contact_id": "05f0f58a-ca8e-4273-8c47-ad6004483aa3", "requested_by_company_id": "291a75fd-7ade-4fab-91b1-5af900d5257c", "requested_by_contact_id": "752ce677-310d-4014-a3e3-ba98b596c3bf", "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-07-03T02:05:38.5144644+00:00", "due_date": "2025-07-03T02:05:38.5144644+00:00", "date_create": "2025-07-03T02:05:38.5144644+00:00", "date_update": "2025-07-03T02:05:38.5144644+00:00", "date_closed": "2025-07-03T02:05:38.5144644+00:00", "suggested_user_id": "9189e972-9dc1-4535-9c8b-7597f694d0b4", "suggested_user_code": "sample string 29", "suggested_user": { "id": "0c797577-527e-4af4-80b1-2a1ce9579fc6", "db_language_id": "d2002e22-65cf-465a-85de-334e5a63d1a4", "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-07-03T02:05:38.5144644+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "3268d890-71fa-4fac-9991-6a48fe92f5a6", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "57ca9ce5-3508-4d7b-a124-a9aa317bf504", "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": "11960f33-3dea-43f2-bbbb-e524dee4f441", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-03T02:05:38.5144644+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "ef031283-2237-4b8a-ab58-cff3f123920a" }, "suggested_date_start": "2025-07-03T02:05:38.5144644+00:00", "skill_id": "b2513173-a55e-415d-8c15-00abd062b639", "skill_code": "sample string 32", "skill": { "id": "78027ee8-3c43-466a-a64b-2739dd291feb", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "24a859ac-6e67-44b4-b4fa-3f1eccfe1641", "sales_organization_code": "sample string 6", "sales_organization": { "id": "2729385b-07f5-40dc-bc8e-186b560799f8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "44d3de11-73ed-46f0-a838-5b01584d9876", "db_currency_id": "e18fae22-3734-4893-9e8c-bcf73528b5e8", "db_language_id": "f717d141-2c5b-4f7a-b654-dcdfa61a0093", "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-07-03T02:05:38.5144644+00:00" }, "modified_dateutc": "2025-07-03T02:05:38.5300934+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "4a7f0523-b62c-4ab7-b62b-1136cb1ea9f1", "date_reported_by_company": "2025-07-03T02:05:38.5300934+00:00", "id2": 36, "company_id": "98decd6c-3e55-4eba-b732-c652662efbad", "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": "7f89ca1a-4684-406d-ad95-e91bfef57e6e", "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-07-03T02:05:38.5300934+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.