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": "a3584dba-7fa1-49b6-9fd0-798827b0543c", "_parent_id": "21d1353b-8065-4bd6-9ddf-5a74074926f9", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "a3721b39-e238-4663-ae4b-492ea965490b", "project_reference_back_office": "sample string 5", "project": { "id": "4ab37a5c-ed89-4f6a-9227-4cbc833cbc13", "_parent_id": "68ee3a61-1ec8-4e6c-8338-0fdd65f3ae60", "root_parent_id": "a0b7200e-0726-4c31-9e82-6aa8b49f9367", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "820158ff-225c-4793-934f-f17339de1092", "equipment_family_code": "sample string 6", "equipment_family": { "id": "3b5e3d69-7648-4440-99ef-30c015f17bfa", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "4a689f2e-72cd-46b7-8a84-939a60c567ff", "_parent_code": "sample string 6", "sales_organization_id": "7f97a6b4-650c-4d54-8952-290443d7465b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+00:00" }, "modified_dateutc": "2025-10-09T15:29:40.812283+00:00" }, "equipment_model_id": "0f65c2f9-e14e-45db-bb66-c0ebb02b3541", "equipment_model_code": "sample string 8", "equipment_model": { "id": "241371ae-79f8-4af7-81c0-1020c1d470f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "e1125c07-fe74-4328-9f2e-c91bc5f3fbfd", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "cbb25637-5c63-4046-829d-12e5695646f7", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "22b8901d-f235-434c-a97b-6be808a7f56a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+00:00" }, "modified_dateutc": "2025-10-09T15:29:40.812283+00:00" }, "equipment_family_id": "7b17ca70-6cca-4c87-aed0-f641eb6806ed", "equipment_family_code": "sample string 8", "equipment_family": { "id": "3b5e3d69-7648-4440-99ef-30c015f17bfa", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "4a689f2e-72cd-46b7-8a84-939a60c567ff", "_parent_code": "sample string 6", "sales_organization_id": "7f97a6b4-650c-4d54-8952-290443d7465b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+00:00" }, "modified_dateutc": "2025-10-09T15:29:40.812283+00:00" }, "date_in_production_since": "2025-10-09T15:29:40.812283+00:00", "date_out_of_production_since": "2025-10-09T15:29:40.812283+00:00", "date_end_support": "2025-10-09T15:29:40.812283+00:00", "sales_organization_id": "5479e16b-b29e-4855-b3d4-cd6ee9ab544a", "sales_organization_code": "sample string 13", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+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-10-09T15:29:40.8279032+00:00" }, "project_status_id": "1f128f4c-4a9a-43f5-a38b-cc9322f91bf0", "project_status_code": "sample string 10", "project_status": { "id": "551e826f-eb29-4ce1-bea6-bffa199d547e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "5a0ee03f-da69-43dc-8440-c3d4b474a9b5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-09T15:29:40.8279032+00:00" }, "company_id": "9405fdfd-22bd-4b39-ad5f-59a828112b04", "company_code": "sample string 12", "db_address_id": "504a4b91-5ff0-4c53-8257-142d9a3de740", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "3fad3d40-e035-4f97-9cb5-e4dad81bc85b", "contact_reference_back_office": "sample string 17", "owner_user_id": "29e40719-f23a-466a-8268-0c7d99318cf0", "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-10-09T15:29:40.984193+00:00", "date_create": "2025-10-09T15:29:40.984193+00:00", "date_update": "2025-10-09T15:29:40.984193+00:00", "updated_by_user_id": "6f6ce94e-e1e8-4077-8106-a6910aeaaf32", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-09T15:29:40.984193+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-10-09T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-09T15:29:40.984193+00:00", "date_last_job": "2025-10-09T15:29:40.984193+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-09T15:29:40.984193+00:00", "modified_dateutc": "2025-10-09T15:29:40.984193+00:00", "is_mobile_installation": true }, "job_type_id": "d3f93b06-45ec-416f-9ef9-29b7e9508ff2", "job_type_code": "sample string 7", "job_type": { "id": "bcd54689-efe1-4167-af76-2b2f147919a7", "name": "sample string 2", "sales_organization_id": "302e5d1e-e6a5-41fb-87a4-3daa22acd074", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-09T15:29:40.984193+00:00", "code": "sample string 7" }, "job_priority_id": "36681b18-6259-493a-ab66-8fd4cd20865d", "job_priority_code": "sample string 9", "job_priority": { "id": "b713dd75-1673-43a4-b406-f0926757e693", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "8b8e16e8-6451-48a4-9eb4-7ca62f202f58", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-09T15:29:40.984193+00:00" }, "job_status_id": "33235153-0b36-49fc-869f-0fe3c66f6639", "job_status_code": "sample string 11", "db_address_id": "59ccee33-00bb-4811-9a74-e820e3c89c5e", "contact_id": "329061ca-b3f1-455c-9ba1-6005a7aafccd", "requested_by_company_id": "c93ca48c-856a-4bf0-89ff-d22ce01698fa", "requested_by_contact_id": "494ac064-2ca9-4452-b5e1-91f24ad8b97e", "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-10-09T15:29:40.984193+00:00", "due_date": "2025-10-09T15:29:40.984193+00:00", "date_create": "2025-10-09T15:29:40.984193+00:00", "date_update": "2025-10-09T15:29:40.984193+00:00", "date_closed": "2025-10-09T15:29:40.984193+00:00", "suggested_user_id": "c1a36f33-7e6c-4dc2-9267-5f6dd312fdf8", "suggested_user_code": "sample string 29", "suggested_user": { "id": "c8d0b694-b373-48d2-8214-b5aaf744295d", "db_language_id": "0b62806b-bdc6-42c9-bb93-eea32eb07f63", "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-10-09T15:29:40.984193+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "9cfc783b-dfb5-4115-960e-eed15f5b3969", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "6f174e02-3920-4dad-9529-829820abeb45", "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": "565ed39d-c161-4965-959d-4acc374d5c86", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-09T15:29:40.984193+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "d6850bd4-56a5-450c-81fd-5311a1c2b525" }, "suggested_date_start": "2025-10-09T15:29:40.9997783+00:00", "skill_id": "72810b24-583a-4c29-856d-7aba59756f00", "skill_code": "sample string 32", "skill": { "id": "e3d74348-ff01-497b-83d6-4bb623065187", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "221f2661-0823-4245-8831-a3dbfc99f063", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b0603fbb-c471-48d9-867d-04f76fdc525d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94c3fe65-1d26-448b-8e6f-28605d31f85e", "db_currency_id": "6c2d2a61-32ba-40db-a65c-7e14b5b705c0", "db_language_id": "0f5290c7-b24f-4415-89a8-59b2362d797e", "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-10-09T15:29:40.812283+00:00" }, "modified_dateutc": "2025-10-09T15:29:40.9997783+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "12db39ef-b8f7-43ba-9d88-95a03a6a5b6a", "date_reported_by_company": "2025-10-09T15:29:40.9997783+00:00", "id2": 36, "company_id": "fa2d2083-1379-4043-88d7-34c3a861d6e7", "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": "6999eb41-01a6-4717-b92f-0b183f7abd31", "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-10-09T15:29:40.9997783+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.