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": "fb36a940-7ebc-4920-8bc2-42cec196e34b", "_parent_id": "e743e3b8-f7a6-4c8f-93de-851af8a52521", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "80bf5866-92d2-42ae-bdac-65282ccc8843", "project_reference_back_office": "sample string 5", "project": { "id": "925fe4af-dbef-409e-a01b-df4ff45dabdc", "_parent_id": "07077c00-0222-4025-bdb8-df5432fe0e7d", "root_parent_id": "20e795cf-1a83-4839-b208-f8e15a1f62d1", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "1bfcf7a5-7f54-41ce-8580-ef5bbefcbb5d", "equipment_family_code": "sample string 6", "equipment_family": { "id": "ca533ce8-00de-46ba-900e-abf4643f7a97", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c8516f13-ece6-48b7-b7d0-e3b6818c0d3f", "_parent_code": "sample string 6", "sales_organization_id": "8f5d3fd5-1e5f-4471-9195-2ea0fe7ee019", "sales_organization_code": "sample string 8", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+00:00" }, "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00" }, "equipment_model_id": "daf39adf-414a-4e16-adc9-8071dd4a22b8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "3edbcd1c-695a-4a2e-a2d5-92c605997a0f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "4b9aa232-7c21-438f-a0bf-4ee263e885bf", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "e8b21ee8-d3db-4616-839f-434d0cd18e2a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "23a12a35-9706-41bb-ba1b-792b1cd3572e", "sales_organization_code": "sample string 5", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+00:00" }, "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00" }, "equipment_family_id": "0b1ff306-7805-4959-aecb-36b346611b80", "equipment_family_code": "sample string 8", "equipment_family": { "id": "ca533ce8-00de-46ba-900e-abf4643f7a97", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "c8516f13-ece6-48b7-b7d0-e3b6818c0d3f", "_parent_code": "sample string 6", "sales_organization_id": "8f5d3fd5-1e5f-4471-9195-2ea0fe7ee019", "sales_organization_code": "sample string 8", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+00:00" }, "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00" }, "date_in_production_since": "2025-10-01T09:54:00.7564706+00:00", "date_out_of_production_since": "2025-10-01T09:54:00.7564706+00:00", "date_end_support": "2025-10-01T09:54:00.7564706+00:00", "sales_organization_id": "4df19305-d139-4717-98bf-0af02f1287e6", "sales_organization_code": "sample string 13", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+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-01T09:54:00.7564706+00:00" }, "project_status_id": "e13c679d-6a7b-4ba7-85e0-a0317b1d20cb", "project_status_code": "sample string 10", "project_status": { "id": "f3760fa6-558f-4d48-b034-2b9b5fb9f1dd", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "6420145d-27e5-4874-92a3-911188956753", "sales_organization_code": "sample string 6", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00" }, "company_id": "2dac17d8-7896-45e8-8e30-a7cbc635b0ff", "company_code": "sample string 12", "db_address_id": "4da3d16f-a232-447d-85d9-63175dece76a", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "def7ffb8-5ad2-4ce0-8153-893e54f92791", "contact_reference_back_office": "sample string 17", "owner_user_id": "e3e69ee3-427c-4f0c-810c-604cb02a2a0b", "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-01T09:54:00.7564706+00:00", "date_create": "2025-10-01T09:54:00.7564706+00:00", "date_update": "2025-10-01T09:54:00.7564706+00:00", "updated_by_user_id": "d14e6574-16de-471f-8b94-c4e5c6bbe4f6", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-01T09:54:00.7564706+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-01T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-01T09:54:00.7564706+00:00", "date_last_job": "2025-10-01T09:54:00.7564706+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-01T09:54:00.7564706+00:00", "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00", "is_mobile_installation": true }, "job_type_id": "ccf640fb-51bd-449a-84c5-db29e4b3ae12", "job_type_code": "sample string 7", "job_type": { "id": "df81f785-abf0-4b55-b668-fb7152afedbb", "name": "sample string 2", "sales_organization_id": "ba396c28-35f7-4d3f-a31f-c3e88f0a2fe1", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00", "code": "sample string 7" }, "job_priority_id": "50753122-598c-40ad-ab4f-8f0e3e5b0a77", "job_priority_code": "sample string 9", "job_priority": { "id": "b1388ade-b112-467c-a4c8-3759fce594bd", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "de348ee2-77b8-4009-b9e9-700bde16abde", "sales_organization_code": "sample string 6", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00" }, "job_status_id": "c1edc4d4-2558-47df-a498-773d9fd52d1e", "job_status_code": "sample string 11", "db_address_id": "a77ef2f0-1aaf-4318-b4b7-8d465af07265", "contact_id": "4078a8f5-a077-4dca-94db-ec32c0298b2c", "requested_by_company_id": "3854448d-f0c7-48f1-b8e2-5a0028f23cec", "requested_by_contact_id": "901deea2-ecd0-46c5-8020-570f510a8037", "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-01T09:54:00.7564706+00:00", "due_date": "2025-10-01T09:54:00.7564706+00:00", "date_create": "2025-10-01T09:54:00.7564706+00:00", "date_update": "2025-10-01T09:54:00.7564706+00:00", "date_closed": "2025-10-01T09:54:00.7564706+00:00", "suggested_user_id": "9cb128dc-53e5-4155-bf5e-aa761f4f6f4c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "6d456ec5-44b5-4286-8018-569b8e9db658", "db_language_id": "e23f8764-f44d-49d3-ac5e-82ecfd143e48", "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-01T09:54:00.7564706+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "5df28f57-3e58-4ae0-b81f-e96cba9d3793", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0b56d2f3-303c-4d5f-bcf2-025ccab5c747", "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": "6bff2c97-dc61-4397-a882-f900299225a2", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "7422f5b8-5cf2-4a0b-8325-385004a308de" }, "suggested_date_start": "2025-10-01T09:54:00.7564706+00:00", "skill_id": "d829c92a-e24c-4b57-a4a6-b5c06803dffe", "skill_code": "sample string 32", "skill": { "id": "09b9009b-3d11-42a1-9c92-a148eed92892", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "2b57002c-c16e-42cd-91a2-cd9e0e647688", "sales_organization_code": "sample string 6", "sales_organization": { "id": "85935030-5b12-4e24-ad94-d20eb89e8816", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "979d9f10-9fa7-4849-aad8-66c501c9f3e7", "db_currency_id": "f7e8812e-497c-4668-8ee5-81a6a3b05284", "db_language_id": "b5584d34-fcfb-4a1b-8a43-916ef1eef2ff", "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-01T09:54:00.7564706+00:00" }, "modified_dateutc": "2025-10-01T09:54:00.7564706+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "04931b2d-afa5-4946-8253-89b0dd3b5049", "date_reported_by_company": "2025-10-01T09:54:00.7564706+00:00", "id2": 36, "company_id": "ac7dd479-df37-461e-8010-98a30a55e4dd", "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": "1cf3e337-00d3-4d0c-b7fe-5ae35a7be116", "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-01T09:54:00.7564706+00:00" }