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": "6e41a757-bfef-40d9-8aa3-0c9bb5fa2fd4", "_parent_id": "7b2a1d1d-1747-49e6-9151-982a1dc13077", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c449898d-b5ad-45ad-9a29-8be0d39129de", "project_reference_back_office": "sample string 5", "project": { "id": "e71ed999-edac-4f50-b16f-4498e9e9a0a4", "_parent_id": "78f6d36d-0938-4282-985b-490cad76846c", "root_parent_id": "ed8a7c91-a87e-4f17-abc3-ead4c19f52bb", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d2fd25a0-fcad-482d-a0f7-4c6682f456ca", "equipment_family_code": "sample string 6", "equipment_family": { "id": "5fad048a-1689-4cfd-956a-228e499df89a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ca624cd5-4aec-4466-ac30-9090f6885e54", "_parent_code": "sample string 6", "sales_organization_id": "59fc0e01-7d49-4c54-8957-498669a108b3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+00:00" }, "modified_dateutc": "2025-03-23T21:21:52.0443369+00:00" }, "equipment_model_id": "18b57aeb-50e4-4ffb-9323-a674debc6dfd", "equipment_model_code": "sample string 8", "equipment_model": { "id": "109b5d90-fd73-452a-8944-c16d36da819e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "ca21fecd-e377-49df-a8a3-65c9687bc67d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "4c98aa89-b7c8-4584-b1a2-4c6a77b31acf", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "53c29554-9e70-4a02-a2f8-db7e472424fb", "sales_organization_code": "sample string 5", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+00:00" }, "modified_dateutc": "2025-03-23T21:21:52.0443369+00:00" }, "equipment_family_id": "073b6efa-0fe1-4b19-8df7-6d0851501fe8", "equipment_family_code": "sample string 8", "equipment_family": { "id": "5fad048a-1689-4cfd-956a-228e499df89a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ca624cd5-4aec-4466-ac30-9090f6885e54", "_parent_code": "sample string 6", "sales_organization_id": "59fc0e01-7d49-4c54-8957-498669a108b3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+00:00" }, "modified_dateutc": "2025-03-23T21:21:52.0443369+00:00" }, "date_in_production_since": "2025-03-23T21:21:52.0443369+00:00", "date_out_of_production_since": "2025-03-23T21:21:52.0443369+00:00", "date_end_support": "2025-03-23T21:21:52.0443369+00:00", "sales_organization_id": "2f778f23-c9b6-4cf8-a92c-75a978d788c7", "sales_organization_code": "sample string 13", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+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-03-23T21:21:52.0443369+00:00" }, "project_status_id": "994a1708-d898-4ef6-8ded-6297b3d5e440", "project_status_code": "sample string 10", "project_status": { "id": "4ce73af1-a8a0-472f-aaac-962e57ec4230", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "f21a061c-fa2c-4b25-ac10-8fc9c9c9c1b4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-23T21:21:52.0443369+00:00" }, "company_id": "9c922ba5-1347-487d-90d4-e6b187f21af2", "company_code": "sample string 12", "db_address_id": "7c4ae6cb-694b-456a-b578-f749db07f760", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "2355d528-f228-439b-ad97-6500c8602d34", "contact_reference_back_office": "sample string 17", "owner_user_id": "cd5888a7-7b16-4325-afc3-5e9308559589", "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-03-23T21:21:52.0443369+00:00", "date_create": "2025-03-23T21:21:52.0443369+00:00", "date_update": "2025-03-23T21:21:52.0443369+00:00", "updated_by_user_id": "2a6d23b0-041b-4515-b9d0-096dd75fc0ab", "customer_reference": "sample string 28", "warranty_date_until": "2025-03-23T21:21:52.0443369+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-03-23T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-03-23T21:21:52.0599609+00:00", "date_last_job": "2025-03-23T21:21:52.0599609+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-03-23T21:21:52.0599609+00:00", "modified_dateutc": "2025-03-23T21:21:52.0599609+00:00", "is_mobile_installation": true }, "job_type_id": "908d9a18-f083-4927-964f-3a461a1d1571", "job_type_code": "sample string 7", "job_type": { "id": "1f45a4b4-c94f-41a8-8ce5-a2c0eaaa3652", "name": "sample string 2", "sales_organization_id": "227e1259-f630-4c95-8817-6862c8e6a2d3", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-03-23T21:21:52.0599609+00:00", "code": "sample string 7" }, "job_priority_id": "8df546e0-723d-48d4-89c3-e8ee3ce82f00", "job_priority_code": "sample string 9", "job_priority": { "id": "e95535da-c0b3-4a62-8a66-6127948abfd6", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "50d05b16-dcc4-466f-860c-9303371906fc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-23T21:21:52.0599609+00:00" }, "job_status_id": "d835b7fd-669b-4ef5-a261-acfdff9631af", "job_status_code": "sample string 11", "db_address_id": "a6054509-36e1-4755-b808-36f0c07fa6d9", "contact_id": "169d7172-4cde-4bc7-b91a-c67e1fa16cfe", "requested_by_company_id": "86c1ed25-3a5f-4c5a-bc3f-2586d2028d2a", "requested_by_contact_id": "eb2b7a13-2948-483b-a506-3f84b5302fea", "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-03-23T21:21:52.0599609+00:00", "due_date": "2025-03-23T21:21:52.0599609+00:00", "date_create": "2025-03-23T21:21:52.0599609+00:00", "date_update": "2025-03-23T21:21:52.0599609+00:00", "date_closed": "2025-03-23T21:21:52.0599609+00:00", "suggested_user_id": "342ad215-2609-4f03-ab75-0115a3eef20c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "d461d9dd-3166-4302-9f75-6c1feffe08c4", "db_language_id": "417eeff8-a53e-4e16-ad5b-0ef46bcab51c", "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-03-23T21:21:52.0599609+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "f4501d05-97d7-4b42-ab22-7e6462c2b821", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "6031e2d0-4c8e-4510-ac71-a992ef2d2318", "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": "a4df3c4d-c36d-4230-9946-e3c26b784d36", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-23T21:21:52.0599609+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "6eecfa3b-ed69-4597-ae51-40dd687aa3db" }, "suggested_date_start": "2025-03-23T21:21:52.0599609+00:00", "skill_id": "136b9588-836c-402e-ac80-5c94da9e94e4", "skill_code": "sample string 32", "skill": { "id": "91c35f8d-57fd-438b-b049-d6e165b76b00", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a71904e4-d37d-4834-b414-7b8d9c0bd18d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0c755ca5-d9c1-4db3-bbea-1cff4240c728", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "03a27f42-5abb-4b92-a710-48b6f69c161a", "db_currency_id": "f0a16beb-4596-4b1b-998f-683e71d55435", "db_language_id": "cf854523-7186-43b2-9b2a-703ec170bbda", "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-03-23T21:21:52.0443369+00:00" }, "modified_dateutc": "2025-03-23T21:21:52.0599609+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "859a9399-0696-4c74-8e67-5de22eaf3185", "date_reported_by_company": "2025-03-23T21:21:52.0599609+00:00", "id2": 36, "company_id": "acd451fc-5063-4f8e-9613-6d24911377ad", "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": "d6e89e6c-f7f7-48db-b615-c2bbc846a017", "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-03-23T21:21:52.0599609+00:00" }