Retrieves all the work orders
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
jobs| Name | 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": "c4724560-42f6-42a7-8b67-0656dc8d7278",
"_parent_id": "2fe45c1b-b940-4ae8-bf1d-0d22000df989",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dca0b47e-cba8-4be0-9636-4832930cdf5d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e46d8611-d424-41fa-a011-4cea20eca31b",
"_parent_id": "220b6985-7019-4683-b608-1d94cc8b0cbb",
"root_parent_id": "a3f9e296-edae-4c83-b93b-789f72d9967c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0ecfd322-6099-42ac-9330-d860bc445c59",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9611a932-a38e-4726-880f-6561c500cef4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8cec73a-5737-4a7e-920e-b670e7d9ac58",
"_parent_code": "sample string 6",
"sales_organization_id": "c4521713-e516-4db0-be21-f5112798dc91",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+00:00"
},
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00"
},
"equipment_model_id": "a0db13ff-1aa2-4267-a0f0-bf2b07c00037",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3b9008da-4822-4642-9763-c67912fc8e49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7e3a0932-e59f-497d-acf1-7ae3a7ee42bc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "000ba5a0-3756-4830-8522-511434916040",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e5471d8a-3793-40f6-b40c-2b0531ecd412",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+00:00"
},
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00"
},
"equipment_family_id": "f702b3c7-c732-4f30-bcfe-17e834451b62",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9611a932-a38e-4726-880f-6561c500cef4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8cec73a-5737-4a7e-920e-b670e7d9ac58",
"_parent_code": "sample string 6",
"sales_organization_id": "c4521713-e516-4db0-be21-f5112798dc91",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+00:00"
},
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00"
},
"date_in_production_since": "2026-01-29T07:13:40.7184075+00:00",
"date_out_of_production_since": "2026-01-29T07:13:40.7184075+00:00",
"date_end_support": "2026-01-29T07:13:40.7184075+00:00",
"sales_organization_id": "d638efda-58f0-46d0-b1f8-24c52aeef018",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+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": "2026-01-29T07:13:40.7184075+00:00"
},
"project_status_id": "fe3cdded-8c7c-435e-8832-a3e21a6b77ad",
"project_status_code": "sample string 10",
"project_status": {
"id": "47e2676e-de68-44e1-b4fa-095008aaf5df",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "72735ce5-34c5-482c-8d37-901e1cfce725",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00"
},
"company_id": "408378b3-0061-4742-9d98-dbdfa338ce30",
"company_code": "sample string 12",
"db_address_id": "373b01c0-360d-4762-88e4-f261bbad59d5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4b05be48-a12d-4354-91fd-f665049e3b51",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b84cee6e-4b12-4ba5-89cf-11b47b5d0ca8",
"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": "2026-01-29T07:13:40.7184075+00:00",
"date_create": "2026-01-29T07:13:40.7184075+00:00",
"date_update": "2026-01-29T07:13:40.7184075+00:00",
"updated_by_user_id": "3a76beea-ef1d-4784-8d0f-0eb7577693f2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T07:13:40.7184075+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": "2026-01-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T07:13:40.7184075+00:00",
"date_last_job": "2026-01-29T07:13:40.7184075+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T07:13:40.7184075+00:00",
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00",
"is_mobile_installation": true
},
"job_type_id": "44454597-a252-4ad3-97ba-b28b6ec046fd",
"job_type_code": "sample string 7",
"job_type": {
"id": "e8734c04-0c50-4e8a-bf56-d6efd6f7c604",
"name": "sample string 2",
"sales_organization_id": "17803180-9830-4f54-9d19-75576464377a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00",
"code": "sample string 7"
},
"job_priority_id": "746d31df-f7cb-42eb-bbe1-dc05f7d39429",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "56c43a69-4618-41b7-9afc-7ee7c1118e57",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b31df33b-9d1f-4157-9ffe-debaf604bf1c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00"
},
"job_status_id": "86da890e-b59b-4759-a3c0-c3e65f768559",
"job_status_code": "sample string 11",
"db_address_id": "9d67ffa1-1f78-4311-ae91-11336673bc02",
"contact_id": "5f7ebebf-884b-42fa-ba3b-aed2a3a6eb20",
"requested_by_company_id": "bf251b1d-fec5-46bc-87e8-57a828bada8b",
"requested_by_contact_id": "74dafde2-1f4d-4474-9301-4bebaa464f52",
"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": "2026-01-29T07:13:40.7184075+00:00",
"due_date": "2026-01-29T07:13:40.7184075+00:00",
"date_create": "2026-01-29T07:13:40.7184075+00:00",
"date_update": "2026-01-29T07:13:40.7184075+00:00",
"date_closed": "2026-01-29T07:13:40.7184075+00:00",
"suggested_user_id": "ca3abcce-aa33-4b8a-8ad7-ffa8a9a760ea",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ad0871b6-8bc1-4b4f-a41d-6c4664143df9",
"db_language_id": "b0cc443a-13a1-4f3e-8a4a-363f2c50331f",
"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": "2026-01-29T07:13:40.7184075+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aae7dada-db29-4068-b028-de423b7f738f",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "872c1ea9-b4d1-48bc-ac0f-a07b49a9ab05",
"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": "92b8ec06-23f6-4705-abce-abafb292e96c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "12a1bd9f-d3b5-4115-8d4c-8ba8f7b52363"
},
"suggested_date_start": "2026-01-29T07:13:40.7184075+00:00",
"skill_id": "d5fe3129-0ecb-4326-abee-f24476346bb5",
"skill_code": "sample string 32",
"skill": {
"id": "134f2402-9190-4ee4-acc0-93ca1e492fe9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d0781c42-9911-4c5c-a584-a715b5b327f3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2da32476-e4e6-4442-9c51-96e8bfc18221",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42510661-36c3-4845-a0c7-a8422e16282c",
"db_currency_id": "75d0552c-ade7-400a-8326-f6c566edec26",
"db_language_id": "4cfa30e2-213a-4f9b-9982-5705fd43a374",
"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": "2026-01-29T07:13:40.7184075+00:00"
},
"modified_dateutc": "2026-01-29T07:13:40.7184075+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "be93cf0c-a4f7-447c-8c6f-097e1a5069e8",
"date_reported_by_company": "2026-01-29T07:13:40.7184075+00:00",
"id2": 36,
"company_id": "03cf401d-cadd-4c80-a3e3-a40bcfc8fb82",
"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": "832b6cf1-ca10-4f61-8aa9-80247339298c",
"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": "2026-01-29T07:13:40.7184075+00:00"
}