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": "e72f4117-bfb5-4bac-bde1-f3a23523dbf9", "_parent_id": "f83cebff-d8a8-4463-8e47-007643170e18", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "f037a51b-0191-4cae-bcb6-f5030be62227", "project_reference_back_office": "sample string 5", "project": { "id": "9a9ff330-b84d-448a-88aa-20d88f60fc54", "_parent_id": "6b70be9e-c8ee-442a-b946-adda568761a1", "root_parent_id": "3c53046a-6d17-4f08-a6db-4e4fd8b67a8b", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "c0335d04-ceee-4a96-a0a3-a14a900b9eac", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e2f3727c-4f7b-480d-9254-f93acedf7a0f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1ed22079-ef71-460a-9426-834e4625896f", "_parent_code": "sample string 6", "sales_organization_id": "85f79c20-d06b-49d8-b8c1-d767f94de331", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+00:00" }, "modified_dateutc": "2024-07-23T08:54:36.4600168+00:00" }, "equipment_model_id": "be738c44-2aaf-41b1-810b-e0fcf6fdb45a", "equipment_model_code": "sample string 8", "equipment_model": { "id": "e442409d-dbb7-48db-be9a-7cf3b5e5fc4c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "bc597a0e-05be-4f0c-ab66-a9d881149862", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "70d5bb94-40e8-459f-9074-75543d9ffa5d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "0ea0a79e-b5e4-443d-b65f-3f1f9cc36b50", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+00:00" }, "modified_dateutc": "2024-07-23T08:54:36.4600168+00:00" }, "equipment_family_id": "01373825-81af-4f51-a163-bf19187497ca", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e2f3727c-4f7b-480d-9254-f93acedf7a0f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1ed22079-ef71-460a-9426-834e4625896f", "_parent_code": "sample string 6", "sales_organization_id": "85f79c20-d06b-49d8-b8c1-d767f94de331", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+00:00" }, "modified_dateutc": "2024-07-23T08:54:36.4600168+00:00" }, "date_in_production_since": "2024-07-23T08:54:36.4600168+00:00", "date_out_of_production_since": "2024-07-23T08:54:36.4600168+00:00", "date_end_support": "2024-07-23T08:54:36.4600168+00:00", "sales_organization_id": "84f82201-a20b-4a36-bcdd-1e34f8e5b33e", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+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-07-23T08:54:36.4600168+00:00" }, "project_status_id": "af2b6ff5-a37f-44eb-a6ed-44a98d0c4a6b", "project_status_code": "sample string 10", "project_status": { "id": "a038b918-180c-4457-8c6a-2d25764f4b13", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "50114df8-fa8d-4a9e-869f-e62bdae09420", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-07-23T08:54:36.4600168+00:00" }, "company_id": "f9d5744c-75a8-4e8a-87d5-8aa4b3707446", "company_code": "sample string 12", "db_address_id": "a8975c14-b8ab-4cf6-9290-ba8fdc1824d7", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "9ee723b6-9646-487c-813e-55b12df2573c", "contact_reference_back_office": "sample string 17", "owner_user_id": "4dfb8412-418b-4691-845a-78089a9393f5", "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-07-23T08:54:36.4600168+00:00", "date_create": "2024-07-23T08:54:36.4600168+00:00", "date_update": "2024-07-23T08:54:36.4600168+00:00", "updated_by_user_id": "4085255d-7e29-46ed-b5bd-dd61e1cd2c01", "customer_reference": "sample string 28", "warranty_date_until": "2024-07-23T08:54:36.4600168+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-07-23T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-07-23T08:54:36.4756798+00:00", "date_last_job": "2024-07-23T08:54:36.4756798+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-07-23T08:54:36.4756798+00:00", "modified_dateutc": "2024-07-23T08:54:36.4756798+00:00", "is_mobile_installation": true }, "job_type_id": "4e9e7684-ebf8-4381-97c6-c87b35a3b176", "job_type_code": "sample string 7", "job_type": { "id": "89f210e9-6469-4a96-b60a-a4068c18de8a", "name": "sample string 2", "sales_organization_id": "92ebf37e-7ae1-44e3-9d07-6757828fc52e", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-07-23T08:54:36.4756798+00:00", "code": "sample string 7" }, "job_priority_id": "8ac15da4-e716-4762-ab7a-2ea3a08cdbbf", "job_priority_code": "sample string 9", "job_priority": { "id": "a26530ec-de15-47dc-a28c-3ee502fa0d33", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "021289e9-2387-4cac-9cd1-87b63cbe40b5", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-07-23T08:54:36.4756798+00:00" }, "job_status_id": "499693b0-f9a5-4ac8-b8e1-dd2cd3f67d87", "job_status_code": "sample string 11", "db_address_id": "c8d23c38-505b-480e-a818-e078c78b240c", "contact_id": "39f046c6-7569-4b1e-b15b-8551d307be89", "requested_by_company_id": "b1922605-fa69-4ab3-a7ef-e6c801d8fdc9", "requested_by_contact_id": "76238c8e-7b8c-41c0-a3d0-ac643bb29e0c", "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-07-23T08:54:36.4756798+00:00", "due_date": "2024-07-23T08:54:36.4756798+00:00", "date_create": "2024-07-23T08:54:36.4756798+00:00", "date_update": "2024-07-23T08:54:36.4756798+00:00", "date_closed": "2024-07-23T08:54:36.4756798+00:00", "suggested_user_id": "52944ee6-d1a9-484d-943a-e9231b3bec39", "suggested_user_code": "sample string 29", "suggested_user": { "id": "53ef2fdb-9878-44b9-a1dd-7e707670b2a0", "db_language_id": "28d8a8e0-7047-445b-a449-9842d0876256", "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-07-23T08:54:36.4756798+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b3d2d2d7-1d81-4c10-b43a-2ce97c61aebc", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "e815f74a-cabe-4b51-a170-8e2a86cb52ed", "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": "43ebc32b-7bb2-4817-a106-1e2ad8171ea0", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-07-23T08:54:36.4756798+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "1d60c772-8321-43b8-a740-dc29a8c299a2" }, "suggested_date_start": "2024-07-23T08:54:36.4756798+00:00", "skill_id": "3f5b2308-66dc-4163-aaea-2a39bdd2d2b7", "skill_code": "sample string 32", "skill": { "id": "a15089c2-efe3-4e34-a1cd-7cd5b2979a90", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "2d840f35-71c7-4511-b5b5-7a2665c74230", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1cb2a616-dc7b-4e5e-bbf7-2437b32c035f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea7d5357-2e51-42c3-976c-ae57502f92b3", "db_currency_id": "e33e1801-c4d5-4a9b-afd9-25650986012e", "db_language_id": "8d63771c-58c3-4fb2-8e23-5a3944cb23e7", "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-07-23T08:54:36.4600168+00:00" }, "modified_dateutc": "2024-07-23T08:54:36.4756798+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "aa93761b-1288-4f99-9f5c-015f118b733f", "date_reported_by_company": "2024-07-23T08:54:36.4756798+00:00", "id2": 36, "company_id": "75dd6cf2-c3ca-49fb-9ebc-b784335886ff", "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": "50cc5fe9-189c-4205-8df4-e754e7a59c7f", "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-07-23T08:54:36.4756798+00:00" }