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": "341ee9f2-dedc-4a30-8bc9-32d08de4275b",
"_parent_id": "d98fd0f2-c306-4782-b814-2f56946077b2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db277002-a72d-48a2-bebc-e174e36d6331",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a1e8ae49-30e4-4496-9062-c447be6754da",
"_parent_id": "39ffa1c8-a250-46ff-9aea-a40b960605f4",
"root_parent_id": "34bd533c-cb2b-4cb4-963e-69a39bb8183c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "184fb4fe-0aa7-4543-ac4e-d465c50f4741",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9b37a93c-8cff-494d-94b7-30d90621ec4b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "adddcd8a-bea5-4d06-a502-c7bf2681786d",
"_parent_code": "sample string 6",
"sales_organization_id": "04f4c5cd-65ea-4e91-9a99-b30915d15ac0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+00:00"
},
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00"
},
"equipment_model_id": "a75c3c9e-84da-40a9-8d2c-d24abf392f72",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7cf0fc86-ae89-4963-83a9-91d9fcad84b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "060c6dd7-d7bd-4599-a166-0fcdd118e774",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "50afff2c-29c6-47ea-8f9a-6d9b5156be5d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c71cd4e2-5b9c-490f-9745-3bc09c2963df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+00:00"
},
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00"
},
"equipment_family_id": "abbcccef-dd00-46d2-9f12-3c1ff0a85ce7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9b37a93c-8cff-494d-94b7-30d90621ec4b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "adddcd8a-bea5-4d06-a502-c7bf2681786d",
"_parent_code": "sample string 6",
"sales_organization_id": "04f4c5cd-65ea-4e91-9a99-b30915d15ac0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+00:00"
},
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00"
},
"date_in_production_since": "2025-11-24T17:26:03.013402+00:00",
"date_out_of_production_since": "2025-11-24T17:26:03.013402+00:00",
"date_end_support": "2025-11-24T17:26:03.013402+00:00",
"sales_organization_id": "95ea5ea9-bb52-4ba3-8822-44768d8cfb99",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+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-11-24T17:26:03.013402+00:00"
},
"project_status_id": "c6ba272a-5161-4f85-b720-17ef664af467",
"project_status_code": "sample string 10",
"project_status": {
"id": "862bb0a8-36b6-4d68-a5d6-16e8df4460aa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5ee6e3d1-0885-4141-9510-b6d2b845b506",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00"
},
"company_id": "479e4431-af8c-484c-8bbf-5f650b2e552a",
"company_code": "sample string 12",
"db_address_id": "7be5029b-08e8-45f4-8fa8-343eef9aa15d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "833224e0-8ce8-4cb6-94e3-6e6e2cf7cb07",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "db959f34-f20f-4a2a-86cb-901dbf6e30b8",
"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-11-24T17:26:03.013402+00:00",
"date_create": "2025-11-24T17:26:03.013402+00:00",
"date_update": "2025-11-24T17:26:03.013402+00:00",
"updated_by_user_id": "be989cb5-2789-4225-82cc-43d15e532706",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-24T17:26:03.013402+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-11-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-24T17:26:03.013402+00:00",
"date_last_job": "2025-11-24T17:26:03.013402+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-24T17:26:03.013402+00:00",
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00",
"is_mobile_installation": true
},
"job_type_id": "4c9b5b6a-04e9-496d-8778-0ff1e239be10",
"job_type_code": "sample string 7",
"job_type": {
"id": "5cc41825-e0aa-49d6-9153-214f5381faf6",
"name": "sample string 2",
"sales_organization_id": "5456ab31-408f-4cea-961f-9ad0ae2aebdc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00",
"code": "sample string 7"
},
"job_priority_id": "8078784b-546b-49bb-9461-bda8bd50246e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dea2541c-549f-4e68-a2e6-deea4e0f6119",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d807c1e6-dbcf-4ea1-b1ad-0a6a9b19f6ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00"
},
"job_status_id": "2c71f651-59b9-493a-bdd3-fb3cba0bb89e",
"job_status_code": "sample string 11",
"db_address_id": "c6804003-03e7-4d05-94cd-60c58aa55f9c",
"contact_id": "fb47dbb8-e172-4314-bb50-d26149696e38",
"requested_by_company_id": "5fb669a1-2a9d-44af-af01-c4b58398c392",
"requested_by_contact_id": "98f5b558-0f40-4d4f-9019-55e6281b25c3",
"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-11-24T17:26:03.013402+00:00",
"due_date": "2025-11-24T17:26:03.013402+00:00",
"date_create": "2025-11-24T17:26:03.013402+00:00",
"date_update": "2025-11-24T17:26:03.013402+00:00",
"date_closed": "2025-11-24T17:26:03.013402+00:00",
"suggested_user_id": "2c15b96e-b6f1-4ab3-a918-48d825b23d7c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "caded4f2-8a04-48f2-bdcb-5dc39f177532",
"db_language_id": "a469978c-84b2-439b-accc-2f247ec35317",
"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-11-24T17:26:03.013402+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e1c10a28-685f-44de-8efe-b288b8e23bce",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "43002aa3-c322-41c0-affd-7daddf1753fb",
"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": "27dd2f20-0b3d-4601-84d2-36371f388b7f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "233f8ef4-1277-496e-9e30-efe8a0596c6f"
},
"suggested_date_start": "2025-11-24T17:26:03.013402+00:00",
"skill_id": "081c1df6-4f4b-4fad-9b28-cee56bba1f2f",
"skill_code": "sample string 32",
"skill": {
"id": "ab0a42c6-70ad-4c5c-ad58-54bf18a927b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "790c5750-2d97-4f33-8b61-bfd286fc8f02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "509066d9-0572-4323-9aa2-f70267c0ec98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8919e8f7-4d14-4446-a059-9372547645bd",
"db_currency_id": "e4ab8a44-dbfb-43ef-84a6-dd71bee13955",
"db_language_id": "ee104013-42c0-4003-b5d7-842b9867327e",
"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-11-24T17:26:03.013402+00:00"
},
"modified_dateutc": "2025-11-24T17:26:03.013402+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ae801222-7f8c-4558-b733-ec94dc0064fc",
"date_reported_by_company": "2025-11-24T17:26:03.013402+00:00",
"id2": 36,
"company_id": "c29e54aa-c9ba-4560-9661-80d96e6c6450",
"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": "eceae9f9-7894-42d8-9c53-5ca799514a4f",
"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-11-24T17:26:03.013402+00:00"
}