Retrieves the work order with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
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": "a2a99a79-982c-48b1-9a32-8e27995883e4", "_parent_id": "98d63d8c-e023-44d8-a7df-07434178a080", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "509b3f19-fe71-4585-ae86-0127762bd903", "project_reference_back_office": "sample string 5", "project": { "id": "290f24c0-382b-4440-b850-2d3cb6055b67", "_parent_id": "5c12e0c0-073e-4b49-b0b7-a4530cf5db52", "root_parent_id": "d7aab05e-ce96-4561-8356-fde205da0136", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "b305be14-29c3-4755-a5f9-b5c6eb00863d", "equipment_family_code": "sample string 6", "equipment_family": { "id": "303f7d44-ad47-44ec-a94e-987cf21e6e70", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "4200a738-6c0c-4e6b-8c52-44990dec060f", "_parent_code": "sample string 6", "sales_organization_id": "4658a188-91ae-494b-a22a-23b73a429230", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+00:00" }, "modified_dateutc": "2024-04-20T00:44:05.8679355+00:00" }, "equipment_model_id": "0a7137b7-079d-4ee2-a2bb-2c75554ebf0b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "2438d693-0a9d-4b33-9d96-2e4be94a54b9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "b1c1d9d5-992b-4104-b2b8-f93df16b5410", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "4a7b2731-1240-49a8-9ac0-741475304666", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "c93afb03-3f30-4a39-9d97-bd0e566bc851", "sales_organization_code": "sample string 5", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+00:00" }, "modified_dateutc": "2024-04-20T00:44:05.8679355+00:00" }, "equipment_family_id": "5f859129-aec9-4179-8eea-e9b651ba0db0", "equipment_family_code": "sample string 8", "equipment_family": { "id": "303f7d44-ad47-44ec-a94e-987cf21e6e70", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "4200a738-6c0c-4e6b-8c52-44990dec060f", "_parent_code": "sample string 6", "sales_organization_id": "4658a188-91ae-494b-a22a-23b73a429230", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+00:00" }, "modified_dateutc": "2024-04-20T00:44:05.8679355+00:00" }, "date_in_production_since": "2024-04-20T00:44:05.8679355+00:00", "date_out_of_production_since": "2024-04-20T00:44:05.8679355+00:00", "date_end_support": "2024-04-20T00:44:05.8679355+00:00", "sales_organization_id": "62e18da3-39d6-4e49-bada-b50f66c1c5eb", "sales_organization_code": "sample string 13", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+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-04-20T00:44:05.8679355+00:00" }, "project_status_id": "3ab2d293-a2fe-4006-8ec8-0d0a34917ed2", "project_status_code": "sample string 10", "project_status": { "id": "5e7aa65e-b3ad-4a71-943e-b3a49d86fcb0", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ad6506f8-cd73-44a8-a215-b21da477776b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-20T00:44:05.8679355+00:00" }, "company_id": "96383862-9adb-4c8a-9a02-55e2f2ba0e4d", "company_code": "sample string 12", "db_address_id": "faafc820-a359-400a-a0b2-c7b0fb35a058", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "133b1901-6c9c-4894-b1e6-3e6b15824df1", "contact_reference_back_office": "sample string 17", "owner_user_id": "18d4df46-246c-4ec9-832a-e6ebb662267e", "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-04-20T00:44:05.8679355+00:00", "date_create": "2024-04-20T00:44:05.8679355+00:00", "date_update": "2024-04-20T00:44:05.8679355+00:00", "updated_by_user_id": "c2d05f57-8919-4d8f-9d20-515e82b8827b", "customer_reference": "sample string 28", "warranty_date_until": "2024-04-20T00:44:05.8835566+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-04-20T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-04-20T00:44:05.8835566+00:00", "date_last_job": "2024-04-20T00:44:05.8835566+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-04-20T00:44:05.8835566+00:00", "modified_dateutc": "2024-04-20T00:44:05.8835566+00:00", "is_mobile_installation": true }, "job_type_id": "61c76e13-6762-4b17-94ff-26f620a64b05", "job_type_code": "sample string 7", "job_type": { "id": "a640621b-da21-41d1-95cb-7ac63c2f408d", "name": "sample string 2", "sales_organization_id": "61c0bdd2-1f22-43de-9561-1fee1eea8024", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-04-20T00:44:05.8835566+00:00", "code": "sample string 7" }, "job_priority_id": "f8d7a971-f4d7-4e8c-9ef5-23319713d83a", "job_priority_code": "sample string 9", "job_priority": { "id": "ea12c9a6-d6b8-4d01-8d00-899f089ba610", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "18ed69d3-4277-43d3-9851-53a288656e66", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-20T00:44:05.8835566+00:00" }, "job_status_id": "bd679edb-fd1e-4ab0-98ab-650b30238b80", "job_status_code": "sample string 11", "db_address_id": "b2d2b0ac-30e8-4c94-8a55-3b4a7df857f7", "contact_id": "678a09bf-f6a4-4ecd-bfac-c62fc0c954c8", "requested_by_company_id": "50444c74-703c-4407-982e-0c5e5a3d83d0", "requested_by_contact_id": "1ded3939-6543-4feb-a365-22e25b980666", "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-04-20T00:44:05.8835566+00:00", "due_date": "2024-04-20T00:44:05.8835566+00:00", "date_create": "2024-04-20T00:44:05.8835566+00:00", "date_update": "2024-04-20T00:44:05.8835566+00:00", "date_closed": "2024-04-20T00:44:05.8835566+00:00", "suggested_user_id": "74e4e9f7-692a-4225-b093-0828db8d5612", "suggested_user_code": "sample string 29", "suggested_user": { "id": "387577fb-b69d-4a31-b58b-cc1aa2982fd1", "db_language_id": "75e29d0e-f2e4-436f-8fe9-3e291637d41f", "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-04-20T00:44:05.8835566+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "6093f359-6dca-4107-b657-21911dce6024", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "fdced26f-e7d0-47f1-a3ec-a85c1e739afb", "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": "77a33bfc-b71c-4811-96d4-2e82d094390e", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-04-20T00:44:05.8835566+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "e192e382-1237-4803-a360-ac2b64dbb62e" }, "suggested_date_start": "2024-04-20T00:44:05.8835566+00:00", "skill_id": "ca3c1b2e-777a-4252-9a93-8e186a63d3c8", "skill_code": "sample string 32", "skill": { "id": "757e5249-3e97-4d21-9c80-f67a4357e1b7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "c6c93989-80f6-4109-ac12-34a2e1ebc18d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3d6936d7-42da-4948-a9e4-5e8afbdae6bc", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71ac29df-7b25-4e45-86df-322ab820e558", "db_currency_id": "c44a8213-332a-431c-89d4-1d6d518f25d0", "db_language_id": "002497b3-9420-4e65-8e6d-b1ac805dc4f5", "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-04-20T00:44:05.8679355+00:00" }, "modified_dateutc": "2024-04-20T00:44:05.8835566+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "eae2503c-28aa-45bc-99f3-72a31af3861a", "date_reported_by_company": "2024-04-20T00:44:05.8835566+00:00", "id2": 36, "company_id": "1a28671b-40a6-4aff-ad03-9fb08c832219", "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": "f1aa2b99-46b8-4aee-99a2-4d3f30720280", "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-04-20T00:44:05.8835566+00:00" }