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": "e59c19c9-08dd-4862-9f97-1cbd58b6d50f",
"_parent_id": "ed580f6e-f376-44da-a462-c070af1cefa5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9a8380a6-293f-4908-8b4d-032b3b5ce35e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9accb36f-6a95-41c3-a794-077029d7b84f",
"_parent_id": "a91320d2-4f31-4298-9193-4efb6ec3c3de",
"root_parent_id": "0b81e4dc-8380-4b35-be58-a837fe496750",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e58e140b-ef04-411d-8bca-a2f89784e927",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8d5a9d95-2ab7-4418-b265-1698b591d4d4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8454d1d5-8a73-456a-a703-6b99cc361fea",
"_parent_code": "sample string 6",
"sales_organization_id": "658169fe-2d86-4478-af4c-c79bbc155a92",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+00:00"
},
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00"
},
"equipment_model_id": "bed2bbe2-2006-44c1-a843-56c196d0167e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "724230f4-de5a-4712-ab3e-592ffe116249",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b5840b47-5ba8-452f-87c2-d600bc679615",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "88b9d492-8bd2-45d7-873f-708cfc9c08a4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "211a66f2-7eed-4e8a-bc4e-7d46f1e9c88f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+00:00"
},
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00"
},
"equipment_family_id": "c7d57219-4b69-4273-9bf8-01969a484619",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8d5a9d95-2ab7-4418-b265-1698b591d4d4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8454d1d5-8a73-456a-a703-6b99cc361fea",
"_parent_code": "sample string 6",
"sales_organization_id": "658169fe-2d86-4478-af4c-c79bbc155a92",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+00:00"
},
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00"
},
"date_in_production_since": "2025-11-12T07:55:21.7430918+00:00",
"date_out_of_production_since": "2025-11-12T07:55:21.7430918+00:00",
"date_end_support": "2025-11-12T07:55:21.7430918+00:00",
"sales_organization_id": "8663dc12-a33d-4524-bffe-295c1140e3ac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+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-12T07:55:21.7430918+00:00"
},
"project_status_id": "6c10bfcc-61aa-4290-8db2-df522032bacb",
"project_status_code": "sample string 10",
"project_status": {
"id": "b0a2e679-abf1-4c02-9e81-125af41ebc89",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cc8cbb0b-35c1-4669-ae49-890f57d9be30",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00"
},
"company_id": "371ac43e-5ffe-419c-8dad-af3b4397651a",
"company_code": "sample string 12",
"db_address_id": "98d51b44-1938-4286-9942-ce358bd85964",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "01e03ab4-9ad1-4f72-b589-033b15c6bd3e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "49ec4396-96d5-4f50-9fc4-8aa7fba3e031",
"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-12T07:55:21.7430918+00:00",
"date_create": "2025-11-12T07:55:21.7430918+00:00",
"date_update": "2025-11-12T07:55:21.7430918+00:00",
"updated_by_user_id": "bb36790b-6a53-43e0-9c0d-f9af36b81239",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-12T07:55:21.7430918+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-12T07:55:21.7430918+00:00",
"date_last_job": "2025-11-12T07:55:21.7430918+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-12T07:55:21.7430918+00:00",
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00",
"is_mobile_installation": true
},
"job_type_id": "0e85ba69-1347-45a4-b941-9b32d7f32ae2",
"job_type_code": "sample string 7",
"job_type": {
"id": "f5ab4828-61fa-458a-b45c-e6b13c070220",
"name": "sample string 2",
"sales_organization_id": "00666877-23b3-4917-9463-26bf07aa0690",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00",
"code": "sample string 7"
},
"job_priority_id": "cd537422-3837-453b-998c-031810966682",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "20079e34-75b4-42fa-a572-f80275da7610",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9283c391-3340-4c27-b3e1-c14e8283df88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00"
},
"job_status_id": "27a83ac3-07f2-4707-a777-1f71fe759806",
"job_status_code": "sample string 11",
"db_address_id": "5a8640bf-3c51-4b79-938c-0ff25b950a8c",
"contact_id": "fa1de53c-424b-45e1-a752-a8630c55774e",
"requested_by_company_id": "8c2a4abc-8cee-4559-abd4-06543f87688b",
"requested_by_contact_id": "deb72ae9-4173-496d-a61e-afd197a08378",
"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-12T07:55:21.7430918+00:00",
"due_date": "2025-11-12T07:55:21.7430918+00:00",
"date_create": "2025-11-12T07:55:21.7430918+00:00",
"date_update": "2025-11-12T07:55:21.7430918+00:00",
"date_closed": "2025-11-12T07:55:21.7430918+00:00",
"suggested_user_id": "88fd0582-6638-4da2-9577-de6e840b63a3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d4ccb085-2df0-4f4f-9f52-53f89a705982",
"db_language_id": "56a2fcaf-96b5-47c7-ba7f-1b651f5c5d5d",
"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-12T07:55:21.7430918+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6e492b52-4c22-4083-a07f-1a0e93abe4a3",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "75ef3d50-de00-4f2b-a9dc-01029243e3a1",
"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": "9afd7eb2-bfa2-4de6-a21f-d44e27ec2014",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a923f832-bdcb-41eb-ab4e-cc1ea639fdb5"
},
"suggested_date_start": "2025-11-12T07:55:21.7430918+00:00",
"skill_id": "20430416-dce4-404b-aff0-69b90a2fc971",
"skill_code": "sample string 32",
"skill": {
"id": "f3da9962-19e9-4209-af7e-148ccc7e5a24",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bc718b8a-71d8-4c86-98cd-f44fb1cc91bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5872eff4-3ce5-412f-b261-5e93b0e6ae9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64c20bc4-497c-47f8-9361-82c826efc976",
"db_currency_id": "db5d0f03-7401-4425-b2cf-71aaf0095645",
"db_language_id": "4542862f-ada6-4212-9763-7f2969173f71",
"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-12T07:55:21.7430918+00:00"
},
"modified_dateutc": "2025-11-12T07:55:21.7430918+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "89399a47-87b2-4972-ab1a-d7aa563096ca",
"date_reported_by_company": "2025-11-12T07:55:21.7430918+00:00",
"id2": 36,
"company_id": "7a22a7de-61fb-486c-97cd-a3e7d5a244b4",
"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": "8d3c2ac0-ad40-4ba2-b23d-a3c710926d90",
"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-12T07:55:21.7430918+00:00"
}