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": "c2f5db3b-c304-41de-9ee7-81eec2986393", "_parent_id": "1e02d3fb-8e37-43ef-aafa-ba06a7405358", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "e7078f9a-16f6-4794-85c5-a26d75751055", "project_reference_back_office": "sample string 5", "project": { "id": "9069228b-7e38-4f7d-bc39-ddbf5d55ca28", "_parent_id": "378cdf0b-d767-4a84-a297-91f0756615ee", "root_parent_id": "4c82a404-250a-46aa-b3f5-8f5fe88f17f1", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "e04d028f-205e-498d-8274-ba0be84969ee", "equipment_family_code": "sample string 6", "equipment_family": { "id": "129330c3-9fe6-4b70-b6eb-70546d4208d0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "98a5fdd0-e91a-406d-98f4-aaf334ef22c7", "_parent_code": "sample string 6", "sales_organization_id": "f0f0aa0d-e4bb-4c4f-a10c-f130f7b0bb4d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+00:00" }, "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00" }, "equipment_model_id": "93827843-003f-44d3-b54c-c2bc0f4c177a", "equipment_model_code": "sample string 8", "equipment_model": { "id": "0037b1d0-371b-4525-8c00-6b0f2651abf9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "3cd20e39-6040-4925-911c-e6e33849eea5", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "17d07a9d-742a-4deb-8d2d-a8433b60f7a3", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "a5a0f9e2-b096-469d-921e-31fa5c395ff0", "sales_organization_code": "sample string 5", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+00:00" }, "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00" }, "equipment_family_id": "9c87db8f-1736-4321-bc24-90763061b795", "equipment_family_code": "sample string 8", "equipment_family": { "id": "129330c3-9fe6-4b70-b6eb-70546d4208d0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "98a5fdd0-e91a-406d-98f4-aaf334ef22c7", "_parent_code": "sample string 6", "sales_organization_id": "f0f0aa0d-e4bb-4c4f-a10c-f130f7b0bb4d", "sales_organization_code": "sample string 8", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+00:00" }, "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00" }, "date_in_production_since": "2024-12-21T17:06:59.8390113+00:00", "date_out_of_production_since": "2024-12-21T17:06:59.8390113+00:00", "date_end_support": "2024-12-21T17:06:59.8390113+00:00", "sales_organization_id": "62ba5b79-3bea-4a60-ba98-dc67ecf9de0c", "sales_organization_code": "sample string 13", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+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-21T17:06:59.8390113+00:00" }, "project_status_id": "ba112282-d283-4c07-bb16-fcf14542f863", "project_status_code": "sample string 10", "project_status": { "id": "4075ecdf-b472-4f72-97cd-4d0ac801527d", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "2b188468-2b61-4621-8b29-120f8d1098ff", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00" }, "company_id": "6c66d7c7-0d84-4882-8e27-1b8b98c32e6a", "company_code": "sample string 12", "db_address_id": "05282b5a-9025-46cf-a520-af65de0ae672", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "73284e7d-ee8b-4cdb-9523-11922dccc280", "contact_reference_back_office": "sample string 17", "owner_user_id": "7d6684b2-feaa-48f3-8a21-e8dea35c0f20", "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-21T17:06:59.8390113+00:00", "date_create": "2024-12-21T17:06:59.8390113+00:00", "date_update": "2024-12-21T17:06:59.8390113+00:00", "updated_by_user_id": "4f2ed640-0f5b-4fef-9dbe-dacf50f08904", "customer_reference": "sample string 28", "warranty_date_until": "2024-12-21T17:06:59.8390113+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-21T17:06:59.8390113+00:00", "date_last_job": "2024-12-21T17:06:59.8390113+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-12-21T17:06:59.8390113+00:00", "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00", "is_mobile_installation": true }, "job_type_id": "8ae1559d-7557-4da9-a875-03ec6a66aab2", "job_type_code": "sample string 7", "job_type": { "id": "6e4ddf68-afd9-49ae-a164-45165317ee18", "name": "sample string 2", "sales_organization_id": "44dc7ef1-fc3c-4679-8910-859e19fa0671", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00", "code": "sample string 7" }, "job_priority_id": "e19a4622-dcb4-4d15-9544-ad31f791d701", "job_priority_code": "sample string 9", "job_priority": { "id": "dd2b161d-cb05-4739-828e-cb3661f65101", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "7c11ce71-aa75-4071-9987-79cb232bc538", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00" }, "job_status_id": "5884884c-fc62-455f-844d-bab399cde214", "job_status_code": "sample string 11", "db_address_id": "78415253-adc1-4a86-a898-e3a7a062ceb2", "contact_id": "57f0473f-8c4d-49a7-847b-ce1a314a7ea8", "requested_by_company_id": "58830202-25d7-43ee-8f28-c11fdb55c569", "requested_by_contact_id": "00c52a11-7d1f-4e43-8f34-68c406a94317", "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-21T17:06:59.8390113+00:00", "due_date": "2024-12-21T17:06:59.8390113+00:00", "date_create": "2024-12-21T17:06:59.8390113+00:00", "date_update": "2024-12-21T17:06:59.8390113+00:00", "date_closed": "2024-12-21T17:06:59.8390113+00:00", "suggested_user_id": "9269c38e-699d-4728-8321-e70e4386d0b8", "suggested_user_code": "sample string 29", "suggested_user": { "id": "b2bd06ff-d1ba-4b72-abd8-a8de75c7377e", "db_language_id": "8a851888-f512-4ef5-b8c0-dceef78c87b9", "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-21T17:06:59.8390113+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "d29bd064-6d52-4a53-be1a-7f7cc0bd2fc0", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "dc5d795b-ef65-41cc-81d2-440ea92c8017", "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": "f7773c0e-5d26-45cb-8c3d-665565214875", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "3d7cde09-e6ba-4904-85dd-e66b53ece45e" }, "suggested_date_start": "2024-12-21T17:06:59.8390113+00:00", "skill_id": "0bb97dbe-f981-478b-99e9-04da0c3521b9", "skill_code": "sample string 32", "skill": { "id": "d84b95fe-7edb-4d6a-b349-69ff607dbbf1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "c791e4e3-1ffa-446f-ba63-3fd453fb2bcd", "sales_organization_code": "sample string 6", "sales_organization": { "id": "8c6071b0-e9a2-4205-931a-e66bc24d5680", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8983e57c-69db-441c-9796-5c61e5c90023", "db_currency_id": "527c6c50-5672-44ca-8111-6f6eeac5432c", "db_language_id": "a3c2cf14-3b87-495f-b261-c169a11375ea", "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-21T17:06:59.8390113+00:00" }, "modified_dateutc": "2024-12-21T17:06:59.8390113+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "6e0f58f5-511b-4265-a008-434c49211334", "date_reported_by_company": "2024-12-21T17:06:59.8390113+00:00", "id2": 36, "company_id": "d4334e44-f45c-4b9b-8c8d-d24fc9b6808d", "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": "36e9e62a-dc6c-4b1e-b775-fe9f8ff070e8", "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-21T17:06:59.8390113+00:00" }