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": "9ac40ca6-104e-4dc4-a1fc-66d513b361da", "_parent_id": "d1ef4d96-13a8-4b4f-b584-ec3e604b9666", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "a93ba16f-3ed0-4158-93a7-7238bf319f99", "project_reference_back_office": "sample string 5", "project": { "id": "ee5c4384-d49b-4c1e-8368-7d1d89a15d63", "_parent_id": "63af8046-67f9-4bab-b491-9947589d974a", "root_parent_id": "ec2de980-9fba-4bba-9dda-a5cfa8c23acb", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "69c599d8-a033-469b-af97-e01ca71ce50b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "50cbc011-fe89-4380-9243-c19117ff48a0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "11b6dae5-2377-4a94-8d3d-6fd9a52acf1c", "_parent_code": "sample string 6", "sales_organization_id": "d81a1968-0c27-44e9-a29e-4e0f3eb5c2af", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02:00" }, "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00" }, "equipment_model_id": "e870a40d-dff5-4450-b0f7-d8d66f43a643", "equipment_model_code": "sample string 8", "equipment_model": { "id": "0d7d0308-73a1-4861-88f6-359c587bc7a4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "625872cd-a8d6-4eee-b3d8-006723e414fa", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "004b43fb-d281-4cba-a793-3637f41743cd", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "015319f3-f149-4721-82fa-00218fbfb3cb", "sales_organization_code": "sample string 5", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02:00" }, "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00" }, "equipment_family_id": "c30e5fdc-b69b-4594-aff0-af2afa421005", "equipment_family_code": "sample string 8", "equipment_family": { "id": "50cbc011-fe89-4380-9243-c19117ff48a0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "11b6dae5-2377-4a94-8d3d-6fd9a52acf1c", "_parent_code": "sample string 6", "sales_organization_id": "d81a1968-0c27-44e9-a29e-4e0f3eb5c2af", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02:00" }, "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00" }, "date_in_production_since": "2022-08-08T05:46:24.4040129+02:00", "date_out_of_production_since": "2022-08-08T05:46:24.4040129+02:00", "date_end_support": "2022-08-08T05:46:24.4040129+02:00", "sales_organization_id": "44183bc7-d787-44ea-a049-bb16b65b09dd", "sales_organization_code": "sample string 13", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02: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": "2022-08-08T05:46:24.4040129+02:00" }, "project_status_id": "05cfa1ba-9f38-4fd1-916c-bb344ede2bbf", "project_status_code": "sample string 10", "project_status": { "id": "43c1755c-a43d-4780-9559-d217daaf745e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "eda33647-0dab-4f3c-80ee-31cbdf57993b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02:00" }, "code": "sample string 7", "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00" }, "company_id": "ffad8d21-cc74-460a-b6bb-da5e8ffa4d29", "company_code": "sample string 12", "db_address_id": "45c70732-731f-43da-be67-4b0ea8620dab", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "0f63fed4-d3a7-4488-a39b-4fa5fbbf0403", "contact_reference_back_office": "sample string 17", "owner_user_id": "a95ae91d-a2cc-4492-a10e-fff5eaff3e37", "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": "2022-08-08T05:46:24.4040129+02:00", "date_create": "2022-08-08T05:46:24.4040129+02:00", "date_update": "2022-08-08T05:46:24.4040129+02:00", "updated_by_user_id": "ea9b9c47-dd2c-4cd1-b646-e667029bbf33", "customer_reference": "sample string 28", "warranty_date_until": "2022-08-08T05:46:24.4040129+02: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": "2022-08-08T00:00:00+02:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2022-08-08T05:46:24.4040129+02:00", "date_last_job": "2022-08-08T05:46:24.4040129+02:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2022-08-08T05:46:24.4040129+02:00", "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00", "is_mobile_installation": true }, "job_type_id": "2b947aef-2ee3-42ac-b318-f2cfebe48dcd", "job_type_code": "sample string 7", "job_type": { "id": "ea875a78-6d26-441e-a0b5-4338ad7af44b", "name": "sample string 2", "sales_organization_id": "6b9e82c0-be6c-4b92-8a7f-1ec73c0b2d4b", "description": "sample string 4", "is_default": true, "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00", "code": "sample string 7" }, "job_priority_id": "74554420-453d-4c16-a4a9-473e814ca661", "job_priority_code": "sample string 9", "job_priority": { "id": "63b831a2-d61c-41cc-a63a-b754e81acd55", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "fac6ee1e-4ae4-4f41-8795-de2fe6a955b6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02:00" }, "code": "sample string 7", "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00" }, "job_status_id": "f0c968c9-943e-4282-a3b8-062734fc4978", "job_status_code": "sample string 11", "db_address_id": "0de68d28-b4f3-48a7-ae3d-3f999843d1da", "contact_id": "4201f1a3-1e3f-4c9c-a547-20ad66b3c69c", "requested_by_company_id": "67a5cb40-0915-47e2-9be3-cd5feef846c6", "requested_by_contact_id": "a47737b1-8104-4da8-9f37-d481d3898c95", "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": "2022-08-08T05:46:24.4040129+02:00", "due_date": "2022-08-08T05:46:24.4040129+02:00", "date_create": "2022-08-08T05:46:24.4040129+02:00", "date_update": "2022-08-08T05:46:24.4040129+02:00", "date_closed": "2022-08-08T05:46:24.4040129+02:00", "suggested_user_id": "ad12599d-057d-4626-a529-2e77535775ea", "suggested_user_code": "sample string 29", "suggested_user": { "id": "ded71870-174c-4192-83b1-7762afc2632e", "db_language_id": "5d877874-53e5-4d4c-afd1-055c79b9a34e", "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": "2022-08-08T05:46:24.4040129+02:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "91f84021-b9e4-4485-82d1-f15ad7bc0674", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "a46392fd-853a-4e81-81d1-5f07f8f2ae3f", "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": "04b9e8b1-7299-44b8-a4ca-69bf2a3e7d0d", "private_db_country_code": "sample string 35", "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "fa253cbb-869b-4baa-ae4e-3edd9806078f" }, "suggested_date_start": "2022-08-08T05:46:24.4040129+02:00", "skill_id": "548dbb9f-5a7c-43d6-8824-786807f4542e", "skill_code": "sample string 32", "skill": { "id": "962a3427-d6c7-4d83-ad97-2c3c096e2bc0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "2469de25-8ba8-4a4c-a20d-b1dafb4b06f2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8b352ebc-d9ab-41a9-94f9-374b1fa11fdd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e6451226-60bd-4193-a1b8-1ccb4e20d7e1", "db_currency_id": "2ca3b656-fbac-40c3-b575-4225d1e3fa5b", "db_language_id": "8f8d076e-d3ed-4cd5-bd50-2844fa638c5f", "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": "2022-08-08T05:46:24.4040129+02:00" }, "modified_dateutc": "2022-08-08T05:46:24.4040129+02:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "27c03d12-207e-4ea4-a5c0-774b89c2b6c0", "date_reported_by_company": "2022-08-08T05:46:24.4040129+02:00", "id2": 36, "company_id": "7d494e24-fb11-4a91-b25b-7cacf4d82720", "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": "ba20d57c-4cec-409e-a10e-483bb4341a01", "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": "2022-08-08T05:46:24.4040129+02:00" }