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": "6d08e260-7c74-4a33-a518-553999084418", "_parent_id": "2aa5c622-bcc4-428c-8f96-7fc59263ce0f", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "a0aca2e2-99c7-4e45-bd49-01c542296805", "project_reference_back_office": "sample string 5", "project": { "id": "5fbff8b1-c457-4f99-89ec-8b964f15086e", "_parent_id": "ad9e0cfb-c167-4a98-9668-1b9f9dc70fb4", "root_parent_id": "e3a6a438-106d-46a2-bc09-81ad12fea47f", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "29c196d1-2bb3-4bfe-9925-06e6918fc167", "equipment_family_code": "sample string 6", "equipment_family": { "id": "fcebf6aa-ba43-449a-9802-e1d0d057473e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f2797427-f31f-46f3-8f31-a64cb6e9b5e0", "_parent_code": "sample string 6", "sales_organization_id": "d84e1bbc-de49-4507-932a-861defc962fd", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+00:00" }, "modified_dateutc": "2025-04-24T23:34:30.0657148+00:00" }, "equipment_model_id": "f454217b-b281-442a-bb11-14c52ad89628", "equipment_model_code": "sample string 8", "equipment_model": { "id": "df4a6f93-9a12-4fe3-bbe1-68f581fae166", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "af9fcc7c-90de-40e9-8aaa-43c70fa97c94", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "401b5a9b-793c-474d-908f-fae94a21efd5", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7dc73b9e-cd8e-484a-8322-b34766bbc002", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+00:00" }, "modified_dateutc": "2025-04-24T23:34:30.0657148+00:00" }, "equipment_family_id": "cc0e91d4-1288-42d0-b776-ed840d5914d2", "equipment_family_code": "sample string 8", "equipment_family": { "id": "fcebf6aa-ba43-449a-9802-e1d0d057473e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f2797427-f31f-46f3-8f31-a64cb6e9b5e0", "_parent_code": "sample string 6", "sales_organization_id": "d84e1bbc-de49-4507-932a-861defc962fd", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+00:00" }, "modified_dateutc": "2025-04-24T23:34:30.0657148+00:00" }, "date_in_production_since": "2025-04-24T23:34:30.0657148+00:00", "date_out_of_production_since": "2025-04-24T23:34:30.0657148+00:00", "date_end_support": "2025-04-24T23:34:30.0657148+00:00", "sales_organization_id": "28af2ccf-ba8b-4c51-8e5b-1f24c4ac5c13", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+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-04-24T23:34:30.0813488+00:00" }, "project_status_id": "bac0360e-0e9e-468c-8a1f-2324faea4c44", "project_status_code": "sample string 10", "project_status": { "id": "e8402543-b01a-441b-82f0-fa3bbad42749", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "440c685b-0684-46a2-a866-a0b137536325", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-24T23:34:30.0813488+00:00" }, "company_id": "84c32f17-f306-4b8e-909f-7a6e33b92219", "company_code": "sample string 12", "db_address_id": "10a8c4ca-1d2c-45f9-bd40-1e4621c8b122", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "18564e75-37fb-4f2e-a08d-282cf187fe31", "contact_reference_back_office": "sample string 17", "owner_user_id": "819b7b9e-2f2f-41d5-99cb-2b6db755c2a7", "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-04-24T23:34:30.0813488+00:00", "date_create": "2025-04-24T23:34:30.0813488+00:00", "date_update": "2025-04-24T23:34:30.0813488+00:00", "updated_by_user_id": "639ce46a-92e5-4f4e-81d4-5cfec1754923", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-24T23:34:30.0813488+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-04-24T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-24T23:34:30.0813488+00:00", "date_last_job": "2025-04-24T23:34:30.0813488+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-24T23:34:30.0813488+00:00", "modified_dateutc": "2025-04-24T23:34:30.0813488+00:00", "is_mobile_installation": true }, "job_type_id": "4c4ac2f7-4902-4e37-b5cf-bad045b3dcf9", "job_type_code": "sample string 7", "job_type": { "id": "94c6176c-56e1-4b51-be61-cdc53d78c3b9", "name": "sample string 2", "sales_organization_id": "17e5af6e-d644-40df-b55b-a9d88a8dc26a", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-24T23:34:30.0813488+00:00", "code": "sample string 7" }, "job_priority_id": "6883ecda-ae02-41f7-b44a-4b4f685cc0f5", "job_priority_code": "sample string 9", "job_priority": { "id": "98769e94-1a2a-4c74-a850-e5f8876334a0", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "22e51733-ac72-4eab-9de3-edbb18b1a8e1", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-24T23:34:30.0813488+00:00" }, "job_status_id": "47421e03-6964-467d-b80a-665fea6875e2", "job_status_code": "sample string 11", "db_address_id": "1a7ef830-daf3-4a70-924e-84a6158aa5f8", "contact_id": "fd235bc4-1381-4619-b97f-332396882a7d", "requested_by_company_id": "4b93a0b7-a68c-4e5d-bfb8-0232954f780b", "requested_by_contact_id": "de8fcca5-4a31-4053-8824-cf7a437e09da", "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-04-24T23:34:30.0813488+00:00", "due_date": "2025-04-24T23:34:30.0813488+00:00", "date_create": "2025-04-24T23:34:30.0813488+00:00", "date_update": "2025-04-24T23:34:30.0813488+00:00", "date_closed": "2025-04-24T23:34:30.0813488+00:00", "suggested_user_id": "c6225c1b-7b2e-476f-a190-4407c4fc1cbf", "suggested_user_code": "sample string 29", "suggested_user": { "id": "193b9931-dc7d-44b3-8f90-6dc3171518d8", "db_language_id": "14100fea-6020-49be-ba59-15e861ecfae2", "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-04-24T23:34:30.0813488+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "471d090f-e77c-4268-8a9f-fd9b27d3c097", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "3ee35e24-5618-4435-85b6-9deee9517b54", "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": "781537d4-97f1-4a7f-9219-3892d0521fb6", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-24T23:34:30.0813488+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "0e681a71-17fa-46f6-9fb8-327614472243" }, "suggested_date_start": "2025-04-24T23:34:30.0813488+00:00", "skill_id": "8a3e1494-3fc0-46f3-9a27-05caa2fe6cf9", "skill_code": "sample string 32", "skill": { "id": "0a2758b3-2465-469e-bdd7-994b6ab1844f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "8c1a3780-ee0b-48ea-af5d-cc44976ae253", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1930ccbb-d94b-4d1c-b864-54112fa630c2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a7c17c39-c2d1-4ab9-8eb5-6bce29debd8b", "db_currency_id": "e66fdde8-608c-4332-af25-913813193f03", "db_language_id": "1348b364-3a12-418a-8ae0-951339a53de3", "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-04-24T23:34:30.0657148+00:00" }, "modified_dateutc": "2025-04-24T23:34:30.0813488+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "25bc317e-9ab5-4152-8d72-c0d31207dab1", "date_reported_by_company": "2025-04-24T23:34:30.0813488+00:00", "id2": 36, "company_id": "4367fe13-a133-4f9d-8447-fb96d7002663", "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": "e11a073b-1848-45d7-8e8f-33e098b621b6", "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-04-24T23:34:30.0813488+00:00" }