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": "dfab7245-2917-4186-8c8a-75970ab088f8", "_parent_id": "e372e7c3-949f-41b8-b87c-eb5e4db42dd5", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3ce244e9-dfe5-4023-b929-ff00ed0d43af", "project_reference_back_office": "sample string 5", "project": { "id": "a1bc33fc-9ed4-49dc-aeb2-3560ca424b4b", "_parent_id": "d5bf2876-dc30-4544-b530-ac975089c8ba", "root_parent_id": "db4f23d2-77e1-4ba4-862d-1b6a9dc42209", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "1f07f330-678f-4ffe-8700-812a20f8449c", "equipment_family_code": "sample string 6", "equipment_family": { "id": "efc933ea-39aa-454b-831e-de0619c484e0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "fac41970-1047-4118-a626-d26973f2f719", "_parent_code": "sample string 6", "sales_organization_id": "85641b3a-5661-4932-942a-87141eae9223", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+00:00" }, "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00" }, "equipment_model_id": "4bed27bd-87d2-42ea-97a7-e9d8a43374cc", "equipment_model_code": "sample string 8", "equipment_model": { "id": "61c1e7b7-ec24-4db5-b103-8fb337522f77", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "9bd33f8c-3f0b-446c-aaf2-7c4f9c408c29", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "c073528a-b0e9-43d1-b100-d8a367672ac5", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "b453ebca-326a-48fc-8aea-9b4ad87adce7", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+00:00" }, "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00" }, "equipment_family_id": "028d2346-e20d-413c-967e-08ed6c02ae29", "equipment_family_code": "sample string 8", "equipment_family": { "id": "efc933ea-39aa-454b-831e-de0619c484e0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "fac41970-1047-4118-a626-d26973f2f719", "_parent_code": "sample string 6", "sales_organization_id": "85641b3a-5661-4932-942a-87141eae9223", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+00:00" }, "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00" }, "date_in_production_since": "2025-03-31T21:27:56.0538845+00:00", "date_out_of_production_since": "2025-03-31T21:27:56.0538845+00:00", "date_end_support": "2025-03-31T21:27:56.0538845+00:00", "sales_organization_id": "3e0bb2a2-2166-4ed9-99ca-da28d2fe7212", "sales_organization_code": "sample string 13", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+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-03-31T21:27:56.0538845+00:00" }, "project_status_id": "b67d526d-74d9-4e93-8357-a831c311e243", "project_status_code": "sample string 10", "project_status": { "id": "c1a0bafb-9c39-4470-a497-69cf8f50b63f", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "95900137-30d7-4834-b104-d16910e46dce", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00" }, "company_id": "9721eb21-18b1-46db-923a-754bbf299eca", "company_code": "sample string 12", "db_address_id": "2db28147-4313-4292-929a-09a554ff958d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "6017cfb7-c71e-4e63-8b93-734da4893eae", "contact_reference_back_office": "sample string 17", "owner_user_id": "53430cb2-08b3-4916-8514-443fceb6708c", "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-03-31T21:27:56.0538845+00:00", "date_create": "2025-03-31T21:27:56.0538845+00:00", "date_update": "2025-03-31T21:27:56.0538845+00:00", "updated_by_user_id": "92d5c44d-b3f1-446a-9c4e-6b08227a400f", "customer_reference": "sample string 28", "warranty_date_until": "2025-03-31T21:27:56.0538845+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-03-31T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-03-31T21:27:56.0538845+00:00", "date_last_job": "2025-03-31T21:27:56.0538845+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-03-31T21:27:56.0538845+00:00", "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00", "is_mobile_installation": true }, "job_type_id": "b4d6cbf4-00e6-483e-9a50-af16df7cd3fd", "job_type_code": "sample string 7", "job_type": { "id": "8f9d6ecc-c2e4-475e-afdc-624d9552d224", "name": "sample string 2", "sales_organization_id": "ed2075d9-c02a-4640-b98a-9ba312cd6f2c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00", "code": "sample string 7" }, "job_priority_id": "0ad6f365-19ba-4954-9c2d-54b51a4ca283", "job_priority_code": "sample string 9", "job_priority": { "id": "ba9cb7d7-f7f9-48ca-95de-750f3ca00cb7", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "6f81b34b-5d4d-48e7-a8ad-9226d4083ac0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00" }, "job_status_id": "ea2bd360-0201-430b-bb4a-a7ef473d953b", "job_status_code": "sample string 11", "db_address_id": "b6de4ae2-3807-4ed9-8a79-a087da6b4cd8", "contact_id": "69c33d89-d8fe-408e-8b04-c2253eb57e2b", "requested_by_company_id": "c17814a8-f8e7-4f59-9daa-928586f9b3d3", "requested_by_contact_id": "40d7d1c6-f070-4785-b917-6860645deff6", "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-03-31T21:27:56.0538845+00:00", "due_date": "2025-03-31T21:27:56.0538845+00:00", "date_create": "2025-03-31T21:27:56.0538845+00:00", "date_update": "2025-03-31T21:27:56.0538845+00:00", "date_closed": "2025-03-31T21:27:56.0538845+00:00", "suggested_user_id": "0704b3c4-170b-4e17-9544-3c2ef8141a14", "suggested_user_code": "sample string 29", "suggested_user": { "id": "17a0c170-d057-4c2f-bd30-ed4ed81042a2", "db_language_id": "7714c5fa-d4fd-4218-b1f9-943fd7e3cb80", "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-03-31T21:27:56.0538845+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "9da9f6c5-3355-4c59-b4c5-0b0495c5eb6b", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b6e7fd52-73f0-4c29-8155-4a8f1e131936", "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": "45b361bb-3bef-473d-9bc2-8f32e25f6f2a", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "5244fd49-fe9b-4ecc-a9e4-b5b1ce70b79f" }, "suggested_date_start": "2025-03-31T21:27:56.0538845+00:00", "skill_id": "b8d3fd37-7c64-4c59-a5c5-75f9d86435d5", "skill_code": "sample string 32", "skill": { "id": "6c938be7-1212-46ad-b79f-1301df69ba3a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "4a7c303d-9a62-4e4f-8c1b-64b8e012ed28", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c358b41e-24e2-438a-8fe8-8274ae8b7057", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "be1c188b-52a9-4d2c-8663-ea97b7d16f25", "db_currency_id": "107becb8-0fab-4afd-8f7c-7c446d3e1fa3", "db_language_id": "e06ae90d-6937-4eac-ba74-e7c39406ec8a", "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-03-31T21:27:56.0538845+00:00" }, "modified_dateutc": "2025-03-31T21:27:56.0538845+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fb8b0ef0-06bd-4ee2-8632-c2261e07d146", "date_reported_by_company": "2025-03-31T21:27:56.0538845+00:00", "id2": 36, "company_id": "2ac4659f-54e0-4274-aa10-d78fad921fc4", "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": "1c571d53-27d4-4649-9e3c-21942cee3ebd", "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-03-31T21:27:56.0538845+00:00" }