Retrieves all the work orders
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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 |
Response Formats
application/json, text/json
{ "id": "69f058a8-82ab-498e-ac1e-79a649ecae1f", "_parent_id": "69128f58-a2b5-4cb1-9c81-24d45812b0aa", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "b9d46356-2eaf-49cb-92e4-d1683038380c", "project_reference_back_office": "sample string 5", "project": { "id": "038623d9-fd35-40c7-a0c1-eb007ed5235d", "_parent_id": "51e6aa2c-0687-4303-b8f2-f56c5816adaa", "root_parent_id": "f3009c14-4278-41a2-96d1-bc1fd3da1ea7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "24f2d667-28b9-4b97-8b29-9beae3111c42", "equipment_family_code": "sample string 6", "equipment_family": { "id": "af3c3088-b983-40f3-b12b-f29a2fa4eb21", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "76f2a8fa-63ca-41fb-896e-93f2707a04ad", "_parent_code": "sample string 6", "sales_organization_id": "bedc1782-4d40-4216-92b3-7a82edb4cfca", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+00:00" }, "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00" }, "equipment_model_id": "fedf3f7c-68e1-4ebc-805a-b26613f14093", "equipment_model_code": "sample string 8", "equipment_model": { "id": "d9cbc7ad-50b3-485a-ae59-993d27ebcc86", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "7f158c85-07b9-4b77-8708-841810d705db", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "d68dd406-7db2-4f44-b071-acf2f1b70f14", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "c910a6c8-e08a-4295-8917-8651e0fcd606", "sales_organization_code": "sample string 5", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+00:00" }, "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00" }, "equipment_family_id": "06e9d400-cf4e-4a2e-b3ae-9a39e4764c45", "equipment_family_code": "sample string 8", "equipment_family": { "id": "af3c3088-b983-40f3-b12b-f29a2fa4eb21", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "76f2a8fa-63ca-41fb-896e-93f2707a04ad", "_parent_code": "sample string 6", "sales_organization_id": "bedc1782-4d40-4216-92b3-7a82edb4cfca", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+00:00" }, "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00" }, "date_in_production_since": "2025-06-26T13:37:52.5767064+00:00", "date_out_of_production_since": "2025-06-26T13:37:52.5767064+00:00", "date_end_support": "2025-06-26T13:37:52.5767064+00:00", "sales_organization_id": "506c36ea-735f-4f46-bffa-54d99d9c23f2", "sales_organization_code": "sample string 13", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+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-26T13:37:52.5767064+00:00" }, "project_status_id": "bea94982-3969-47dc-823e-16e1329f3f57", "project_status_code": "sample string 10", "project_status": { "id": "ea015ef4-59ea-4610-9d49-836617627099", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "4a618b3f-1d8a-4b8a-86a7-94a7f2db1976", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00" }, "company_id": "c50ff51b-bdaf-415e-a619-c7f2b594a89d", "company_code": "sample string 12", "db_address_id": "c329499d-5da7-473d-989d-b91beb05d2a2", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "56a674cd-062a-4872-8b9b-061efd9bacc1", "contact_reference_back_office": "sample string 17", "owner_user_id": "89273053-604a-4df1-bcfb-836d977d1709", "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-26T13:37:52.5767064+00:00", "date_create": "2025-06-26T13:37:52.5767064+00:00", "date_update": "2025-06-26T13:37:52.5767064+00:00", "updated_by_user_id": "38b750bb-9bc4-4909-aeb7-7da2f69bd619", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-26T13:37:52.5767064+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-26T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-06-26T13:37:52.5767064+00:00", "date_last_job": "2025-06-26T13:37:52.5767064+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-26T13:37:52.5767064+00:00", "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00", "is_mobile_installation": true }, "job_type_id": "80bb1f00-d382-419b-a948-c3a0a9de9fcb", "job_type_code": "sample string 7", "job_type": { "id": "939332d7-24c9-4bfd-9ff8-c06d7f6f1100", "name": "sample string 2", "sales_organization_id": "1b015cc2-c03c-4c53-9726-9bbae8c8aca7", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00", "code": "sample string 7" }, "job_priority_id": "cfb0c8c9-70cc-4183-a75e-db1f949fe5c8", "job_priority_code": "sample string 9", "job_priority": { "id": "86c53fe9-63d6-4ad4-9c17-34d62f73d95b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "f0c11cff-b904-46d8-8864-6ce820459ee8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00" }, "job_status_id": "516556dd-9468-41ec-977c-debf06f04bd9", "job_status_code": "sample string 11", "db_address_id": "fbc9284d-9395-4d4a-ba56-55c04a512886", "contact_id": "ec648f7c-8b53-4bd8-93bd-01c1f8309ad3", "requested_by_company_id": "3f2a92e4-5075-40a3-972c-8917f5ed1a3f", "requested_by_contact_id": "3fd5b804-084c-4b92-a40c-8587c0367a27", "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-26T13:37:52.5767064+00:00", "due_date": "2025-06-26T13:37:52.5767064+00:00", "date_create": "2025-06-26T13:37:52.5767064+00:00", "date_update": "2025-06-26T13:37:52.5767064+00:00", "date_closed": "2025-06-26T13:37:52.5767064+00:00", "suggested_user_id": "614c9ac0-662e-4d88-a6fe-ac04c21af945", "suggested_user_code": "sample string 29", "suggested_user": { "id": "8ff747b1-9e17-4753-bdf6-3961800013cb", "db_language_id": "65ca428d-3d51-48ae-8b04-900b1af3612c", "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-26T13:37:52.5767064+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "bf059819-d322-4a01-b52b-41bdcc34eb6d", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "7e04adc9-f4d9-455a-81b0-5fd15768bd76", "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": "1742ec3f-1e1c-4196-b36f-5bd6982b5e29", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "873f50e0-e9eb-4deb-a9bb-b6ba28bf0f84" }, "suggested_date_start": "2025-06-26T13:37:52.5767064+00:00", "skill_id": "38c98a2c-dde9-4fd1-8c55-ac4316231b41", "skill_code": "sample string 32", "skill": { "id": "33942526-8403-4e24-8ef2-0f9a4a97ac87", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9f30271c-af38-45ae-b20e-b08bfd3c083b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d5344424-a5ba-46a7-9230-c874aede690c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "12df3b2d-98bd-4b04-9ed7-eaf97a061fa3", "db_currency_id": "065570f4-f346-4338-b0f4-1c757914f393", "db_language_id": "52b90949-a466-4a44-b2e6-f82923c5fad1", "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-26T13:37:52.5767064+00:00" }, "modified_dateutc": "2025-06-26T13:37:52.5767064+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "f8fbcd32-fe64-499d-91c3-f650a0d0a628", "date_reported_by_company": "2025-06-26T13:37:52.5767064+00:00", "id2": 36, "company_id": "2f0f1897-ae29-4bed-9a15-9257d651989f", "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": "330d70b7-232d-4bc0-8561-4105174b0167", "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-26T13:37:52.5767064+00:00" }