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": "79a3d4c3-7ffc-48ba-ada6-4690dbc49690", "_parent_id": "c06065ab-4d40-4aa7-9816-e3ef142554c6", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "843c4521-eff1-427b-b7f5-3082d1e5576c", "project_reference_back_office": "sample string 5", "project": { "id": "90f2383e-ab5a-46b3-8b60-0a7827a98cae", "_parent_id": "ac421e28-5edc-45cc-a224-82355565aecd", "root_parent_id": "20cf0713-b812-48c5-a94f-d57c7fdfaa8a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "cf9848e7-6d22-4147-be6b-5aa6126b3fae", "equipment_family_code": "sample string 6", "equipment_family": { "id": "33c1b4bb-e767-42d9-a50b-a4de40022447", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6ae67ca0-8802-491b-9925-9b10a99d8fb9", "_parent_code": "sample string 6", "sales_organization_id": "c5eb7fbb-1883-4ac0-918b-73c649fb62f8", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+00:00" }, "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00" }, "equipment_model_id": "bcb781bf-bbd5-406b-994f-6790e81700a4", "equipment_model_code": "sample string 8", "equipment_model": { "id": "90ac8eb9-dda2-4eb3-9dbb-7952f7a4b1b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "43fbb541-5fb0-41c0-a8cd-46466f6bccff", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "018770d1-1730-42f4-9572-737f29503759", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "604e0324-724d-4c71-bc42-c124cdcbd1a5", "sales_organization_code": "sample string 5", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+00:00" }, "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00" }, "equipment_family_id": "45d9a0c9-8a65-4312-aa83-f3c48c4f5dac", "equipment_family_code": "sample string 8", "equipment_family": { "id": "33c1b4bb-e767-42d9-a50b-a4de40022447", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "6ae67ca0-8802-491b-9925-9b10a99d8fb9", "_parent_code": "sample string 6", "sales_organization_id": "c5eb7fbb-1883-4ac0-918b-73c649fb62f8", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+00:00" }, "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00" }, "date_in_production_since": "2025-05-28T01:02:21.8432819+00:00", "date_out_of_production_since": "2025-05-28T01:02:21.8432819+00:00", "date_end_support": "2025-05-28T01:02:21.8432819+00:00", "sales_organization_id": "2f15aedb-0b9b-42a1-b8a8-ed752d44f3ca", "sales_organization_code": "sample string 13", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+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-05-28T01:02:21.8432819+00:00" }, "project_status_id": "a680eaf6-56b2-49e7-be88-2b32fe59b646", "project_status_code": "sample string 10", "project_status": { "id": "d6a09f98-529f-4209-9653-459eaa5124c7", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "32101045-b134-40c0-92b9-654e201c0d00", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00" }, "company_id": "ce42f849-6912-4bc7-9b83-6416344e1c37", "company_code": "sample string 12", "db_address_id": "022a64f6-0bb1-484a-8f59-e50734b77783", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "af3b3b49-9fd7-44e9-bcb1-106f7252c07a", "contact_reference_back_office": "sample string 17", "owner_user_id": "c1d0e193-ece8-46da-aa0a-16f19a5a737d", "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-05-28T01:02:21.8432819+00:00", "date_create": "2025-05-28T01:02:21.8432819+00:00", "date_update": "2025-05-28T01:02:21.8432819+00:00", "updated_by_user_id": "b43939fa-26db-4ba2-8ce0-50de1bac91a9", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-28T01:02:21.8432819+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-05-28T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-28T01:02:21.8432819+00:00", "date_last_job": "2025-05-28T01:02:21.8432819+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-28T01:02:21.8432819+00:00", "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00", "is_mobile_installation": true }, "job_type_id": "23bc1f93-f2e1-48ef-a62d-0821abf57dc4", "job_type_code": "sample string 7", "job_type": { "id": "3ae99818-d998-4af4-be40-72349f951402", "name": "sample string 2", "sales_organization_id": "ff1296ce-aa3d-422c-9d9d-0fd4750b4f20", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00", "code": "sample string 7" }, "job_priority_id": "6f94ff7b-8de5-40cf-b777-04c2d917a30a", "job_priority_code": "sample string 9", "job_priority": { "id": "a0ef1803-3a57-42dc-b491-777a1cf505db", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "d8bb7818-65f3-41f4-b3f8-2c8d24bad42a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00" }, "job_status_id": "e920e0c9-e58d-4e27-baa2-40553b81abca", "job_status_code": "sample string 11", "db_address_id": "978bea3c-ee18-4b6a-8113-137211e8323d", "contact_id": "49209c4d-0b5e-465b-b1db-615bc1eedea0", "requested_by_company_id": "e3edaa41-73ec-4f08-a700-33a2a25c9df2", "requested_by_contact_id": "55cd660e-59b9-4377-a473-925df74864a0", "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-05-28T01:02:21.8432819+00:00", "due_date": "2025-05-28T01:02:21.8432819+00:00", "date_create": "2025-05-28T01:02:21.8432819+00:00", "date_update": "2025-05-28T01:02:21.8432819+00:00", "date_closed": "2025-05-28T01:02:21.8432819+00:00", "suggested_user_id": "b9b8d145-5223-4b6e-a163-a0a199c75aae", "suggested_user_code": "sample string 29", "suggested_user": { "id": "017bb630-9c44-462f-8869-80ab594a2e95", "db_language_id": "69c6dde2-940e-4f5b-8b5d-0363c563be73", "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-05-28T01:02:21.8432819+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2c08dbf2-df01-4029-bb70-b7b6cb7e772a", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "29ea608c-48c2-4abd-a19a-e6962a5277e1", "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": "29af9efa-dfaf-42cd-91e8-f481d69bdd7c", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "317bf287-d80d-4227-94c6-515f10cb04b2" }, "suggested_date_start": "2025-05-28T01:02:21.8432819+00:00", "skill_id": "c61c7186-8879-4868-b530-a77f71ed0e06", "skill_code": "sample string 32", "skill": { "id": "272200e8-ae02-40e3-9ff5-c65e764a6458", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "dec39884-28bb-4f9f-aedb-57d1d53599f5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bc12d5c6-5abe-4787-9d78-2fba47600916", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c1f4c8ae-8d07-4dae-8c36-d83f5d2a4000", "db_currency_id": "586e34af-e1a2-4437-a439-9a99df077368", "db_language_id": "f2c15005-c5a9-487b-9886-0c6b20c17df4", "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-05-28T01:02:21.8432819+00:00" }, "modified_dateutc": "2025-05-28T01:02:21.8432819+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "0ea4d1c1-951e-4d79-a818-1ed32b356a0c", "date_reported_by_company": "2025-05-28T01:02:21.8432819+00:00", "id2": 36, "company_id": "47ea3d92-f92a-425a-a3a9-a1eced14e35f", "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": "43d5e9a0-2a84-4dbf-ba23-a23992fdfb1a", "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-05-28T01:02:21.8432819+00:00" }