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": "7696db39-ab53-46c2-9b87-c935336a3f74", "_parent_id": "4a2a1a7f-5ca3-4094-869a-3d32c4e7d74c", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "1afad59e-1dba-4bcc-aa6a-a26cc0ee85e4", "project_reference_back_office": "sample string 5", "project": { "id": "20e26af5-860d-455d-a7bd-7913412a742f", "_parent_id": "60ec0b1e-f72f-465b-aba8-167e260c3469", "root_parent_id": "c5d63303-8535-4336-a155-fa30e7b3f718", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "2581a827-e283-4b1f-bf82-8cd421c03b93", "equipment_family_code": "sample string 6", "equipment_family": { "id": "be1b10b2-15f9-4b7b-a247-ac37525c7acb", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bc9794ef-f676-427d-9c7e-6d4e51cf7a10", "_parent_code": "sample string 6", "sales_organization_id": "f54566df-f442-429b-85b6-775438365c7e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+00:00" }, "modified_dateutc": "2024-03-29T06:25:56.2476628+00:00" }, "equipment_model_id": "9c0de6a3-83d8-4dae-94a0-bd61900330b8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "5fbbc5ae-51a0-4401-b5f4-44625e4e63cb", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "3baccaf6-d9ac-4bd4-9137-27f2ab18790d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "36dd28d3-fbaa-4a32-93ac-1dfe83f77316", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "6706c229-74cf-4854-b779-5530c97fbfdd", "sales_organization_code": "sample string 5", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+00:00" }, "modified_dateutc": "2024-03-29T06:25:56.2476628+00:00" }, "equipment_family_id": "1900a44b-9eba-421c-87fc-652c6a6dcd90", "equipment_family_code": "sample string 8", "equipment_family": { "id": "be1b10b2-15f9-4b7b-a247-ac37525c7acb", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bc9794ef-f676-427d-9c7e-6d4e51cf7a10", "_parent_code": "sample string 6", "sales_organization_id": "f54566df-f442-429b-85b6-775438365c7e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+00:00" }, "modified_dateutc": "2024-03-29T06:25:56.2476628+00:00" }, "date_in_production_since": "2024-03-29T06:25:56.2476628+00:00", "date_out_of_production_since": "2024-03-29T06:25:56.2476628+00:00", "date_end_support": "2024-03-29T06:25:56.2476628+00:00", "sales_organization_id": "a77b6c64-bcaa-46e3-8bb1-e45140a3b41f", "sales_organization_code": "sample string 13", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+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": "2024-03-29T06:25:56.2476628+00:00" }, "project_status_id": "5be307b4-7fa0-4d4b-b0da-b895573147f5", "project_status_code": "sample string 10", "project_status": { "id": "cfc5e4a1-7d0c-485c-a1c6-05feae4b0452", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "be8429a9-4f9c-48ae-bb42-7fde506f2403", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-29T06:25:56.2476628+00:00" }, "company_id": "b9a14139-6819-454c-809e-6af9e2e6ab8d", "company_code": "sample string 12", "db_address_id": "ac73928e-051f-4f97-ab7f-d1751a225970", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "ea983591-123a-4d39-9986-27a0e2b8cc9c", "contact_reference_back_office": "sample string 17", "owner_user_id": "2648d386-2805-44d0-bfc8-1ac42e2170dd", "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": "2024-03-29T06:25:56.2476628+00:00", "date_create": "2024-03-29T06:25:56.2476628+00:00", "date_update": "2024-03-29T06:25:56.2476628+00:00", "updated_by_user_id": "3dc2643e-ff99-4968-a0c4-9fa3e15022c2", "customer_reference": "sample string 28", "warranty_date_until": "2024-03-29T06:25:56.2476628+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": "2024-03-29T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-03-29T06:25:56.2632894+00:00", "date_last_job": "2024-03-29T06:25:56.2632894+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-03-29T06:25:56.2632894+00:00", "modified_dateutc": "2024-03-29T06:25:56.2632894+00:00", "is_mobile_installation": true }, "job_type_id": "aed0c200-a4ed-438c-9dd9-a2fdc1da55a6", "job_type_code": "sample string 7", "job_type": { "id": "8a69ff25-3fd0-41ea-8107-e53564582242", "name": "sample string 2", "sales_organization_id": "9513a1e6-6d0f-4e95-b21d-6c0e504f8f33", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-03-29T06:25:56.2632894+00:00", "code": "sample string 7" }, "job_priority_id": "11c5bd1e-3899-4c8d-b5b6-59b85f9100c1", "job_priority_code": "sample string 9", "job_priority": { "id": "b93e7228-9457-47c5-9539-47b41e379a79", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "64a56202-a906-40f6-a5fc-ef044d9f6bd4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-29T06:25:56.2632894+00:00" }, "job_status_id": "a400b9f2-5e06-4159-9322-ae51d23335ca", "job_status_code": "sample string 11", "db_address_id": "1a5685af-87ee-4998-94ed-209bdd2df202", "contact_id": "cc8ba64a-aa3a-4c50-9def-b55e633dc4c9", "requested_by_company_id": "c5bb62be-008f-4981-b5e1-a54924757990", "requested_by_contact_id": "3e628a27-e70e-4f8a-b069-7456f2ee690c", "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": "2024-03-29T06:25:56.2632894+00:00", "due_date": "2024-03-29T06:25:56.2632894+00:00", "date_create": "2024-03-29T06:25:56.2632894+00:00", "date_update": "2024-03-29T06:25:56.2632894+00:00", "date_closed": "2024-03-29T06:25:56.2632894+00:00", "suggested_user_id": "eb5c801f-31f7-481e-95d3-5056b863a223", "suggested_user_code": "sample string 29", "suggested_user": { "id": "cc41f310-1d46-4a2c-80b3-1cac09646d5d", "db_language_id": "bffe5a05-0ffe-4740-9cd2-72b3dd32e7c1", "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": "2024-03-29T06:25:56.2632894+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "04716852-1475-45f8-b4ca-5219b1c34e48", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "1b6a2ea9-e048-469f-8b10-553b79ad43a5", "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": "0eedf32f-71fe-4d1f-b73f-bc86600fad49", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-03-29T06:25:56.2632894+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "af5587a2-9f68-4b96-8bed-2a906aeb7078" }, "suggested_date_start": "2024-03-29T06:25:56.2632894+00:00", "skill_id": "02ac3d13-178a-4b46-82f8-d815bfd87b2f", "skill_code": "sample string 32", "skill": { "id": "9cab5327-c037-46e2-be99-38d4df100026", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e08496bf-7b8d-4ec2-8793-d5e2fbb9038d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "e9e375f3-6b38-4944-ba83-dac4e85fde96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3f1f2df7-33d4-4655-a906-ccfc532cccd9", "db_currency_id": "ea761837-d6fe-4ee3-a61d-72e4c47b711d", "db_language_id": "db0cf5c9-13f9-4f6f-9a70-6aa9079d1bbe", "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": "2024-03-29T06:25:56.2476628+00:00" }, "modified_dateutc": "2024-03-29T06:25:56.2632894+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "1dd7926d-fe24-4c28-8819-70fb5f775486", "date_reported_by_company": "2024-03-29T06:25:56.2632894+00:00", "id2": 36, "company_id": "233f962a-3d8a-4b05-ae8d-fdf91bdf48f3", "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": "a35e73d4-58b1-4c72-bab7-8d4085d76a43", "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": "2024-03-29T06:25:56.2632894+00:00" }