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": "ef8c8887-6526-42b8-87a8-d5354d28da05", "_parent_id": "fba3df0a-58d5-4f65-bf3b-1038019c611a", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "26b76268-2cf3-4b56-be11-207d5ff359d1", "project_reference_back_office": "sample string 5", "project": { "id": "381c3c2a-4833-494f-94a6-c9aed9f13340", "_parent_id": "1163915d-30a4-4ecc-bdea-fb18945e8669", "root_parent_id": "d832f994-e046-4ddb-b3ad-8adcb2bdde07", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "dfc800a4-3178-48d1-ad6b-a679561d3b1d", "equipment_family_code": "sample string 6", "equipment_family": { "id": "35640702-b157-490b-a384-142972de9df0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7ddd9c44-c4e1-4a91-91b4-d641a7cfb597", "_parent_code": "sample string 6", "sales_organization_id": "b33c9171-8d39-4cd7-a2ae-4a02559ba21d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+00:00" }, "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00" }, "equipment_model_id": "0e6bb2e5-a2e9-4e87-9547-2cbaaf0541df", "equipment_model_code": "sample string 8", "equipment_model": { "id": "2c77bd0b-562b-4d95-b346-515565373de9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "aa67c8a5-575c-45e7-9b74-4d550eeb97aa", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "75e1ea13-cb7e-43ce-ae36-c51088374dd4", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "a163f1ba-8a0d-4bff-8012-b6e3f8214373", "sales_organization_code": "sample string 5", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+00:00" }, "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00" }, "equipment_family_id": "43d1ac69-5713-4add-a24d-a6b36398ac03", "equipment_family_code": "sample string 8", "equipment_family": { "id": "35640702-b157-490b-a384-142972de9df0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7ddd9c44-c4e1-4a91-91b4-d641a7cfb597", "_parent_code": "sample string 6", "sales_organization_id": "b33c9171-8d39-4cd7-a2ae-4a02559ba21d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+00:00" }, "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00" }, "date_in_production_since": "2024-11-20T13:16:22.1540831+00:00", "date_out_of_production_since": "2024-11-20T13:16:22.1540831+00:00", "date_end_support": "2024-11-20T13:16:22.1540831+00:00", "sales_organization_id": "ba07d6da-cf03-4b22-8c90-47c26676c710", "sales_organization_code": "sample string 13", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+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-11-20T13:16:22.1540831+00:00" }, "project_status_id": "8c9990df-bea3-47bb-804f-f4114a14e99b", "project_status_code": "sample string 10", "project_status": { "id": "0b05cd12-ff87-425d-942d-132d14fb3c61", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "1b70dfb6-a267-4a01-a742-ae90ed57ba6e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00" }, "company_id": "53e55e84-d637-429d-b587-9c48b3a2057b", "company_code": "sample string 12", "db_address_id": "8acfc5ba-be70-4b20-98c6-97848bb2d5aa", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "f1f328a8-41c3-4309-867c-42c04f03005a", "contact_reference_back_office": "sample string 17", "owner_user_id": "6aea2297-a115-488e-95e0-263d13f29827", "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-11-20T13:16:22.1540831+00:00", "date_create": "2024-11-20T13:16:22.1540831+00:00", "date_update": "2024-11-20T13:16:22.1540831+00:00", "updated_by_user_id": "b143fbdb-6850-4a6f-a22b-2a72943a7438", "customer_reference": "sample string 28", "warranty_date_until": "2024-11-20T13:16:22.1540831+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-11-20T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-11-20T13:16:22.1540831+00:00", "date_last_job": "2024-11-20T13:16:22.1540831+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-11-20T13:16:22.1540831+00:00", "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00", "is_mobile_installation": true }, "job_type_id": "b278cf6c-f353-4420-b3c5-096c1b5d53c9", "job_type_code": "sample string 7", "job_type": { "id": "7c05976b-df0b-4616-ba32-29897ddf5858", "name": "sample string 2", "sales_organization_id": "3dd74b10-e943-4458-b066-02392433562b", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00", "code": "sample string 7" }, "job_priority_id": "b0e4cf32-8230-4e99-81c1-0b0cd0a04e88", "job_priority_code": "sample string 9", "job_priority": { "id": "c7f1010f-3a5c-483b-b43a-3d0067fea8a6", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "56109a7c-7c34-443c-b869-948ea966ae62", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00" }, "job_status_id": "8f037c4a-7320-430a-a22c-b798efcc82a7", "job_status_code": "sample string 11", "db_address_id": "03668d7b-6b28-4e8b-823e-ad44d75ddcd9", "contact_id": "7da15cec-4700-4e94-9291-afb4d4e2e914", "requested_by_company_id": "fc427977-7469-4b8c-a2a7-05b9eeefbd02", "requested_by_contact_id": "a44b2a54-44cb-4b7e-9c54-c0bf9910bbaa", "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-11-20T13:16:22.1540831+00:00", "due_date": "2024-11-20T13:16:22.1540831+00:00", "date_create": "2024-11-20T13:16:22.1540831+00:00", "date_update": "2024-11-20T13:16:22.1540831+00:00", "date_closed": "2024-11-20T13:16:22.1540831+00:00", "suggested_user_id": "9494564c-5c4b-4f2d-84e6-5ef7b6cf6c83", "suggested_user_code": "sample string 29", "suggested_user": { "id": "d8f4fb1c-3b13-4e00-ab6a-46b44c873e51", "db_language_id": "48d608e6-dc94-41a4-8b5f-fdf2a461c282", "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-11-20T13:16:22.1540831+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "d9470152-1227-4b0c-9c35-6b5a450785c7", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "439262bd-1048-41ba-a24c-657556833b77", "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": "ee62b942-4d12-4a7f-b4b5-7b54c5cf9997", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "7764ef53-e7ff-44d6-a25c-64a80a44b500" }, "suggested_date_start": "2024-11-20T13:16:22.1540831+00:00", "skill_id": "6951c0f2-d4a2-49c2-a980-2f769abfb5e1", "skill_code": "sample string 32", "skill": { "id": "14607fc6-00e8-491e-97b6-adb77ff02ccf", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "43d818ef-e0dd-4484-935e-1a3c0751d2ec", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0a1aadc6-ab3d-4f12-8255-caa28748fa57", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "cf358caf-0e9a-4831-8682-bb3092ac5d09", "db_currency_id": "65e3cd53-87f4-4772-a65e-4463a1509c05", "db_language_id": "574a0d41-45ab-45ef-9e51-89d973dc098c", "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-11-20T13:16:22.1540831+00:00" }, "modified_dateutc": "2024-11-20T13:16:22.1540831+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "0ece11ee-6ef8-4aa7-8088-70e0274e7a62", "date_reported_by_company": "2024-11-20T13:16:22.1540831+00:00", "id2": 36, "company_id": "0981b840-5b7a-4b69-bcc7-747706f9827e", "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": "6a3820b7-cc1b-4b0d-9a1f-edc11f105c10", "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-11-20T13:16:22.1540831+00:00" }