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": "a5b46fd8-6178-4f90-87be-d48bef988429", "_parent_id": "44668722-99bd-48af-8a0b-1e7df1e97e3b", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "8215a0be-bbce-4e4f-928a-ff9bee2fa2f4", "project_reference_back_office": "sample string 5", "project": { "id": "efbb5411-c079-46dc-b7c1-601c85704d7f", "_parent_id": "9059886b-93dd-4ef8-a14e-6b39ccf7a224", "root_parent_id": "2473325d-c517-4665-9a4a-24536136308a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "44f745ae-c96c-4423-98d6-854c83fb4cfe", "equipment_family_code": "sample string 6", "equipment_family": { "id": "390f2e63-e3a2-4e25-8461-0d08278b18a1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "88e8e994-257d-4d4f-9669-28a39dec6100", "_parent_code": "sample string 6", "sales_organization_id": "9f089174-eac0-4081-8e18-bf0db382a1bb", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+00:00" }, "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00" }, "equipment_model_id": "c469a61f-5325-4d43-a388-b0ed6e4dd4c8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "aac16dc5-747f-42d6-8844-b9b2942e8915", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "f3377347-9727-4769-8cd7-606724c300d4", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "0d5654ba-b1c0-4969-8dfd-c8eb7d7580a8", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "76093a0a-812d-4e4e-967b-793b4d07d20e", "sales_organization_code": "sample string 5", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+00:00" }, "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00" }, "equipment_family_id": "9e4b9ff2-78db-467b-a63c-d394ffdbd5c6", "equipment_family_code": "sample string 8", "equipment_family": { "id": "390f2e63-e3a2-4e25-8461-0d08278b18a1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "88e8e994-257d-4d4f-9669-28a39dec6100", "_parent_code": "sample string 6", "sales_organization_id": "9f089174-eac0-4081-8e18-bf0db382a1bb", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+00:00" }, "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00" }, "date_in_production_since": "2024-05-01T04:37:51.9440667+00:00", "date_out_of_production_since": "2024-05-01T04:37:51.9440667+00:00", "date_end_support": "2024-05-01T04:37:51.9440667+00:00", "sales_organization_id": "f90ffbe2-2ccf-4616-a6c4-bcfc5be37a73", "sales_organization_code": "sample string 13", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+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": "2024-05-01T04:37:51.9440667+00:00" }, "project_status_id": "a8a4eed3-6f87-4c32-8a06-ba8bd0654427", "project_status_code": "sample string 10", "project_status": { "id": "a30e8991-132b-46a8-9690-4b6be617885b", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "d06d0e7b-1012-476b-9158-03b9cd9c9068", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00" }, "company_id": "f6fadeb1-c026-452b-bec2-95615a7c8a19", "company_code": "sample string 12", "db_address_id": "3f9c8dea-7cbb-46b4-876c-0421bcef93d9", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "19f3c9db-5b7b-4957-a29f-9c509a7b4bb6", "contact_reference_back_office": "sample string 17", "owner_user_id": "6a46f5b8-ea01-4316-88f1-f952bde53ad1", "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": "2024-05-01T04:37:51.9440667+00:00", "date_create": "2024-05-01T04:37:51.9440667+00:00", "date_update": "2024-05-01T04:37:51.9440667+00:00", "updated_by_user_id": "85382bb5-257a-4ebe-91e6-9a0d6274a229", "customer_reference": "sample string 28", "warranty_date_until": "2024-05-01T04:37:51.9440667+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": "2024-05-01T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-05-01T04:37:51.9440667+00:00", "date_last_job": "2024-05-01T04:37:51.9440667+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-05-01T04:37:51.9440667+00:00", "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00", "is_mobile_installation": true }, "job_type_id": "5518be47-9225-45de-978a-7fd42cf126af", "job_type_code": "sample string 7", "job_type": { "id": "5bacd563-a30f-49c5-a026-38d9445fb79c", "name": "sample string 2", "sales_organization_id": "58c8eb82-4e2c-4a2b-9de1-164ace8e0abe", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00", "code": "sample string 7" }, "job_priority_id": "6b7adce2-ddb8-47bc-97d8-cd7f9a5798bd", "job_priority_code": "sample string 9", "job_priority": { "id": "e2ebaf07-f00c-46fd-9164-5c5460c50634", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "028f8724-1404-4a03-be64-e300b6e21ca0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00" }, "job_status_id": "8bd28209-265b-4607-a8db-21f5c7bbda95", "job_status_code": "sample string 11", "db_address_id": "ef49bcd9-ffd6-4af3-bb9d-449b980fa555", "contact_id": "e28fc5f4-6752-4c7f-a832-f9e033ad0eb5", "requested_by_company_id": "3cca8b58-245c-4bd6-9325-e0f634e8c176", "requested_by_contact_id": "195d870c-5fba-4c9e-b054-558b0fc004b1", "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": "2024-05-01T04:37:51.9440667+00:00", "due_date": "2024-05-01T04:37:51.9440667+00:00", "date_create": "2024-05-01T04:37:51.9440667+00:00", "date_update": "2024-05-01T04:37:51.9440667+00:00", "date_closed": "2024-05-01T04:37:51.9440667+00:00", "suggested_user_id": "6ad1a26c-7239-4608-a665-6136aa62d363", "suggested_user_code": "sample string 29", "suggested_user": { "id": "98b8537e-a2e1-4545-b056-c1cfd5eeef70", "db_language_id": "f84b0305-6856-4f99-a1a6-6a05530e57df", "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": "2024-05-01T04:37:51.9440667+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b13f79e3-a22a-4087-937d-22ce584c06e0", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "3ff4511c-8833-4989-9378-e603aec17407", "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": "c119ea0f-aeb2-48b7-bed0-4f979b3088c0", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "198037a5-7b24-4695-ac86-8b9fd91b9039" }, "suggested_date_start": "2024-05-01T04:37:51.9440667+00:00", "skill_id": "c3deee19-c67d-4cc1-bba0-42ccba9161c5", "skill_code": "sample string 32", "skill": { "id": "2d82ecf3-5834-4ac3-8c10-2ccb93aa48de", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a3a05d85-bc8e-4f83-aab7-f78c6704c16e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3c5e126d-566c-4573-817b-158c6db7866d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "34f17279-b18d-449c-968a-c665216a1a36", "db_currency_id": "8ae0c4c0-8852-45c0-8fe1-e547d04be934", "db_language_id": "12b5dbb6-830e-47ea-81dd-4b1b1c3bb2fc", "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": "2024-05-01T04:37:51.9440667+00:00" }, "modified_dateutc": "2024-05-01T04:37:51.9440667+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "1fcb6f46-966d-40e0-8d91-56016899294c", "date_reported_by_company": "2024-05-01T04:37:51.9440667+00:00", "id2": 36, "company_id": "87ee866b-720a-49d0-9904-012f3a4ed6cd", "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": "c82e5966-d2d8-4648-b04a-2927ecad430e", "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": "2024-05-01T04:37:51.9440667+00:00" }