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": "0cfe654a-3129-4654-90df-ca4a308f77da", "_parent_id": "ca9a6c7f-a452-4cc9-8738-f2b6cbf01f53", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "9ccabfaa-565a-4062-9b21-1c58e09e85cb", "project_reference_back_office": "sample string 5", "project": { "id": "e2a3ad85-d9fb-4a3e-adb1-9d9c93880293", "_parent_id": "f0419644-d5d3-46f5-957c-7925422579b0", "root_parent_id": "3bb8c630-f343-40d1-8082-1975350cb6d6", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "915bb5ec-9a8c-4109-b3d6-b6852f85a226", "equipment_family_code": "sample string 6", "equipment_family": { "id": "7e291c29-ba53-4d3a-bf9c-da876caf9d8f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "74b36514-03ac-4bbc-a26b-aa4b02281d0c", "_parent_code": "sample string 6", "sales_organization_id": "fe7ab50d-f6b0-4650-8b64-6041dac3c31d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+00:00" }, "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00" }, "equipment_model_id": "e1ea395d-5b60-4032-bcde-aaa7732300ca", "equipment_model_code": "sample string 8", "equipment_model": { "id": "ad344e0e-11fc-4482-b05e-fe8130fc6979", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "9cda8c2c-47ad-48e6-a8d5-6ee78d7a0a4a", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "5399ddd0-9318-4f54-a6bb-0009dd52543c", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "c4d74c75-cc64-4543-9e02-4196147d4151", "sales_organization_code": "sample string 5", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+00:00" }, "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00" }, "equipment_family_id": "85cf088d-95e6-4182-aedd-23117cf47593", "equipment_family_code": "sample string 8", "equipment_family": { "id": "7e291c29-ba53-4d3a-bf9c-da876caf9d8f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "74b36514-03ac-4bbc-a26b-aa4b02281d0c", "_parent_code": "sample string 6", "sales_organization_id": "fe7ab50d-f6b0-4650-8b64-6041dac3c31d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+00:00" }, "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00" }, "date_in_production_since": "2025-10-18T08:54:23.6354323+00:00", "date_out_of_production_since": "2025-10-18T08:54:23.6354323+00:00", "date_end_support": "2025-10-18T08:54:23.6354323+00:00", "sales_organization_id": "43bdbdca-6812-4fac-b51f-661fe1284a08", "sales_organization_code": "sample string 13", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+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-18T08:54:23.6354323+00:00" }, "project_status_id": "2593e4c3-3279-446a-8825-54020eae12bf", "project_status_code": "sample string 10", "project_status": { "id": "de98efbb-8dc9-4ce2-9a0b-988c60830d9e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "8d7b5dac-536e-4e6d-8305-b75775ec68ed", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00" }, "company_id": "0477df4b-e74f-4abf-843e-08f690c49629", "company_code": "sample string 12", "db_address_id": "35bb62ef-6154-4035-bcd2-0e2cf4f2a224", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "0abb1f97-2d9c-4de0-b968-37aa939d1e97", "contact_reference_back_office": "sample string 17", "owner_user_id": "1218a247-81b2-40ea-a3a8-6469c36826b3", "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-18T08:54:23.6354323+00:00", "date_create": "2025-10-18T08:54:23.6354323+00:00", "date_update": "2025-10-18T08:54:23.6354323+00:00", "updated_by_user_id": "f31cc2a8-ab3d-4ea3-b14f-3ccc8e2f2bf2", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-18T08:54:23.6354323+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-18T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-18T08:54:23.6354323+00:00", "date_last_job": "2025-10-18T08:54:23.6354323+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-18T08:54:23.6354323+00:00", "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00", "is_mobile_installation": true }, "job_type_id": "1702dcaf-a826-4212-841c-5f0302bf02a0", "job_type_code": "sample string 7", "job_type": { "id": "b7fa3e69-7faa-4a35-8e2c-d12e6baeba6a", "name": "sample string 2", "sales_organization_id": "b0b76864-1f68-4a32-a53f-df0c8c5207b7", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00", "code": "sample string 7" }, "job_priority_id": "5cea6dce-d065-4d30-b13b-7ce2795c9e3d", "job_priority_code": "sample string 9", "job_priority": { "id": "7d5c3ca2-1a40-41a8-815a-8f4f2394588d", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "ea6665cc-1e8a-4a13-be6d-47b082a341ad", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00" }, "job_status_id": "531a66af-2e53-4d63-807f-45d4de77515d", "job_status_code": "sample string 11", "db_address_id": "ec638bd0-e869-410c-aaa8-40eca9778329", "contact_id": "57a4cee3-2605-46a3-b26b-21fe94a8ee71", "requested_by_company_id": "e8049c7a-2535-48c6-b5ac-fb7677402d45", "requested_by_contact_id": "054ac0b0-b3e6-4c12-90c2-416bf9a8fe88", "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-18T08:54:23.6354323+00:00", "due_date": "2025-10-18T08:54:23.6354323+00:00", "date_create": "2025-10-18T08:54:23.6354323+00:00", "date_update": "2025-10-18T08:54:23.6354323+00:00", "date_closed": "2025-10-18T08:54:23.6354323+00:00", "suggested_user_id": "4ba6cb5f-62b4-44a3-8ca1-b3f72c9af7fc", "suggested_user_code": "sample string 29", "suggested_user": { "id": "ce9b034a-a99f-428d-8524-0803f410c0f2", "db_language_id": "18fb64cd-6f69-4944-bbc2-e832095e29ae", "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-18T08:54:23.6354323+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "02255490-4ed3-4714-a66f-e2a4cf48b908", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "458462b1-a0fb-46ea-832e-65cbff314088", "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": "f4adf2f5-61aa-4cb9-9c4a-3667fcafb4d1", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "f91690c4-9f37-45c2-9750-0cae1166d3f3" }, "suggested_date_start": "2025-10-18T08:54:23.6354323+00:00", "skill_id": "ed372f47-b194-420c-a9ae-2c374b01b318", "skill_code": "sample string 32", "skill": { "id": "a12e6371-6ef1-47cc-b78e-747eb000f4d6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9d241d20-2f85-4e6f-b167-bf689ce8a09e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3b0e3638-db47-494b-93b3-5306a295e941", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "6f6d297f-ec57-4666-b6fb-a90c3f8c3c06", "db_currency_id": "7fb14376-2a3c-4c33-a311-95014928e5d7", "db_language_id": "58695a1a-a5e5-49ae-92ce-ea666ff8e2e3", "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-18T08:54:23.6354323+00:00" }, "modified_dateutc": "2025-10-18T08:54:23.6354323+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "a6823a82-0d53-4919-bf0c-120a08155f7a", "date_reported_by_company": "2025-10-18T08:54:23.6354323+00:00", "id2": 36, "company_id": "eeaf8d06-c038-4c2b-a963-9f289c0c65b7", "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": "375c99df-4c43-4d85-a06e-51e56f01e430", "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-18T08:54:23.6354323+00:00" }