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": "2bc24556-bfe7-435b-a743-7d01fca00e8a", "_parent_id": "f6cc7ebf-9d5f-426e-96d9-ff5f5d69dc7c", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "9be878c8-a773-4ce3-82a9-ff2b7b0bb251", "project_reference_back_office": "sample string 5", "project": { "id": "28f9bc6e-808e-4993-902c-9bd350b44031", "_parent_id": "241439e4-15a1-47d7-9dbf-f57378166998", "root_parent_id": "fd829b35-07de-43fd-9312-0f7b67329aea", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "a6676fd6-05bd-46a2-b26a-21a59f8f167a", "equipment_family_code": "sample string 6", "equipment_family": { "id": "85defc79-b3b7-45ce-9a0f-9b1f67522f74", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "72f275f0-9474-4b8a-a5cc-ee46d0fd6ed6", "_parent_code": "sample string 6", "sales_organization_id": "53971f0d-3422-44be-8c5e-8fb0e1945cd6", "sales_organization_code": "sample string 8", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+00:00" }, "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00" }, "equipment_model_id": "f861f659-2132-440d-942f-1a781ac70bb6", "equipment_model_code": "sample string 8", "equipment_model": { "id": "302a4b2d-b403-4e1a-bc63-06419544bee5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "878dbc8d-7d2a-4ebf-920d-854c04cdfdf3", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a1e1ff71-66cf-44a7-af1f-15bb4f56fc50", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "958c85f5-5eb8-4f1b-8df4-84ee99db7851", "sales_organization_code": "sample string 5", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+00:00" }, "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00" }, "equipment_family_id": "6d7e38fc-1eba-4043-b9d2-ae9405a209ea", "equipment_family_code": "sample string 8", "equipment_family": { "id": "85defc79-b3b7-45ce-9a0f-9b1f67522f74", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "72f275f0-9474-4b8a-a5cc-ee46d0fd6ed6", "_parent_code": "sample string 6", "sales_organization_id": "53971f0d-3422-44be-8c5e-8fb0e1945cd6", "sales_organization_code": "sample string 8", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+00:00" }, "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00" }, "date_in_production_since": "2025-07-15T20:42:35.3652597+00:00", "date_out_of_production_since": "2025-07-15T20:42:35.3652597+00:00", "date_end_support": "2025-07-15T20:42:35.3652597+00:00", "sales_organization_id": "d963565a-6b21-4c87-8f59-d2909fd3aefc", "sales_organization_code": "sample string 13", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+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-07-15T20:42:35.3652597+00:00" }, "project_status_id": "014d9496-f7df-4c0b-83ab-2724262aec3d", "project_status_code": "sample string 10", "project_status": { "id": "389753ca-1c22-4960-86d1-c961e1ab567f", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "e965b695-4cd4-4a4a-8bde-de1e4b06a33d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00" }, "company_id": "b53040dd-f12a-48ff-b042-04a81d6de478", "company_code": "sample string 12", "db_address_id": "92452f2f-ddb0-4276-a88a-1e4a942379db", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "39ed2e4e-b6ec-4b97-8316-d5ddd43b8ecc", "contact_reference_back_office": "sample string 17", "owner_user_id": "60d088b1-7111-4fae-bdc4-6f6220bfc3c1", "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-07-15T20:42:35.3652597+00:00", "date_create": "2025-07-15T20:42:35.3652597+00:00", "date_update": "2025-07-15T20:42:35.3652597+00:00", "updated_by_user_id": "0173ef62-97d6-475e-98f4-9b76623ca146", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-15T20:42:35.3652597+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-07-15T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-15T20:42:35.3652597+00:00", "date_last_job": "2025-07-15T20:42:35.3652597+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-15T20:42:35.3652597+00:00", "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00", "is_mobile_installation": true }, "job_type_id": "199a09b4-d08a-44d3-9a2c-739a95336c1e", "job_type_code": "sample string 7", "job_type": { "id": "e11a4387-06a1-463e-a4fd-08d46013a6cc", "name": "sample string 2", "sales_organization_id": "9bd1a2c8-81f3-46bd-9f38-b11f741d97fd", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00", "code": "sample string 7" }, "job_priority_id": "30474526-f6e2-4493-bd65-035ed29fdfcb", "job_priority_code": "sample string 9", "job_priority": { "id": "57175cb0-a5ff-4b59-991e-6320f453f954", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "4452c364-e659-4eee-a1cb-ba976f2bc0af", "sales_organization_code": "sample string 6", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00" }, "job_status_id": "26e1667d-9538-42df-ac27-43f5545c37b2", "job_status_code": "sample string 11", "db_address_id": "f728f1b7-1738-4171-8bc5-3171bee1e960", "contact_id": "ae6b3c92-1374-4721-8ba8-d93c17185b0b", "requested_by_company_id": "39e3c89f-147d-4748-89ae-1285d36639c9", "requested_by_contact_id": "c1e35151-2050-4bae-a6e8-575808f1b55f", "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-07-15T20:42:35.3652597+00:00", "due_date": "2025-07-15T20:42:35.3652597+00:00", "date_create": "2025-07-15T20:42:35.3652597+00:00", "date_update": "2025-07-15T20:42:35.3652597+00:00", "date_closed": "2025-07-15T20:42:35.3652597+00:00", "suggested_user_id": "a07e9de7-5f71-4bc9-aebf-7774f3437eb1", "suggested_user_code": "sample string 29", "suggested_user": { "id": "db8b97e9-384a-40c9-8c81-09243ae16450", "db_language_id": "be2b314f-9539-45c3-a54a-520d7d4f2c8e", "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-07-15T20:42:35.3652597+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "9cd443be-219f-4714-be96-ece555f1374e", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "49e59ac5-e2e5-4ae8-825d-601d3a0bab81", "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": "1e060028-2459-4b81-9d5b-71e20287d30e", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "d6c7e363-b01a-4369-aa52-89dbbc02b52d" }, "suggested_date_start": "2025-07-15T20:42:35.3652597+00:00", "skill_id": "37e333a4-c88a-428a-b719-35453d729a7b", "skill_code": "sample string 32", "skill": { "id": "0ed5d673-acf9-4355-a3f6-63e3858cc294", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a1435135-f188-430b-bc9e-cb121f17666b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "29a1b838-30a6-484e-bf33-0c436098da25", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9503c1dd-6ea7-4e88-ad44-900fb74af5bc", "db_currency_id": "69125474-74e6-4547-91d4-4f8cee45909c", "db_language_id": "7e04013a-996e-48d6-9a76-d3934388172d", "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-07-15T20:42:35.3652597+00:00" }, "modified_dateutc": "2025-07-15T20:42:35.3652597+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "e8570f5c-40dd-40c6-93b8-62d424e67e02", "date_reported_by_company": "2025-07-15T20:42:35.3652597+00:00", "id2": 36, "company_id": "4e878d8a-1570-4a20-bdf1-398a13f006c2", "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": "de388571-feec-4450-bc2a-30acaec6eee5", "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-07-15T20:42:35.3652597+00:00" }