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": "c6f3ae51-8a2b-43d9-ab12-4141f8fb20bb", "_parent_id": "9f255905-66e6-42df-8b6b-f85fe1cfc419", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "ebde9fd3-e31d-4093-950e-51ce546ca92b", "project_reference_back_office": "sample string 5", "project": { "id": "0434b227-b4b2-4a3f-b767-2e9127856f26", "_parent_id": "03353ef8-7ff4-474f-a53b-64691de878b0", "root_parent_id": "9dae1159-b67f-4da6-aae5-091abab85716", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "803e3be0-ff5f-418a-8f0e-4635302c1bbe", "equipment_family_code": "sample string 6", "equipment_family": { "id": "85c840b1-a989-447b-a466-556b746069cc", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "98781865-a5ca-4aba-aa6a-d886097533f1", "_parent_code": "sample string 6", "sales_organization_id": "850dbfd5-5baf-4b79-8a46-61331e98a9b8", "sales_organization_code": "sample string 8", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+00:00" }, "modified_dateutc": "2025-01-25T07:17:24.3397666+00:00" }, "equipment_model_id": "b0e438e6-383f-45c3-a1db-f9701d6dadba", "equipment_model_code": "sample string 8", "equipment_model": { "id": "a7193e7a-6a96-4c3c-9d3a-6fbac76b1b56", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "213ff11e-875e-48fb-a3d1-36d85c0fcec6", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "406c1efd-d199-47ee-bccc-0f5b57103071", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7b81e86e-3148-4c30-8451-52f6ade99502", "sales_organization_code": "sample string 5", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+00:00" }, "modified_dateutc": "2025-01-25T07:17:24.3397666+00:00" }, "equipment_family_id": "4b748b55-b06c-4e05-b66b-708307f04709", "equipment_family_code": "sample string 8", "equipment_family": { "id": "85c840b1-a989-447b-a466-556b746069cc", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "98781865-a5ca-4aba-aa6a-d886097533f1", "_parent_code": "sample string 6", "sales_organization_id": "850dbfd5-5baf-4b79-8a46-61331e98a9b8", "sales_organization_code": "sample string 8", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+00:00" }, "modified_dateutc": "2025-01-25T07:17:24.3397666+00:00" }, "date_in_production_since": "2025-01-25T07:17:24.3397666+00:00", "date_out_of_production_since": "2025-01-25T07:17:24.3397666+00:00", "date_end_support": "2025-01-25T07:17:24.3397666+00:00", "sales_organization_id": "44e2c52e-c659-4c72-b332-4dca60edcf9e", "sales_organization_code": "sample string 13", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+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-01-25T07:17:24.3553934+00:00" }, "project_status_id": "662c85b6-88ce-40bb-895c-c36c1079365a", "project_status_code": "sample string 10", "project_status": { "id": "238d740d-1ec2-4216-a811-638ce761b452", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "474576cf-de70-4d3f-ba4d-7de30a6aa86b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-25T07:17:24.3553934+00:00" }, "company_id": "9a3120bd-b0ff-4133-9fe9-4461a7dc121b", "company_code": "sample string 12", "db_address_id": "39fc36c8-ed7a-4bd6-8c89-68a8e9f50e9d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "2a806a86-30e3-4140-9edf-06b052b54b16", "contact_reference_back_office": "sample string 17", "owner_user_id": "7bf42642-1aba-48f7-b8b2-2967adcafd16", "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-01-25T07:17:24.3553934+00:00", "date_create": "2025-01-25T07:17:24.3553934+00:00", "date_update": "2025-01-25T07:17:24.3553934+00:00", "updated_by_user_id": "69ced7ee-051c-41c7-99f1-cac8e1ad0f78", "customer_reference": "sample string 28", "warranty_date_until": "2025-01-25T07:17:24.3553934+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-01-25T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-01-25T07:17:24.3553934+00:00", "date_last_job": "2025-01-25T07:17:24.3553934+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-01-25T07:17:24.3553934+00:00", "modified_dateutc": "2025-01-25T07:17:24.3553934+00:00", "is_mobile_installation": true }, "job_type_id": "32ba128d-c454-4e1b-83e7-f3f898aabf15", "job_type_code": "sample string 7", "job_type": { "id": "9ce9dbcc-9968-425f-a5fa-807772abdd74", "name": "sample string 2", "sales_organization_id": "321cbbe9-f491-4e56-a121-5f1178784d45", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-01-25T07:17:24.3553934+00:00", "code": "sample string 7" }, "job_priority_id": "84f7345c-6de3-47d8-9115-ac8a369ba5dc", "job_priority_code": "sample string 9", "job_priority": { "id": "c8d494c6-1b25-48d9-97d8-c154c9811558", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "b2bb7858-8e7f-4306-af14-0438f0de4302", "sales_organization_code": "sample string 6", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-25T07:17:24.3553934+00:00" }, "job_status_id": "9b6573f3-130d-4dba-b2af-23b1b1279bdd", "job_status_code": "sample string 11", "db_address_id": "e3870dfd-9c02-41dc-830a-e073cf9be4ab", "contact_id": "d92b2801-e3bc-4223-9c88-b81faf4feafc", "requested_by_company_id": "bcc94477-80b0-436f-b3ed-530c22dedec4", "requested_by_contact_id": "d1f758fd-48a3-4919-b065-3eec1978b011", "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-01-25T07:17:24.3553934+00:00", "due_date": "2025-01-25T07:17:24.3553934+00:00", "date_create": "2025-01-25T07:17:24.3553934+00:00", "date_update": "2025-01-25T07:17:24.3553934+00:00", "date_closed": "2025-01-25T07:17:24.3553934+00:00", "suggested_user_id": "e7eab8b5-ad89-4f2d-accd-78770170ad8f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "44bffc30-578b-4cbc-b8be-c0ffd85d59f5", "db_language_id": "99eb51aa-2616-4ab6-96a9-52949e1180e6", "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-01-25T07:17:24.3553934+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "d72fe19b-07e8-477b-81ce-0457d0b85c09", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "6f893e60-68ed-4c3f-855a-b7a4e0089787", "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": "b264ece6-6cd7-4ae1-b0e6-8d22b367ff22", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-01-25T07:17:24.3553934+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "dacacdec-9eac-41f6-9008-6e29ab2885d1" }, "suggested_date_start": "2025-01-25T07:17:24.3553934+00:00", "skill_id": "ebeb3c4d-fb88-4961-81f8-96167befaa19", "skill_code": "sample string 32", "skill": { "id": "3bc690c2-01eb-4e9f-8f29-b2011cb11f0e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "20ccec2e-ea38-4fde-965c-73b1dbe21b0e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "46f69807-00f5-418a-bfd2-0d3fa279201a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ee346785-645c-4554-b6eb-895ce3b36273", "db_currency_id": "62536737-f7ad-460e-b191-ed77e404ef63", "db_language_id": "d0a2c9d8-37e8-4735-aaeb-f2032aaf7f60", "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-01-25T07:17:24.3397666+00:00" }, "modified_dateutc": "2025-01-25T07:17:24.3553934+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "82de0e00-d6ab-41a0-bb55-d9a1537223bb", "date_reported_by_company": "2025-01-25T07:17:24.3553934+00:00", "id2": 36, "company_id": "e1c41e1d-12a5-4fa5-9a8e-01a1eb10c7e4", "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": "de2aa5bd-10a1-4c33-94d5-56d64c6d9ffc", "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-01-25T07:17:24.3553934+00:00" }