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": "763e2bde-222d-4bde-967f-4c3fbc2866f9", "_parent_id": "c2ca9a30-d3f1-4c7f-82a3-c8d60d4b764d", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c768a6a3-5e69-4a8e-880d-99a4c47dae87", "project_reference_back_office": "sample string 5", "project": { "id": "68713d37-e284-4d0c-84e7-eb311097cb74", "_parent_id": "7b0a4025-665e-4c81-8f50-da8c9525f0af", "root_parent_id": "0bebb713-c0fa-492e-93e4-13c884f4f23b", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "cacafbb2-39d8-4081-896e-853885930d33", "equipment_family_code": "sample string 6", "equipment_family": { "id": "5ec32bab-94ef-42a5-bc5c-5b7be38f80b1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ea570072-d095-4de8-947d-bbc4489d3eb1", "_parent_code": "sample string 6", "sales_organization_id": "f4ec0e81-dd8d-4d27-a388-381c65f1994b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+00:00" }, "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00" }, "equipment_model_id": "4cb1a4cb-9c5e-4a24-a00a-41b07724c576", "equipment_model_code": "sample string 8", "equipment_model": { "id": "3a4d8c71-d3ee-4968-aeae-9b3017230af8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "b66370ec-abde-4157-bfad-9a77b61bfe79", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "8645dc82-b6a9-4c08-ba71-62983d5aad85", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "5e12a825-f1f1-417e-9206-5a7c204c6db7", "sales_organization_code": "sample string 5", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+00:00" }, "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00" }, "equipment_family_id": "d1c9eaab-3e9a-4ed0-a8d7-477a58b79546", "equipment_family_code": "sample string 8", "equipment_family": { "id": "5ec32bab-94ef-42a5-bc5c-5b7be38f80b1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ea570072-d095-4de8-947d-bbc4489d3eb1", "_parent_code": "sample string 6", "sales_organization_id": "f4ec0e81-dd8d-4d27-a388-381c65f1994b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+00:00" }, "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00" }, "date_in_production_since": "2025-08-11T10:28:45.2321343+00:00", "date_out_of_production_since": "2025-08-11T10:28:45.2321343+00:00", "date_end_support": "2025-08-11T10:28:45.2321343+00:00", "sales_organization_id": "11fac21f-93ce-4692-8f3f-39194b3b11dc", "sales_organization_code": "sample string 13", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+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-08-11T10:28:45.2321343+00:00" }, "project_status_id": "34b3e17b-8740-44f2-95a2-ee8ee5aebc84", "project_status_code": "sample string 10", "project_status": { "id": "f732c9a9-1af2-4d27-ab90-392bfd5dd2ce", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "b836b57a-dec5-4afc-bebd-ac8b27d22996", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00" }, "company_id": "909b5ffa-a522-4744-bd34-3e10bfac2da6", "company_code": "sample string 12", "db_address_id": "dc8f3e14-6109-4f3a-9bb8-95f3f72790b9", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b3d52401-0068-4e63-98d1-76186ecb4641", "contact_reference_back_office": "sample string 17", "owner_user_id": "a09086cb-ea36-4920-9b87-cebd79065200", "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-08-11T10:28:45.2321343+00:00", "date_create": "2025-08-11T10:28:45.2321343+00:00", "date_update": "2025-08-11T10:28:45.2321343+00:00", "updated_by_user_id": "cd2c7563-3672-42dc-8329-55cc2928ab90", "customer_reference": "sample string 28", "warranty_date_until": "2025-08-11T10:28:45.2321343+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-08-11T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-08-11T10:28:45.2321343+00:00", "date_last_job": "2025-08-11T10:28:45.2321343+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-08-11T10:28:45.2321343+00:00", "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00", "is_mobile_installation": true }, "job_type_id": "73c8b9ad-fcdf-4e6f-835e-58f804af7639", "job_type_code": "sample string 7", "job_type": { "id": "1b018819-fe2a-4dbd-9952-387aa0def653", "name": "sample string 2", "sales_organization_id": "ce9b36cd-9387-4ad1-9c9b-25c36615432c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00", "code": "sample string 7" }, "job_priority_id": "a56ba788-d53b-4480-8a04-3dc942f068dd", "job_priority_code": "sample string 9", "job_priority": { "id": "69e8faeb-0a8a-4f1d-89f7-81f1c417f824", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "50a4984a-9d5f-4a45-899d-9989d8d8b7c5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00" }, "job_status_id": "5b783953-f8b3-454c-85cd-2187a154de5b", "job_status_code": "sample string 11", "db_address_id": "abdc7240-2bdf-4252-9c8a-be9bd385bc76", "contact_id": "7826e797-79fc-4e55-b8fc-a015845a948b", "requested_by_company_id": "60344d6a-5722-4e92-a91c-cecd6060a332", "requested_by_contact_id": "ff053dcc-899d-4030-9922-4a52b39a4a38", "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-08-11T10:28:45.2321343+00:00", "due_date": "2025-08-11T10:28:45.2321343+00:00", "date_create": "2025-08-11T10:28:45.2321343+00:00", "date_update": "2025-08-11T10:28:45.2321343+00:00", "date_closed": "2025-08-11T10:28:45.2321343+00:00", "suggested_user_id": "4f9aaa23-de65-42b5-b99b-7ab68023eae2", "suggested_user_code": "sample string 29", "suggested_user": { "id": "f8933261-e094-4b7a-9878-10aef95f0eb1", "db_language_id": "62d9603a-7bb0-427f-bbc3-509ed2f76e6e", "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-08-11T10:28:45.2321343+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "9c10cc9d-4f64-4606-a989-f1dfd75cc985", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "f1c6fde0-6840-4a82-9cb6-9f0247aabbbe", "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": "d05ff953-3db6-403f-9b1b-83a1ef7577db", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "09194a71-36dc-4deb-8ce8-359bf8bb554a" }, "suggested_date_start": "2025-08-11T10:28:45.2321343+00:00", "skill_id": "cc860e28-7cf6-4047-85cb-07719b344347", "skill_code": "sample string 32", "skill": { "id": "30a05254-92cd-40d2-891a-0fdd6d2acc53", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "d8949adc-d54b-43cf-9f25-9aeaf4530107", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c4d615d-8215-47a5-a31c-83c182df4390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "882514ab-1f77-4d12-9220-d75ab9d47cdb", "db_currency_id": "4dc1c93c-96fb-443f-acd9-e664e63d4623", "db_language_id": "dc9cdc3e-bef5-4b74-bab7-3e9e405076b3", "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-08-11T10:28:45.2321343+00:00" }, "modified_dateutc": "2025-08-11T10:28:45.2321343+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "28623a06-dcbb-4f64-8175-147ab75e8e92", "date_reported_by_company": "2025-08-11T10:28:45.2321343+00:00", "id2": 36, "company_id": "f1139e1b-ec24-45d3-af8c-07e507951858", "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": "2a2f7322-3304-466b-ba4c-4c3988330dc9", "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-08-11T10:28:45.2321343+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.