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": "52c177ce-ba4b-42b5-aafb-3873e4f1bf27", "_parent_id": "29934518-1280-45c9-b95c-fdd07eb925b9", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "d9148362-1d94-4945-a89e-f20cca399749", "project_reference_back_office": "sample string 5", "project": { "id": "e63b5bb2-473c-4424-846a-28cb33a6a3aa", "_parent_id": "cc7c9ba2-3cea-4a09-9865-9c39998e3bea", "root_parent_id": "8368e251-9b0c-4681-93a6-60e5ad32ddaa", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "45c8ba47-cc27-4343-aea0-77d13567332d", "equipment_family_code": "sample string 6", "equipment_family": { "id": "dc207cb2-cc1d-43b8-9750-06792082a476", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e320f917-a405-43af-bb6d-bbd9775c539a", "_parent_code": "sample string 6", "sales_organization_id": "061071fa-e1ee-4338-828c-9b15cdac6ab0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+00:00" }, "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00" }, "equipment_model_id": "a21126ea-b3b9-4807-b798-bde248a5db74", "equipment_model_code": "sample string 8", "equipment_model": { "id": "2a7bf73d-f8b8-4c20-9968-1ef4cb552342", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "e502857d-ac84-4f97-9e38-c5d705adc0f5", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "d9ef6ff2-0f71-454e-86a1-4cdd781b3a2d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "f611c546-93ff-47e5-a4d9-9667110f1db4", "sales_organization_code": "sample string 5", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+00:00" }, "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00" }, "equipment_family_id": "5dca71e8-ec13-4c02-b562-c047941ad4c9", "equipment_family_code": "sample string 8", "equipment_family": { "id": "dc207cb2-cc1d-43b8-9750-06792082a476", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "e320f917-a405-43af-bb6d-bbd9775c539a", "_parent_code": "sample string 6", "sales_organization_id": "061071fa-e1ee-4338-828c-9b15cdac6ab0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+00:00" }, "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00" }, "date_in_production_since": "2024-12-21T16:57:38.5201852+00:00", "date_out_of_production_since": "2024-12-21T16:57:38.5201852+00:00", "date_end_support": "2024-12-21T16:57:38.5201852+00:00", "sales_organization_id": "31bef731-4e0e-41ca-9799-255d1f158565", "sales_organization_code": "sample string 13", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+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": "2024-12-21T16:57:38.5201852+00:00" }, "project_status_id": "88cd4196-37a1-461e-9af0-803fd73357f8", "project_status_code": "sample string 10", "project_status": { "id": "421c20c4-0ec2-44f5-af6b-04a2c28fc457", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "12ee6a4c-54fd-46d4-83ae-4a9d51cd7b3b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00" }, "company_id": "7e2a5cc8-35e7-4d18-8284-f81fae4485ec", "company_code": "sample string 12", "db_address_id": "0d3655f5-977e-4353-b529-0ff83ff39b50", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "637c4d1d-9916-4f56-b3c4-7fb23d68c0a3", "contact_reference_back_office": "sample string 17", "owner_user_id": "e03157c0-97ec-4e7e-a0c7-d3ea0c8f0645", "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": "2024-12-21T16:57:38.5201852+00:00", "date_create": "2024-12-21T16:57:38.5201852+00:00", "date_update": "2024-12-21T16:57:38.5201852+00:00", "updated_by_user_id": "72697cbc-86ae-4cf9-93c9-8243fb677a4e", "customer_reference": "sample string 28", "warranty_date_until": "2024-12-21T16:57:38.5201852+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": "2024-12-21T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-12-21T16:57:38.5201852+00:00", "date_last_job": "2024-12-21T16:57:38.5201852+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-12-21T16:57:38.5201852+00:00", "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00", "is_mobile_installation": true }, "job_type_id": "9ef7d2d7-40ab-41ea-a558-eb9bddccb89e", "job_type_code": "sample string 7", "job_type": { "id": "f881a9a0-8cb5-4cde-9af5-732c09ff5ea0", "name": "sample string 2", "sales_organization_id": "6712e818-1907-46c6-a2df-887f61844a0b", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00", "code": "sample string 7" }, "job_priority_id": "049e10cc-19ad-4716-a706-4ae42bc1778a", "job_priority_code": "sample string 9", "job_priority": { "id": "60c56342-9ad8-4c3f-af95-9a9f8291f78e", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "50d0c70f-cb37-4979-8ddf-9367b44aa354", "sales_organization_code": "sample string 6", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00" }, "job_status_id": "8da58745-b4a7-4fb5-8596-33585fe6149f", "job_status_code": "sample string 11", "db_address_id": "449c3719-25c2-4f72-b3a6-8a8e0a06f98a", "contact_id": "c92d55f2-bedc-41ca-980c-6f7a476be6f3", "requested_by_company_id": "3522900c-4568-4a28-83bb-b138becc9ea8", "requested_by_contact_id": "581985e8-1b05-48e2-b2c0-ba557d6791cf", "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": "2024-12-21T16:57:38.5201852+00:00", "due_date": "2024-12-21T16:57:38.5201852+00:00", "date_create": "2024-12-21T16:57:38.5201852+00:00", "date_update": "2024-12-21T16:57:38.5201852+00:00", "date_closed": "2024-12-21T16:57:38.5201852+00:00", "suggested_user_id": "4cf65254-5ae7-4499-9dc2-4cc6a026eb53", "suggested_user_code": "sample string 29", "suggested_user": { "id": "677f6898-c2c6-41f9-bc88-34c57e4ef0f9", "db_language_id": "9aeba16e-28d9-4e3d-a931-46a85a340bd1", "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": "2024-12-21T16:57:38.5201852+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "21e90cf5-b0b3-4150-adb8-22c9ca91c2f6", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "cfede3c7-85af-4029-a564-c545e5fa5f5e", "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": "13750f63-b96c-4a59-9ad9-da76b2b96928", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "05873c84-7d86-4b04-998a-a1751ed80cdc" }, "suggested_date_start": "2024-12-21T16:57:38.5201852+00:00", "skill_id": "3185d46d-6fb0-45c8-92e5-db9262742a33", "skill_code": "sample string 32", "skill": { "id": "b30baa03-d868-4d8f-9cd8-b91dbad42322", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "140e1ef5-02c4-46dc-b075-77266dae6ee2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "93d801d4-356d-41c5-8102-b3c5c457e5d9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "bdf53073-484f-4e67-b64a-f5dc95397499", "db_currency_id": "a0dcd074-4ccc-402a-bb90-24ce5fc17ff2", "db_language_id": "3c640a3e-59bc-4ee8-9591-7bffde396ee8", "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": "2024-12-21T16:57:38.5201852+00:00" }, "modified_dateutc": "2024-12-21T16:57:38.5201852+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "05d6afdd-4a59-4b90-96ca-181b0a982ad1", "date_reported_by_company": "2024-12-21T16:57:38.5201852+00:00", "id2": 36, "company_id": "9f1cf392-7757-45ad-abb9-169b1b6ae36b", "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": "e6dbffc8-eaa8-418b-801d-0070eafc43b2", "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": "2024-12-21T16:57:38.5201852+00:00" }