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": "a2519381-11f7-48d3-aa2f-fdb6fa7f71b9", "_parent_id": "d8581c87-4058-4b90-86a9-9dfd787e844e", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "7a24ddf1-c917-4675-94d2-e4fc558eae30", "project_reference_back_office": "sample string 5", "project": { "id": "d4b11df5-89b5-412c-8746-a62b29d87922", "_parent_id": "83249a9f-f0de-41bf-8c95-ebc5adb2fce3", "root_parent_id": "6f1a00a4-949b-492d-bfe6-c85c6941e4d7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "11c37528-33b2-4f0d-9b32-96e96ce41d9e", "equipment_family_code": "sample string 6", "equipment_family": { "id": "4cd4ba35-a494-4be9-bf74-1d85d329261d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6865e743-b08b-4d93-8062-42e8983a98c8", "_parent_code": "sample string 6", "sales_organization_id": "364cbe4e-d80e-4e93-8cfa-2ca21891766e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+00:00" }, "modified_dateutc": "2025-10-14T02:51:14.0920572+00:00" }, "equipment_model_id": "33d468e8-5b90-46db-b756-40a3d9e98b13", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f1df73e5-dc0d-4473-a2fe-60909ad80673", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "eb7f4b6c-1c39-4326-8ad6-b819ee2cb4a2", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "946c7729-c57b-44bd-9ed1-fc855e81c82b", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "2b5357ad-2b3a-4a50-9c69-4958e7a0410f", "sales_organization_code": "sample string 5", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+00:00" }, "modified_dateutc": "2025-10-14T02:51:14.0920572+00:00" }, "equipment_family_id": "40e2f349-0894-477d-9d29-175c9242ff1d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "4cd4ba35-a494-4be9-bf74-1d85d329261d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6865e743-b08b-4d93-8062-42e8983a98c8", "_parent_code": "sample string 6", "sales_organization_id": "364cbe4e-d80e-4e93-8cfa-2ca21891766e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+00:00" }, "modified_dateutc": "2025-10-14T02:51:14.0920572+00:00" }, "date_in_production_since": "2025-10-14T02:51:14.0920572+00:00", "date_out_of_production_since": "2025-10-14T02:51:14.0920572+00:00", "date_end_support": "2025-10-14T02:51:14.0920572+00:00", "sales_organization_id": "2c57e5d7-fc48-4ad3-a3a6-781939799fe3", "sales_organization_code": "sample string 13", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+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-14T02:51:14.0920572+00:00" }, "project_status_id": "3fe5a170-ce72-4d33-87cb-a4e96d2e5757", "project_status_code": "sample string 10", "project_status": { "id": "c9d999b2-af1d-4fda-96df-469dd4c47bb0", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "7aa93ab0-6503-421e-acd0-d6ece2346d51", "sales_organization_code": "sample string 6", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-14T02:51:14.0920572+00:00" }, "company_id": "30433ce7-28e9-44f2-9514-18cca3fea412", "company_code": "sample string 12", "db_address_id": "f33f3f81-cf7f-406e-9df1-7e5ebf5bb022", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "f4805766-e415-428c-b15f-8adb1b117a1f", "contact_reference_back_office": "sample string 17", "owner_user_id": "72067794-e8b9-477b-96c7-41e5a072ecea", "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-14T02:51:14.0920572+00:00", "date_create": "2025-10-14T02:51:14.0920572+00:00", "date_update": "2025-10-14T02:51:14.0920572+00:00", "updated_by_user_id": "ff4de631-8a83-46db-a350-5a33dd2bd320", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-14T02:51:14.0920572+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-14T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-14T02:51:14.1233017+00:00", "date_last_job": "2025-10-14T02:51:14.1233017+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-14T02:51:14.1233017+00:00", "modified_dateutc": "2025-10-14T02:51:14.1233017+00:00", "is_mobile_installation": true }, "job_type_id": "5d9bc422-62af-4f31-afcf-e54489b0dc62", "job_type_code": "sample string 7", "job_type": { "id": "fc75dcad-5722-4146-9ae2-7627059aaecf", "name": "sample string 2", "sales_organization_id": "25030625-1685-4155-b754-d6362bdbb959", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-14T02:51:14.1233017+00:00", "code": "sample string 7" }, "job_priority_id": "ca27045f-05d7-460b-8c7e-d04704a17569", "job_priority_code": "sample string 9", "job_priority": { "id": "dcd575aa-b9eb-4aa1-89d0-425a75fedafd", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "780911d0-2344-437a-bb70-d1031d2c0565", "sales_organization_code": "sample string 6", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-14T02:51:14.1233017+00:00" }, "job_status_id": "1ebe0a12-999b-4d81-8140-f64889ccc432", "job_status_code": "sample string 11", "db_address_id": "6e193141-c8d4-4ebf-84e5-771a3b58efa6", "contact_id": "947f03d3-723f-4567-b656-ec3b6cdb3c99", "requested_by_company_id": "9d2b9fd4-5f73-440f-84ef-07516ab404e5", "requested_by_contact_id": "0a9a441a-1303-427e-9f9f-c0a27b7ee05a", "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-14T02:51:14.1233017+00:00", "due_date": "2025-10-14T02:51:14.1233017+00:00", "date_create": "2025-10-14T02:51:14.1233017+00:00", "date_update": "2025-10-14T02:51:14.1233017+00:00", "date_closed": "2025-10-14T02:51:14.1233017+00:00", "suggested_user_id": "bc638fd2-8c60-425f-8755-99c98310126e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "16ed29ee-c55c-4bc2-857b-b7bc3899f360", "db_language_id": "dbc76542-8f4b-449b-b49f-7248ed078af0", "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-14T02:51:14.1233017+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2315ad76-eb0e-4162-a772-3c05c86639a1", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "8fe7b4e7-c6a2-4d75-8a17-56d9f7f525b5", "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": "164752db-e582-45cb-a16a-bd6b67711785", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-14T02:51:14.1233017+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "9486d043-b5e9-4575-98b4-17e1cd11f46d" }, "suggested_date_start": "2025-10-14T02:51:14.1233017+00:00", "skill_id": "93343755-fded-4d21-85b6-a49d94558fa9", "skill_code": "sample string 32", "skill": { "id": "0aae6235-f5b8-42d4-93ad-61e3633874af", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "df472201-5eed-4472-b9fa-c72b2db8072d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "483036c2-7e80-49d0-9612-bd590d9700c3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b62f9b59-0a13-49f0-b651-58fd19281642", "db_currency_id": "bb8a221e-bdd5-4598-9642-8770d03212a4", "db_language_id": "01bbf6b6-bc6a-4e2d-8a6a-16a03872b0ee", "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-14T02:51:14.0920572+00:00" }, "modified_dateutc": "2025-10-14T02:51:14.1233017+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "346deb0b-0857-4303-b322-7448e66be031", "date_reported_by_company": "2025-10-14T02:51:14.1233017+00:00", "id2": 36, "company_id": "2eb3438a-45e1-4cd6-8fbe-436de85c1f51", "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": "5d0f7773-5b84-430e-887b-ebd40575af46", "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-14T02:51:14.1233017+00:00" }