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": "5b5817a3-223f-4347-95c3-1fa6eac88f39", "_parent_id": "ba643f4b-6957-4e20-8ddf-f39b981538d0", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "a7166a7f-dad6-4cad-b51c-e40a50d25d21", "project_reference_back_office": "sample string 5", "project": { "id": "8b89b0eb-b34b-479b-81cf-3ced74290419", "_parent_id": "b0115c5b-57ff-49cc-9d65-19b003236358", "root_parent_id": "82e67518-084a-48d7-9175-b58c854de283", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "4e85e26b-c1ac-41b6-8e2f-c788c2bd7e32", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e12341cd-40d4-41d2-bb09-93c55f77d2ae", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d90f3bec-6b2d-4c5e-a767-ae05b307430a", "_parent_code": "sample string 6", "sales_organization_id": "6de301c0-10e6-4b47-88f6-69c34cfba1dd", "sales_organization_code": "sample string 8", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+00:00" }, "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00" }, "equipment_model_id": "e4dcfe98-e6db-4952-90d7-69f4c5385beb", "equipment_model_code": "sample string 8", "equipment_model": { "id": "794ded1d-15a6-4cef-ba32-c6eae289ba19", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "a0fecbc3-8ed8-4db6-8df1-c79c3c27e9ab", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "3e3c0d0c-0ef1-4d97-aca6-92930d9d236f", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "b003580d-a0e2-4b61-924e-a48077bc7930", "sales_organization_code": "sample string 5", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+00:00" }, "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00" }, "equipment_family_id": "41c1ca78-058e-44e3-af1e-c984f10d3c95", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e12341cd-40d4-41d2-bb09-93c55f77d2ae", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d90f3bec-6b2d-4c5e-a767-ae05b307430a", "_parent_code": "sample string 6", "sales_organization_id": "6de301c0-10e6-4b47-88f6-69c34cfba1dd", "sales_organization_code": "sample string 8", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+00:00" }, "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00" }, "date_in_production_since": "2025-08-12T05:35:00.0536568+00:00", "date_out_of_production_since": "2025-08-12T05:35:00.0536568+00:00", "date_end_support": "2025-08-12T05:35:00.0536568+00:00", "sales_organization_id": "a47f777a-6175-4735-9986-4921f4ecc605", "sales_organization_code": "sample string 13", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+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-08-12T05:35:00.0536568+00:00" }, "project_status_id": "d2ea2391-90c6-44f4-b895-aa39e28d8c12", "project_status_code": "sample string 10", "project_status": { "id": "b4c1f8e2-54a3-45ca-b8a6-2823c8c9540f", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "d4069b9c-37ef-40e0-9212-6d3c0c38df90", "sales_organization_code": "sample string 6", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00" }, "company_id": "5f844a0c-dc2e-43bc-aa42-3679dd15c0a2", "company_code": "sample string 12", "db_address_id": "14f08122-d271-4712-b44b-a252c8f8b633", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "58a9955b-0562-460d-88af-bdce7f557d3e", "contact_reference_back_office": "sample string 17", "owner_user_id": "92bea412-ddd3-4281-8490-f1c25c5bc0f7", "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-08-12T05:35:00.0536568+00:00", "date_create": "2025-08-12T05:35:00.0536568+00:00", "date_update": "2025-08-12T05:35:00.0536568+00:00", "updated_by_user_id": "9a5597f3-a597-4ecb-8b0e-af627592cfd8", "customer_reference": "sample string 28", "warranty_date_until": "2025-08-12T05:35:00.0536568+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-08-12T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-08-12T05:35:00.0536568+00:00", "date_last_job": "2025-08-12T05:35:00.0536568+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-08-12T05:35:00.0536568+00:00", "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00", "is_mobile_installation": true }, "job_type_id": "734053ba-b509-4288-b16b-287dc00c850b", "job_type_code": "sample string 7", "job_type": { "id": "3f0541e0-6a54-477a-bf58-ca315e8bb350", "name": "sample string 2", "sales_organization_id": "c5d1e794-d16f-4eb2-a554-e09f1979679f", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00", "code": "sample string 7" }, "job_priority_id": "d54e4ef8-de96-44a4-9ba8-10fc4b5cf592", "job_priority_code": "sample string 9", "job_priority": { "id": "05bc3f14-a5f2-4d5f-b065-f1f7549c47f0", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "14b4f13b-de90-459d-8421-5e5a52e25f2c", "sales_organization_code": "sample string 6", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00" }, "job_status_id": "36a5334c-bf04-40a1-8215-63390224ea57", "job_status_code": "sample string 11", "db_address_id": "98b9e5b2-9a7e-44c7-b119-ea197fa2f0ea", "contact_id": "219dd9f8-a07a-400b-a566-bc083ef59784", "requested_by_company_id": "904d06f5-3285-42bc-bfa7-dd680f5c22d9", "requested_by_contact_id": "df8212d4-f297-4e71-b9a7-0199b77bcf44", "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-08-12T05:35:00.0536568+00:00", "due_date": "2025-08-12T05:35:00.0536568+00:00", "date_create": "2025-08-12T05:35:00.0536568+00:00", "date_update": "2025-08-12T05:35:00.0536568+00:00", "date_closed": "2025-08-12T05:35:00.0536568+00:00", "suggested_user_id": "8065ccff-6218-4590-ac4c-a5a0a83d446e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "cfe489e7-2441-4192-8f4a-75c5adf7103c", "db_language_id": "475e6c5c-83c6-4528-8655-7c7df97846b2", "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-08-12T05:35:00.0536568+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "3963b8f9-b914-4361-9ceb-c25aa872f719", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b148e1f8-07d4-457b-a618-3d5867132a81", "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": "e88d6b4f-71ba-4240-a766-96a26ebfb982", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "c86ef04f-4270-4106-868d-0a4558abd8ce" }, "suggested_date_start": "2025-08-12T05:35:00.0536568+00:00", "skill_id": "fc1037db-42f9-4062-b9fe-7f08e3ca6107", "skill_code": "sample string 32", "skill": { "id": "62b8ed9e-e6e4-4ed2-b554-165b37b77ee6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "1147b31b-d166-421e-8921-da6ca0fc9e84", "sales_organization_code": "sample string 6", "sales_organization": { "id": "93bb54f9-c7d2-4b04-83ef-6df109d40390", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a71959c8-b9cd-468c-8216-14f8b466ed3f", "db_currency_id": "0bc8dcb1-983d-4419-91e7-327061f84a71", "db_language_id": "0af56cdb-8d01-40a5-8f29-7989c5d57408", "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-08-12T05:35:00.0536568+00:00" }, "modified_dateutc": "2025-08-12T05:35:00.0536568+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "cc04063d-d464-467d-b685-87e6ebee70d5", "date_reported_by_company": "2025-08-12T05:35:00.0536568+00:00", "id2": 36, "company_id": "b0f7d4bf-d10d-4fa5-b023-b8ce83a13e19", "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": "094a389c-de5a-4204-9b64-219f02e2c4a3", "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-08-12T05:35:00.0536568+00:00" }