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": "ba8bf579-2666-4ade-931b-8e1899fcc625",
"_parent_id": "a5f71c91-2d09-4fac-b34a-31cfbe777ad6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "100c9d4b-96a3-4f5e-95e0-f336424854b3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5420cef1-8d8b-49c6-ab07-c1225cc0c008",
"_parent_id": "d53545e4-1609-4e2d-a4c7-27c04da79da4",
"root_parent_id": "5b59bf23-73ee-47e0-a008-19f2587d1cc9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e9f60e23-ad8d-49e4-b700-050034608d8d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fe5a1129-f2b9-4f5a-9402-b6f456643833",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3890d6a-e324-4fb2-be37-d8ed083e3774",
"_parent_code": "sample string 6",
"sales_organization_id": "f17454f8-a342-4758-9aa5-171de711e631",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+00:00"
},
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00"
},
"equipment_model_id": "af74a34d-c74f-4f8c-b47d-4469e0cb12f1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b2bd557c-5cf0-44cb-9e21-86d745ea87dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "303e77cb-8fea-45c4-8e88-4901cbf49fa9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5e6b00b5-451f-4ce5-b87f-b275d8bd49af",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "84609904-ae5c-4e1c-b752-231bd1097a4f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+00:00"
},
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00"
},
"equipment_family_id": "4345adec-2aac-4857-a39d-b7651f8f59ad",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fe5a1129-f2b9-4f5a-9402-b6f456643833",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3890d6a-e324-4fb2-be37-d8ed083e3774",
"_parent_code": "sample string 6",
"sales_organization_id": "f17454f8-a342-4758-9aa5-171de711e631",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+00:00"
},
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00"
},
"date_in_production_since": "2025-09-15T21:48:47.326493+00:00",
"date_out_of_production_since": "2025-09-15T21:48:47.326493+00:00",
"date_end_support": "2025-09-15T21:48:47.326493+00:00",
"sales_organization_id": "58bc8fb5-d519-4ab8-b97c-7adbb509fb64",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+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-09-15T21:48:47.326493+00:00"
},
"project_status_id": "809b6d1d-60d6-4970-b9ba-134212cc3be9",
"project_status_code": "sample string 10",
"project_status": {
"id": "9e928cab-f771-47f0-b7f9-afcacb2663e9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "41f9c562-97e5-4b10-a9d4-7bff944629b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00"
},
"company_id": "218e7578-88b4-4d74-b379-94e6f2de8800",
"company_code": "sample string 12",
"db_address_id": "ee8facc1-60d9-4371-abd4-327a5722d4ee",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "24339e72-a3c1-47ff-8143-e05025ce1e4d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0ee3ede7-3c6e-4582-9729-19b4cfad2d94",
"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-09-15T21:48:47.326493+00:00",
"date_create": "2025-09-15T21:48:47.326493+00:00",
"date_update": "2025-09-15T21:48:47.326493+00:00",
"updated_by_user_id": "5424f69e-d085-4415-ae99-364ae95002ea",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-15T21:48:47.326493+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-09-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-15T21:48:47.326493+00:00",
"date_last_job": "2025-09-15T21:48:47.326493+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-15T21:48:47.326493+00:00",
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00",
"is_mobile_installation": true
},
"job_type_id": "0e45225f-5dcb-4479-8493-6f48a30bad61",
"job_type_code": "sample string 7",
"job_type": {
"id": "229b07a1-829e-4f96-ab02-1db441e8217d",
"name": "sample string 2",
"sales_organization_id": "ead55314-76ca-4315-ab20-5228f28811e4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00",
"code": "sample string 7"
},
"job_priority_id": "d5e9f629-a33d-4e8f-9848-f6fbb2c120c0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "799870df-cac6-4229-b105-7225426de0b7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c3dc50b1-4162-4df5-a70b-51d3406506a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00"
},
"job_status_id": "55643299-22b9-4656-8622-43b107092e60",
"job_status_code": "sample string 11",
"db_address_id": "d20604ac-119c-4005-bb65-1b280ca46a77",
"contact_id": "c5bac06e-5197-4994-bdce-112cb8ee062b",
"requested_by_company_id": "f6793991-47cb-416e-b079-5076b16b41e0",
"requested_by_contact_id": "6fcbc11f-315e-4cc6-8fa0-1321dceb5d04",
"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-09-15T21:48:47.326493+00:00",
"due_date": "2025-09-15T21:48:47.326493+00:00",
"date_create": "2025-09-15T21:48:47.326493+00:00",
"date_update": "2025-09-15T21:48:47.326493+00:00",
"date_closed": "2025-09-15T21:48:47.326493+00:00",
"suggested_user_id": "1d1dbfa0-414a-43c0-948d-f9bb865ebea4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fd8aa8fd-aa01-4ef1-8567-b1458c1d15a9",
"db_language_id": "86f5be6e-9394-4024-855a-dd5ab9c9a5e2",
"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-09-15T21:48:47.326493+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8fefb9e7-9720-43e2-a403-2a6c92e1aaa4",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8f189036-5327-4b35-8420-21c59086f152",
"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": "0e1fcd0d-41d8-4962-9dd8-fada0eae69d1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "26d395c2-3f35-44be-af9f-8830c42653f0"
},
"suggested_date_start": "2025-09-15T21:48:47.326493+00:00",
"skill_id": "9ab873c7-6f26-4b72-a81f-e0d6d2ced4e1",
"skill_code": "sample string 32",
"skill": {
"id": "68a83c50-2012-4fba-b888-1e4fd4233acf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0b7d4630-efa3-4d3b-a649-f69d84679425",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "da9804fd-ef9d-4349-a44f-d31dbfffe713",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6fa04d-46ee-40fc-9080-abf79be104c3",
"db_currency_id": "a9aad4ac-acc3-45b5-9452-ffb538e94af7",
"db_language_id": "28359d46-f890-431d-9935-3320a421189d",
"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-09-15T21:48:47.326493+00:00"
},
"modified_dateutc": "2025-09-15T21:48:47.326493+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0b8b8a8a-9803-4565-a419-88ae24af0826",
"date_reported_by_company": "2025-09-15T21:48:47.326493+00:00",
"id2": 36,
"company_id": "de9e5c75-47b6-4b83-8419-28df524a2a6c",
"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": "873f6c9e-43d5-44c8-bf30-c201798a75ef",
"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-09-15T21:48:47.326493+00:00"
}