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": "da78fa9f-0ebd-468e-b25e-560f48ab6fda", "_parent_id": "36d3c0c7-23dd-45fb-a28d-43993cb31079", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "39eb39fa-6a37-4b26-a93f-ea1b98cc8b20", "project_reference_back_office": "sample string 5", "project": { "id": "7a1993ed-d27a-47cf-916f-ce1fa950ef49", "_parent_id": "5d0f88ef-2390-4c9e-a5c1-07c5b2252f21", "root_parent_id": "8ba88f67-379a-4441-b626-cbda76c46b5a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "6ff82e8d-6a36-4895-b74d-ee3c6ae7385a", "equipment_family_code": "sample string 6", "equipment_family": { "id": "88e7403f-3f77-4f16-84cb-1d09eaaa85d2", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "43706504-c104-457f-ae46-be8c3881b95f", "_parent_code": "sample string 6", "sales_organization_id": "929afdeb-866f-4b64-9b8a-98503ad35556", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+00:00" }, "modified_dateutc": "2025-01-02T13:02:52.0532629+00:00" }, "equipment_model_id": "5fb5921d-5759-42b7-a1cb-ca49ee6b2de6", "equipment_model_code": "sample string 8", "equipment_model": { "id": "786f1b90-6dd2-4fe2-aaf2-a52181acb8bf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "d5cfe7c4-d9d4-442e-ad4e-f8d350cb206d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "5f27b7ff-b709-4c0e-9ff5-2c01bdb70115", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "e6a7f1d1-a0ff-45f3-9c3b-7b2b38a3efbb", "sales_organization_code": "sample string 5", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+00:00" }, "modified_dateutc": "2025-01-02T13:02:52.0532629+00:00" }, "equipment_family_id": "3019ccc2-8ec2-4b16-a98e-c2996a0f3c3b", "equipment_family_code": "sample string 8", "equipment_family": { "id": "88e7403f-3f77-4f16-84cb-1d09eaaa85d2", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "43706504-c104-457f-ae46-be8c3881b95f", "_parent_code": "sample string 6", "sales_organization_id": "929afdeb-866f-4b64-9b8a-98503ad35556", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+00:00" }, "modified_dateutc": "2025-01-02T13:02:52.0532629+00:00" }, "date_in_production_since": "2025-01-02T13:02:52.0532629+00:00", "date_out_of_production_since": "2025-01-02T13:02:52.0532629+00:00", "date_end_support": "2025-01-02T13:02:52.0532629+00:00", "sales_organization_id": "641c57a2-c00a-491b-a967-14bba94b7f11", "sales_organization_code": "sample string 13", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+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-01-02T13:02:52.0532629+00:00" }, "project_status_id": "e1f29c6c-99a6-433f-97ae-d4c170a5a217", "project_status_code": "sample string 10", "project_status": { "id": "0ad6ac15-73d5-4b03-86eb-88aab6fe229e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "10d3732e-a455-41c6-82e3-7a43877542d6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-02T13:02:52.0532629+00:00" }, "company_id": "221169ed-ac9a-4f06-96a3-cb639f7c853d", "company_code": "sample string 12", "db_address_id": "be9f32ce-aefd-46ad-9ae9-91eef6a3034f", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "1aabaf3f-48a7-4b0a-ab5a-f5b2ac558144", "contact_reference_back_office": "sample string 17", "owner_user_id": "5c85b831-c433-4260-be9a-00f6f114d121", "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-01-02T13:02:52.0532629+00:00", "date_create": "2025-01-02T13:02:52.0532629+00:00", "date_update": "2025-01-02T13:02:52.0532629+00:00", "updated_by_user_id": "46e166ed-4e26-4bbd-85a8-98191d7498f1", "customer_reference": "sample string 28", "warranty_date_until": "2025-01-02T13:02:52.0532629+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-01-02T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-01-02T13:02:52.0532629+00:00", "date_last_job": "2025-01-02T13:02:52.0532629+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-01-02T13:02:52.0532629+00:00", "modified_dateutc": "2025-01-02T13:02:52.0532629+00:00", "is_mobile_installation": true }, "job_type_id": "6e745455-cb4d-4910-953b-0c90cf84dd14", "job_type_code": "sample string 7", "job_type": { "id": "9d6003bd-0824-4c5c-9ca3-963a3d876b8d", "name": "sample string 2", "sales_organization_id": "c584dcc1-5691-4795-b5dc-deb5847831b5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-01-02T13:02:52.0532629+00:00", "code": "sample string 7" }, "job_priority_id": "f5fe591e-13ae-4fc9-afc7-a463cea40f11", "job_priority_code": "sample string 9", "job_priority": { "id": "513c715e-bb4a-4e2d-b491-16e1b9982f21", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "eae998c9-8e21-42a0-ae10-57234bc7edd4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-02T13:02:52.0532629+00:00" }, "job_status_id": "89e5e3eb-2d15-4b12-9807-049c3b4269d9", "job_status_code": "sample string 11", "db_address_id": "bc517efe-d8e4-4af1-bba0-1ce5896fe86f", "contact_id": "b740126f-bd41-4765-8e9b-e59b076d3a58", "requested_by_company_id": "1732a29f-aaa1-45df-9031-934a813f5d44", "requested_by_contact_id": "0325f50f-7e5a-4fb3-b744-413d6c492f78", "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-01-02T13:02:52.0689099+00:00", "due_date": "2025-01-02T13:02:52.0689099+00:00", "date_create": "2025-01-02T13:02:52.0689099+00:00", "date_update": "2025-01-02T13:02:52.0689099+00:00", "date_closed": "2025-01-02T13:02:52.0689099+00:00", "suggested_user_id": "1623cd58-f0ef-4d02-b6d4-95d737e50213", "suggested_user_code": "sample string 29", "suggested_user": { "id": "68573f14-367c-4d0d-93d2-fd2b82682ba0", "db_language_id": "58b78cd1-bb82-4381-93f6-29fd3daa4099", "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-01-02T13:02:52.0689099+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "66d465cc-5bfa-4639-9654-2386ad6509bf", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "660dc3a3-b7a9-4121-9c39-5c104663e51a", "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": "77cf4de3-5c99-42e8-8ba0-f3b06174ff67", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-01-02T13:02:52.0689099+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "9b956331-1521-47e4-b132-0bfb3bc48687" }, "suggested_date_start": "2025-01-02T13:02:52.0689099+00:00", "skill_id": "8184fa3b-62b3-4026-ba8b-f36f26a2e4f6", "skill_code": "sample string 32", "skill": { "id": "9e8c9ee9-4794-4625-b950-091d8387956d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "20d3573a-beea-47aa-b6ab-4b1b8c132168", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c226f5f-e464-45ba-a671-0b6e3ef50d9b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "99561ca6-dceb-4b96-b933-e9e35a7fe3ce", "db_currency_id": "46de5dc3-1f33-40c2-baaa-52ea48858f60", "db_language_id": "326e7017-0516-4533-8de1-df0798c9d324", "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-01-02T13:02:52.0532629+00:00" }, "modified_dateutc": "2025-01-02T13:02:52.0689099+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "e35c6372-ac70-41cc-95d1-60a58444f122", "date_reported_by_company": "2025-01-02T13:02:52.0689099+00:00", "id2": 36, "company_id": "23020ce0-b9cc-454e-b294-9c0a6466e25c", "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": "a8b9199f-6dd0-40f0-9654-3802d030e8f5", "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-01-02T13:02:52.0689099+00:00" }