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": "f8549efd-b571-49c3-a494-fc4c018f57f4", "_parent_id": "15c0ef3d-d77b-40cb-b123-85d31fa08a3a", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "a3432e12-e71f-461d-a0f5-f7d64e8f9960", "project_reference_back_office": "sample string 5", "project": { "id": "a1bdf807-0f96-4ce2-a85f-fce91fdaa4a1", "_parent_id": "0ff3ce81-4365-426e-be06-1e059dfb1b48", "root_parent_id": "53ead769-9797-44ae-9b61-8b5e0e9fed9c", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "17ed1025-504f-4029-bca4-750eb9d1c2f3", "equipment_family_code": "sample string 6", "equipment_family": { "id": "0559c477-351c-4a3e-af42-01d8d7173649", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "26e4c690-9483-417a-bde3-60d92706b7b8", "_parent_code": "sample string 6", "sales_organization_id": "ca3847aa-1f4d-4ac0-a013-435dcbefc05b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+00:00" }, "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00" }, "equipment_model_id": "fda5b6a3-4f58-4fd1-9111-3d9d87a3ac1f", "equipment_model_code": "sample string 8", "equipment_model": { "id": "dbc063aa-2d5a-459b-aab7-0b1bb687e0c9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "a232d5f5-ed69-4944-a253-17e9ee214edc", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "ae780015-cb2e-4d2d-a7ad-b47d21fc167f", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "6143a46e-3458-4080-9693-1b13d09a1305", "sales_organization_code": "sample string 5", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+00:00" }, "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00" }, "equipment_family_id": "ff5fdae0-0d3c-4029-a78b-5d9ad6a6ff9b", "equipment_family_code": "sample string 8", "equipment_family": { "id": "0559c477-351c-4a3e-af42-01d8d7173649", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "26e4c690-9483-417a-bde3-60d92706b7b8", "_parent_code": "sample string 6", "sales_organization_id": "ca3847aa-1f4d-4ac0-a013-435dcbefc05b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+00:00" }, "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00" }, "date_in_production_since": "2025-02-19T08:33:30.6724471+00:00", "date_out_of_production_since": "2025-02-19T08:33:30.6724471+00:00", "date_end_support": "2025-02-19T08:33:30.6724471+00:00", "sales_organization_id": "af715527-2f7a-4d4b-acc8-13e940a62f0d", "sales_organization_code": "sample string 13", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+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-02-19T08:33:30.6724471+00:00" }, "project_status_id": "09c95197-eb86-4860-8bf8-b4eebb3a4644", "project_status_code": "sample string 10", "project_status": { "id": "277f2122-ae6d-40c0-89b7-5f9b34365d7a", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "f097fa11-1305-46e2-9a7e-63c28bf4be59", "sales_organization_code": "sample string 6", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00" }, "company_id": "d33a0dc9-9fa3-455f-b5c3-23b28dfb8a5b", "company_code": "sample string 12", "db_address_id": "cb24dc9d-c465-456a-9a87-185efe1fcb68", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "38f9ce81-6d72-4a89-b0ac-60400ae66db5", "contact_reference_back_office": "sample string 17", "owner_user_id": "762bf465-eaf5-4cb9-8242-6b802a3669bf", "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-02-19T08:33:30.6724471+00:00", "date_create": "2025-02-19T08:33:30.6724471+00:00", "date_update": "2025-02-19T08:33:30.6724471+00:00", "updated_by_user_id": "d42e2f5e-f964-4e1e-9a9a-5e75865822a1", "customer_reference": "sample string 28", "warranty_date_until": "2025-02-19T08:33:30.6724471+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-02-19T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-02-19T08:33:30.6724471+00:00", "date_last_job": "2025-02-19T08:33:30.6724471+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-02-19T08:33:30.6724471+00:00", "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00", "is_mobile_installation": true }, "job_type_id": "2c4c9b6a-70cf-4b41-b2ca-525eec78c596", "job_type_code": "sample string 7", "job_type": { "id": "6f57342e-eb01-48f3-9f4f-783738269723", "name": "sample string 2", "sales_organization_id": "264b2401-e999-45e5-a992-0d7721826034", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00", "code": "sample string 7" }, "job_priority_id": "ce870c99-0506-4464-8369-31ad55d38acb", "job_priority_code": "sample string 9", "job_priority": { "id": "2b29ea47-ed0f-4a05-b215-cfce17e4346a", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "c3dbed38-ce51-4e50-a609-ce966999249f", "sales_organization_code": "sample string 6", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00" }, "job_status_id": "d831751b-5ed1-4cca-8588-3ebd8d44287c", "job_status_code": "sample string 11", "db_address_id": "e809451c-e1df-434e-b7cf-643e1d2281ec", "contact_id": "be800483-7b23-4249-b36b-15c487c152a0", "requested_by_company_id": "fe0b6ad6-ff78-4e69-a4f5-bde45bb7dbaf", "requested_by_contact_id": "9bcba5b3-3ec4-496a-9605-86c79de0a67c", "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-02-19T08:33:30.6724471+00:00", "due_date": "2025-02-19T08:33:30.6724471+00:00", "date_create": "2025-02-19T08:33:30.6724471+00:00", "date_update": "2025-02-19T08:33:30.6724471+00:00", "date_closed": "2025-02-19T08:33:30.6724471+00:00", "suggested_user_id": "514320c6-b5a1-4467-a60a-c0279d24b382", "suggested_user_code": "sample string 29", "suggested_user": { "id": "afddc303-ef93-49bd-871c-6d0286ac1ed4", "db_language_id": "dab03b7c-8b85-455c-bcbe-c42479a4a8b2", "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-02-19T08:33:30.6724471+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "2a624a0d-cbc6-4037-b7d6-af4a1f610ce8", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "c648ee10-a920-43c5-bd6f-363de023f155", "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": "53ea1a26-93ae-48ff-8078-2b1ef4db8570", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "e5072990-194c-4b59-b841-8fdb52c2c462" }, "suggested_date_start": "2025-02-19T08:33:30.6724471+00:00", "skill_id": "f9f8e54e-c8c6-4f71-9d55-5f5b0cf9b198", "skill_code": "sample string 32", "skill": { "id": "e662a2c9-1652-4c64-9860-2c4907cf5efc", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "70347c90-f471-472c-a0c2-31b1f25b2749", "sales_organization_code": "sample string 6", "sales_organization": { "id": "97e0a937-de88-4eec-bab5-719e5770c73d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b7356105-248f-4f24-aede-f2b030f0d018", "db_currency_id": "0d893d71-ddbb-4b02-9972-3653f3c2fc07", "db_language_id": "fd51d561-6c47-4b4b-9a52-7ff47edac443", "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-02-19T08:33:30.6724471+00:00" }, "modified_dateutc": "2025-02-19T08:33:30.6724471+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "c7f5e4f7-231c-47d6-8593-817d0c72ffed", "date_reported_by_company": "2025-02-19T08:33:30.6724471+00:00", "id2": 36, "company_id": "195b1cea-ac7e-4a4a-8831-b0b5fdf27c51", "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": "e84bec24-3d8f-45e0-a153-e6a5ee902778", "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-02-19T08:33:30.6724471+00:00" }