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": "98746efc-5431-4205-be72-1a0154beab7d", "_parent_id": "75830547-42f4-4d06-8275-e5c4a872f08c", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "65b6f236-c86b-458f-8567-bfb523823bcd", "project_reference_back_office": "sample string 5", "project": { "id": "87ac19f2-58f5-48fa-a30b-fb0c1fbc9075", "_parent_id": "92298f39-51d2-4c40-b255-73e3c8b9226c", "root_parent_id": "468fa09f-8bb2-407d-84c7-48b6f1225d5d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d52e297f-dae0-4622-9208-00fb5df82c59", "equipment_family_code": "sample string 6", "equipment_family": { "id": "640ce481-cd5d-4ac7-b228-dfbb9bbbc5d8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "0effaa21-fe1a-4d05-ba11-2926954ce997", "_parent_code": "sample string 6", "sales_organization_id": "7c1150d1-a18f-4e5b-bc71-2e3f7acba57a", "sales_organization_code": "sample string 8", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+00:00" }, "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00" }, "equipment_model_id": "c57b455e-3dfa-4950-b135-f0b4a7a6485f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "32ceb876-a193-43f3-9ca7-d59e37aae3d4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "af683455-35a2-4c5c-bf08-131b6c1cefce", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "083076dc-83f1-4ad1-98dd-3903dba6e03c", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "544181c1-37f3-4ca9-abd5-5a4c55ee6a2a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+00:00" }, "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00" }, "equipment_family_id": "9acca9a8-e9e7-46ec-b695-16a6dcfe4501", "equipment_family_code": "sample string 8", "equipment_family": { "id": "640ce481-cd5d-4ac7-b228-dfbb9bbbc5d8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "0effaa21-fe1a-4d05-ba11-2926954ce997", "_parent_code": "sample string 6", "sales_organization_id": "7c1150d1-a18f-4e5b-bc71-2e3f7acba57a", "sales_organization_code": "sample string 8", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+00:00" }, "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00" }, "date_in_production_since": "2025-06-21T11:44:29.7407781+00:00", "date_out_of_production_since": "2025-06-21T11:44:29.7407781+00:00", "date_end_support": "2025-06-21T11:44:29.7407781+00:00", "sales_organization_id": "fac69c23-279e-4e76-84d1-743f107106b8", "sales_organization_code": "sample string 13", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+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-06-21T11:44:29.7407781+00:00" }, "project_status_id": "b7d4f8b7-c490-4826-90f4-73eacfb7eed6", "project_status_code": "sample string 10", "project_status": { "id": "218eb1e2-d12e-4567-9419-03b0c78e19b1", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "498d5479-688d-4ac4-bb76-621be2ebbc25", "sales_organization_code": "sample string 6", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00" }, "company_id": "4d07a1f1-fce8-4855-bfbd-140011644a2e", "company_code": "sample string 12", "db_address_id": "d6245127-04dc-4e31-bfbf-a5d28579335f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "a183c9bc-1665-4cee-b45e-eb582490158c", "contact_reference_back_office": "sample string 17", "owner_user_id": "55f21e3e-dfd6-4731-b6c7-dca4efbfcdb9", "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-06-21T11:44:29.7407781+00:00", "date_create": "2025-06-21T11:44:29.7407781+00:00", "date_update": "2025-06-21T11:44:29.7407781+00:00", "updated_by_user_id": "2dde0700-edb2-4a76-9395-b778523934bd", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-21T11:44:29.7407781+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-06-21T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-21T11:44:29.7407781+00:00", "date_last_job": "2025-06-21T11:44:29.7407781+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-21T11:44:29.7407781+00:00", "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00", "is_mobile_installation": true }, "job_type_id": "fc687788-aa5f-4274-bb0b-f722a7abdc56", "job_type_code": "sample string 7", "job_type": { "id": "1322d182-d646-4ec0-b101-457bba22ad5a", "name": "sample string 2", "sales_organization_id": "59624c83-20e6-4091-9e33-8dd2c14dd317", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00", "code": "sample string 7" }, "job_priority_id": "d0d3464e-4c3b-47b8-af4c-3de9bffcc20f", "job_priority_code": "sample string 9", "job_priority": { "id": "e6430d18-7eb8-47f1-b076-254b95962b92", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "4a63d5d5-7913-44b8-bfc1-fabd031e8ffe", "sales_organization_code": "sample string 6", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00" }, "job_status_id": "6f523282-3973-4dc5-ba65-323b135c9e72", "job_status_code": "sample string 11", "db_address_id": "b9d8f9c3-af07-4ee7-8f23-178cd227c5ca", "contact_id": "0aa355a4-0541-4a91-915c-2375ea747177", "requested_by_company_id": "fb032440-79bf-44b8-83ab-737d315e750c", "requested_by_contact_id": "1785d1b0-3a6b-47e0-b185-b80d14480390", "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-06-21T11:44:29.7407781+00:00", "due_date": "2025-06-21T11:44:29.7407781+00:00", "date_create": "2025-06-21T11:44:29.7407781+00:00", "date_update": "2025-06-21T11:44:29.7407781+00:00", "date_closed": "2025-06-21T11:44:29.7407781+00:00", "suggested_user_id": "ced23375-d4aa-4bb9-b91f-467495993138", "suggested_user_code": "sample string 29", "suggested_user": { "id": "65d5a2cb-8054-4cef-965a-f39da6284c92", "db_language_id": "a4acabd1-5494-4ae2-8a96-3fe109f828cf", "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-06-21T11:44:29.7407781+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "291b52a1-290b-4a9d-9fc2-460b803ec042", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0925243e-0e7b-4ff1-9c67-545ee99026f6", "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": "9e2917fc-95ed-4c2d-8fc6-2c4fe277d8c1", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "3a8108bf-ceff-4e58-874e-cf896a82c9c7" }, "suggested_date_start": "2025-06-21T11:44:29.7407781+00:00", "skill_id": "c6ae6f51-8e5d-4f2f-94b2-42329bfc344c", "skill_code": "sample string 32", "skill": { "id": "aa5dfde2-3095-46cb-98e3-3e716b467fcf", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "fad066c7-1b43-4783-84c0-fc0378e8c393", "sales_organization_code": "sample string 6", "sales_organization": { "id": "fdba965d-cd28-4ad2-86ac-bd1a72836b70", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "724219fd-f682-478b-9930-a0fee93773cf", "db_currency_id": "ce061a50-a35c-406b-83e7-b7c06b9cbd18", "db_language_id": "4992f011-4697-47b8-9411-ce5bce895253", "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-06-21T11:44:29.7407781+00:00" }, "modified_dateutc": "2025-06-21T11:44:29.7407781+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "40944d0b-dde8-4d75-abbc-bb1d75f9d1c1", "date_reported_by_company": "2025-06-21T11:44:29.7407781+00:00", "id2": 36, "company_id": "dc4a6cac-c1da-42df-aa12-552872ffc7ab", "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": "004f7193-2cd2-4407-9d77-4245d47d2851", "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-06-21T11:44:29.7407781+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.