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": "f69a939a-3f7e-41fe-9895-65b65a842ca3", "_parent_id": "537530ee-9328-4c68-8acc-160143329ef3", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "41e6ca9e-c91c-4a22-8efa-294d399a89b3", "project_reference_back_office": "sample string 5", "project": { "id": "6004e046-ad73-4aaa-9c12-09c6b4b4dda9", "_parent_id": "90f9678a-83f9-4ea6-b6e0-9d4d38c12f7a", "root_parent_id": "7bf7b192-1c20-4577-b90d-282a828c8a4e", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "74670aaa-a74f-4f98-8bcf-d2ae80a6a9a3", "equipment_family_code": "sample string 6", "equipment_family": { "id": "8012a92b-6644-4155-8848-20985884a319", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "9c48103a-d361-4116-8733-b76c04182c8a", "_parent_code": "sample string 6", "sales_organization_id": "3d749511-d29a-48e2-a266-530ef77bc0aa", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+00:00" }, "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00" }, "equipment_model_id": "6d3a0e29-44dc-4ebe-87a4-a069dcea1920", "equipment_model_code": "sample string 8", "equipment_model": { "id": "68fd090a-6803-4a2f-91bc-1e3e72484267", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "11701a27-a2c4-46d3-8e79-73cb01f9ac15", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a216c33f-9854-47ff-b83a-bb5c93a72030", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "397697e2-546f-4998-bc68-e49eea75eef4", "sales_organization_code": "sample string 5", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+00:00" }, "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00" }, "equipment_family_id": "66527cf3-deda-4109-b3be-a4b175aaec58", "equipment_family_code": "sample string 8", "equipment_family": { "id": "8012a92b-6644-4155-8848-20985884a319", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "9c48103a-d361-4116-8733-b76c04182c8a", "_parent_code": "sample string 6", "sales_organization_id": "3d749511-d29a-48e2-a266-530ef77bc0aa", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+00:00" }, "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00" }, "date_in_production_since": "2025-09-03T09:44:27.0507554+00:00", "date_out_of_production_since": "2025-09-03T09:44:27.0507554+00:00", "date_end_support": "2025-09-03T09:44:27.0507554+00:00", "sales_organization_id": "01cb2d75-c361-474c-a08d-e2a4238fe42b", "sales_organization_code": "sample string 13", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+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-09-03T09:44:27.0507554+00:00" }, "project_status_id": "8bb3df4f-0768-46aa-a443-38489ab4a60b", "project_status_code": "sample string 10", "project_status": { "id": "67627c50-21e6-47c3-aad5-0b76f16b260d", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ba98a7ba-cc97-430e-bad1-79db6ed2884b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00" }, "company_id": "b260082d-a53a-40a1-8e29-5b1e86049355", "company_code": "sample string 12", "db_address_id": "d77d4777-a50a-454d-83eb-2af7b9f01cc1", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "e822d960-22ba-45c6-96cb-977261c17d89", "contact_reference_back_office": "sample string 17", "owner_user_id": "41e679e6-53d3-45ec-a3f5-40277d783811", "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-09-03T09:44:27.0507554+00:00", "date_create": "2025-09-03T09:44:27.0507554+00:00", "date_update": "2025-09-03T09:44:27.0507554+00:00", "updated_by_user_id": "cd1fd961-7564-46ef-815c-036cce4e8a57", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-03T09:44:27.0507554+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-09-03T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-03T09:44:27.0507554+00:00", "date_last_job": "2025-09-03T09:44:27.0507554+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-03T09:44:27.0507554+00:00", "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00", "is_mobile_installation": true }, "job_type_id": "12e5c185-705e-40a9-a911-0203d36862b8", "job_type_code": "sample string 7", "job_type": { "id": "b1038f1f-d43c-4ed1-a0a6-99d47dc4965a", "name": "sample string 2", "sales_organization_id": "4ef3e19c-e1bf-45b7-83c7-2d178dc63cb5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00", "code": "sample string 7" }, "job_priority_id": "3854f4ce-5731-499d-8c3b-9112f14d289a", "job_priority_code": "sample string 9", "job_priority": { "id": "8d4f3e1e-d390-48ea-81d6-ad7fa6c3e961", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "ab35ef9c-63ca-47de-955e-c4279b7c95fb", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00" }, "job_status_id": "2163f680-d5fa-4c63-999a-87731c4f3bb1", "job_status_code": "sample string 11", "db_address_id": "b2b155c9-5592-48ce-825d-907a835d5183", "contact_id": "1d99334d-2c99-49b8-9678-7e1f4ea71463", "requested_by_company_id": "70d98c6e-e01b-4d40-8a95-1f3f6da08abc", "requested_by_contact_id": "687fa6d8-5623-4053-a4c2-c7fbf5ee03e5", "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-09-03T09:44:27.0507554+00:00", "due_date": "2025-09-03T09:44:27.0507554+00:00", "date_create": "2025-09-03T09:44:27.0507554+00:00", "date_update": "2025-09-03T09:44:27.0507554+00:00", "date_closed": "2025-09-03T09:44:27.0507554+00:00", "suggested_user_id": "8cdc2886-9579-4561-b050-d63df3d83d6e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "625a3a58-0304-4474-b259-ad0f376022f2", "db_language_id": "07964daf-cd4a-45f2-8808-6dfcb2e72fe0", "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-09-03T09:44:27.0507554+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "d7c9cab0-2a5f-47c7-a908-29e93c694737", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "8a11f3a5-c7ef-4cf5-b04e-48dcb8c11db7", "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": "eff8b0a8-59a5-485d-b110-15ff76321beb", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "762f8bdd-b668-4b52-a414-5f5c66755793" }, "suggested_date_start": "2025-09-03T09:44:27.0507554+00:00", "skill_id": "5bcb556b-f479-4021-ad84-4d3393a3bd39", "skill_code": "sample string 32", "skill": { "id": "0e9cf0b8-96e8-4690-803f-3bea1c3f99ef", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "da46b401-7ed6-4b58-9656-5179fa7693ae", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d8635f7c-ee82-41ac-b324-1c48fd49f073", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f46389d1-d19b-4c5d-a493-8152a496535f", "db_currency_id": "95a1bf3f-ce45-4f89-b1eb-3e33e6d8c6ef", "db_language_id": "922d4bcf-004d-4252-81b4-6485f99b214d", "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-09-03T09:44:27.0507554+00:00" }, "modified_dateutc": "2025-09-03T09:44:27.0507554+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "3e0505f7-f523-4564-aadb-3516d8e334a8", "date_reported_by_company": "2025-09-03T09:44:27.0507554+00:00", "id2": 36, "company_id": "7f8bdc7a-e6b8-4166-a2dc-add934c6ec97", "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": "d9d11fe3-9f1b-47bf-a213-73feec04961c", "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-09-03T09:44:27.0507554+00:00" }