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": "1f2a9f56-0a90-43fd-b087-9bddaad63cb7", "_parent_id": "e34a2adf-78fe-41eb-849b-25de088abddd", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "6c6a0cea-f5bc-470b-bd67-c0c8a4b48579", "project_reference_back_office": "sample string 5", "project": { "id": "54280038-8c27-4579-a3a7-eee70ea6cfb0", "_parent_id": "535937e9-3fec-4e12-a58d-83a477aaadd4", "root_parent_id": "fe30709f-417a-4628-bead-feeb1cc362a1", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "7bf52a7c-3446-43c2-b5fd-3f1b02d9bd1b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e47528c9-754e-48c5-a6a0-7e7548eb2f64", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f966c4b8-f41e-4644-bd90-0526e9e03192", "_parent_code": "sample string 6", "sales_organization_id": "4153c9c9-7d37-428b-b695-d679366ad8b4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+00:00" }, "modified_dateutc": "2025-05-09T01:40:48.428803+00:00" }, "equipment_model_id": "ff05aa30-6c1c-4b93-b891-748a7eef62d1", "equipment_model_code": "sample string 8", "equipment_model": { "id": "85062021-4a7e-4460-b28e-9f6c212c2d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "81d9cf6b-b46e-41d4-bd94-f21d3edf8008", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "70c3689f-564a-486e-bcf1-38040974bb28", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "de07e684-b3cf-4ab5-9eb5-17ef50fe0f6a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+00:00" }, "modified_dateutc": "2025-05-09T01:40:48.428803+00:00" }, "equipment_family_id": "c0eade7b-1517-4186-9c0e-941b37a6fc2d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e47528c9-754e-48c5-a6a0-7e7548eb2f64", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f966c4b8-f41e-4644-bd90-0526e9e03192", "_parent_code": "sample string 6", "sales_organization_id": "4153c9c9-7d37-428b-b695-d679366ad8b4", "sales_organization_code": "sample string 8", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+00:00" }, "modified_dateutc": "2025-05-09T01:40:48.428803+00:00" }, "date_in_production_since": "2025-05-09T01:40:48.428803+00:00", "date_out_of_production_since": "2025-05-09T01:40:48.428803+00:00", "date_end_support": "2025-05-09T01:40:48.428803+00:00", "sales_organization_id": "fde1b466-754b-4275-bb9e-b8e3cd1bb1b6", "sales_organization_code": "sample string 13", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+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-09T01:40:48.428803+00:00" }, "project_status_id": "d8563557-f429-4dba-828f-0f2c61533948", "project_status_code": "sample string 10", "project_status": { "id": "d7322277-f33f-4b2f-8dfa-525eaca898b8", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "477ce750-5398-4e86-9b0a-db964fae9e6a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-09T01:40:48.428803+00:00" }, "company_id": "eef76abf-b0c6-4ed0-bd36-e8876a29a90c", "company_code": "sample string 12", "db_address_id": "b097064d-1b42-4d13-9814-14a65953a069", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "3c1dca48-b36f-480f-9642-49ec420a48ae", "contact_reference_back_office": "sample string 17", "owner_user_id": "5bf49777-8633-4b61-bdbc-363b74a740d3", "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-09T01:40:48.428803+00:00", "date_create": "2025-05-09T01:40:48.428803+00:00", "date_update": "2025-05-09T01:40:48.428803+00:00", "updated_by_user_id": "c61f7914-9a48-474b-aea6-19c0b5de19b2", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-09T01:40:48.428803+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-09T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-09T01:40:48.428803+00:00", "date_last_job": "2025-05-09T01:40:48.428803+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-09T01:40:48.428803+00:00", "modified_dateutc": "2025-05-09T01:40:48.428803+00:00", "is_mobile_installation": true }, "job_type_id": "fc24b286-bf6d-49bb-929a-f7ba1601f61d", "job_type_code": "sample string 7", "job_type": { "id": "94cba56a-2ce0-4b3a-a727-891cd2a7a961", "name": "sample string 2", "sales_organization_id": "118d3c97-4c72-442d-912d-5fb231a6290f", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-09T01:40:48.428803+00:00", "code": "sample string 7" }, "job_priority_id": "3b98e00f-e227-4c11-9119-26465a49ad44", "job_priority_code": "sample string 9", "job_priority": { "id": "69f1d82e-7285-4832-959f-0e0a81b9774e", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "4ec596f2-2ac3-4ee5-b89f-7a0c477f50fc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-09T01:40:48.428803+00:00" }, "job_status_id": "f343944c-eb5f-49b1-b796-ef7bf461487f", "job_status_code": "sample string 11", "db_address_id": "d34cd99a-dc4c-4a6c-a435-788b89b0174f", "contact_id": "78620f41-1db9-4056-ae6b-79b08862b7ad", "requested_by_company_id": "6334b8d7-3082-49e2-9638-0bbe73367cde", "requested_by_contact_id": "74c07e5b-4604-400b-ab13-c2fc49e2b166", "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-09T01:40:48.428803+00:00", "due_date": "2025-05-09T01:40:48.428803+00:00", "date_create": "2025-05-09T01:40:48.428803+00:00", "date_update": "2025-05-09T01:40:48.428803+00:00", "date_closed": "2025-05-09T01:40:48.428803+00:00", "suggested_user_id": "b409dd3c-995a-40c5-a34d-24c63191877f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "05a53ecf-e936-4478-8434-f3215614402a", "db_language_id": "1df7cbdc-16f1-44f9-bd6c-d89b10a7ef48", "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-09T01:40:48.428803+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "5320d249-8a25-4b95-9fb8-2e09acbc3fae", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "99dcb7c1-a891-40ad-90ff-5162730188e0", "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": "04f5ff21-1f79-470d-b7b3-4e24b13b6586", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-09T01:40:48.428803+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "e852f190-4254-48c8-a51f-341e0194300c" }, "suggested_date_start": "2025-05-09T01:40:48.428803+00:00", "skill_id": "0661a969-21bb-4e07-a902-e9a67dcc75f7", "skill_code": "sample string 32", "skill": { "id": "59ba9b21-092d-43ea-a150-08652ec23dc8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "8b45ac63-82a2-4dbf-aa8f-534c3a31c8c0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "cebfad04-4cc2-4ffe-a0ef-8b0aec310dd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8f08d777-bb5c-4d62-8dda-77cd9be51c66", "db_currency_id": "c0fc29c3-9e1c-44d5-80e0-316d22a4a54a", "db_language_id": "915502cc-21b5-4eb1-96b2-f2055c70711f", "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-09T01:40:48.428803+00:00" }, "modified_dateutc": "2025-05-09T01:40:48.428803+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "da3ef981-4e65-4b22-a698-bfc49afabba5", "date_reported_by_company": "2025-05-09T01:40:48.428803+00:00", "id2": 36, "company_id": "1136e5cf-51cd-4c65-9ece-c3e575560e7b", "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": "138a01a1-7123-4c61-a6a0-b50e4a140210", "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-09T01:40:48.428803+00:00" }