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": "dd021013-a77c-4546-8ff7-905aa0f5a74f", "_parent_id": "e9ea3da6-8205-4d11-9155-4e6bc159a874", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "7a563fbb-7cc1-4f79-858c-acdf80d3f94e", "project_reference_back_office": "sample string 5", "project": { "id": "6d1a1de0-05f5-43e9-a177-0f964164d133", "_parent_id": "e1f0fa0b-b38b-4130-b6a8-f18644905503", "root_parent_id": "d62916c1-da80-4b2e-8725-170ad3e54b5a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "958721da-1b49-4b9b-9b2f-ae36f2f5adb6", "equipment_family_code": "sample string 6", "equipment_family": { "id": "b2e8a5ee-d3a6-4023-9230-9f6f16f4af9f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "cde9e42e-5641-49e1-98a4-adcda51225ef", "_parent_code": "sample string 6", "sales_organization_id": "74251fdb-cfe4-456d-b96f-12f672c055be", "sales_organization_code": "sample string 8", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+00:00" }, "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00" }, "equipment_model_id": "5d816b32-eb49-4977-90c6-0c46e7fb9c44", "equipment_model_code": "sample string 8", "equipment_model": { "id": "393072ec-72c7-445c-ae83-c548f4ba5537", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "10d0a481-2b19-4a2f-b498-356809285623", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "e0a08abc-f0fa-4d65-9987-d6c963bf0f9f", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "eeba4703-d2ba-4167-88c7-95d286cc2bb6", "sales_organization_code": "sample string 5", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+00:00" }, "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00" }, "equipment_family_id": "5c6ee794-0e9a-4ae2-91fb-0c70dbccf568", "equipment_family_code": "sample string 8", "equipment_family": { "id": "b2e8a5ee-d3a6-4023-9230-9f6f16f4af9f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "cde9e42e-5641-49e1-98a4-adcda51225ef", "_parent_code": "sample string 6", "sales_organization_id": "74251fdb-cfe4-456d-b96f-12f672c055be", "sales_organization_code": "sample string 8", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+00:00" }, "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00" }, "date_in_production_since": "2025-09-04T13:41:24.5053823+00:00", "date_out_of_production_since": "2025-09-04T13:41:24.5053823+00:00", "date_end_support": "2025-09-04T13:41:24.5053823+00:00", "sales_organization_id": "b539b3e4-d6e0-4f67-bcb3-cc35668a6cff", "sales_organization_code": "sample string 13", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+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-09-04T13:41:24.5053823+00:00" }, "project_status_id": "60c57d58-6c54-4747-9b3f-e176537cd353", "project_status_code": "sample string 10", "project_status": { "id": "41588085-c5d4-495f-9a34-1056178ac020", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "2f7e36dd-d2dd-419a-9eb7-77d4ad09ec04", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00" }, "company_id": "f91e67eb-ae77-417b-b3c8-804f4cee9e15", "company_code": "sample string 12", "db_address_id": "204808be-95c1-410e-a8ef-553bcd2aa55a", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "7c6ac004-44d5-44e6-b07e-9863a9e150ac", "contact_reference_back_office": "sample string 17", "owner_user_id": "50b18a59-b871-4f23-87c5-0d7de2c2f282", "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-09-04T13:41:24.5053823+00:00", "date_create": "2025-09-04T13:41:24.5053823+00:00", "date_update": "2025-09-04T13:41:24.5053823+00:00", "updated_by_user_id": "1a0a0a99-6201-4d14-bc30-6759867ee357", "customer_reference": "sample string 28", "warranty_date_until": "2025-09-04T13:41:24.5053823+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-09-04T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-09-04T13:41:24.5053823+00:00", "date_last_job": "2025-09-04T13:41:24.5053823+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-09-04T13:41:24.5053823+00:00", "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00", "is_mobile_installation": true }, "job_type_id": "b972f3fc-7545-4c9c-83af-d1aaa16c21c0", "job_type_code": "sample string 7", "job_type": { "id": "717e559f-06a9-4d9f-b0d7-29268a825afd", "name": "sample string 2", "sales_organization_id": "fd672950-a4b2-4744-b1aa-52624a1b0c9b", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00", "code": "sample string 7" }, "job_priority_id": "81989062-eba0-414b-9ab3-f5394f5da3d7", "job_priority_code": "sample string 9", "job_priority": { "id": "54d9e848-43e6-4eef-8a23-c96989cbb4e1", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "2633898d-0613-497b-9e86-ff52aa8d5984", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00" }, "job_status_id": "7ff23a4c-b4c4-4227-8206-33b3c0e1f800", "job_status_code": "sample string 11", "db_address_id": "2427f694-9265-4983-a341-cd08d0450e07", "contact_id": "4e64e5ba-1e61-42e2-9b91-4b89f3f93cd2", "requested_by_company_id": "e1dae025-94dd-474c-a3d3-ceba67551475", "requested_by_contact_id": "e2072944-4773-4536-a35f-568f68610873", "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-09-04T13:41:24.5053823+00:00", "due_date": "2025-09-04T13:41:24.5053823+00:00", "date_create": "2025-09-04T13:41:24.5053823+00:00", "date_update": "2025-09-04T13:41:24.5053823+00:00", "date_closed": "2025-09-04T13:41:24.5053823+00:00", "suggested_user_id": "3342b59d-31f0-4a37-94b2-9a1322320051", "suggested_user_code": "sample string 29", "suggested_user": { "id": "98099064-4bab-463e-8436-9ecc0940d264", "db_language_id": "fa659b7a-d8e6-48ba-9d65-d7a829fc8446", "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-09-04T13:41:24.5053823+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "88b7bcf0-0885-4f03-ab74-1e4ac5600bab", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "ce0765c3-df7d-4ff0-bacf-f2a9cd7472ee", "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": "2a2a442f-6067-43cc-ad88-8392717098ab", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "326f8b76-e55b-4019-9012-73f9ad688ddc" }, "suggested_date_start": "2025-09-04T13:41:24.5053823+00:00", "skill_id": "09ce61a0-0fc4-41db-a7ce-7f7577e35b0d", "skill_code": "sample string 32", "skill": { "id": "b691b3d1-9132-4c3f-b51b-6bd29a788af3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "3c849cd8-9cac-4863-9226-3209d0f602d7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4e4ed564-af91-447f-b544-d37e2f0e02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7d616d-7d79-492f-b1a7-fa16f2bba673", "db_currency_id": "eb2a4623-0269-4b60-a356-9bf5094bafaa", "db_language_id": "f9a2cfb3-f5ef-4e37-9326-29e4735efc8b", "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-09-04T13:41:24.5053823+00:00" }, "modified_dateutc": "2025-09-04T13:41:24.5053823+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "4e9db1e5-6b8d-4cec-b594-095909839904", "date_reported_by_company": "2025-09-04T13:41:24.5053823+00:00", "id2": 36, "company_id": "ddc08c72-2f67-467e-ae22-dd06e61f49fe", "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": "42309b3c-3ad7-4424-bf20-edad78e72960", "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-09-04T13:41:24.5053823+00:00" }