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": "54ba3a2c-5536-4dff-bc1c-8459f3d22f19", "_parent_id": "a1282c16-c4a9-486d-99e1-ff368e5faf17", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "b0176748-07a4-42b6-aa03-b339fed2e266", "project_reference_back_office": "sample string 5", "project": { "id": "3a49d9a9-3203-478f-bd08-e43a6b618166", "_parent_id": "7d5c155b-c764-485d-9e07-e663514f80c0", "root_parent_id": "c1d4205c-8cf3-4ac9-9829-858328c0916a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "63f45df1-2b7a-4fcd-8d0c-bbe3afcca04e", "equipment_family_code": "sample string 6", "equipment_family": { "id": "63ce8587-dfe0-47ea-9a22-ea67d304888b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "01d1166e-2678-4b9b-a795-b7eb9054a180", "_parent_code": "sample string 6", "sales_organization_id": "79f12c99-7a18-45ec-94c8-82d54e1a71ef", "sales_organization_code": "sample string 8", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+00:00" }, "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00" }, "equipment_model_id": "874891bf-65a3-48df-871f-5145f8be1652", "equipment_model_code": "sample string 8", "equipment_model": { "id": "59db0124-031b-4816-a67f-9d1ea020b8a9", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "2eba5958-11d5-4c16-9cfa-2a643b214034", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "e4c403da-f5cc-4180-905b-a8c2b05542d2", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "efa991a8-4ade-4b65-adf5-b41d78812bb1", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+00:00" }, "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00" }, "equipment_family_id": "e3bd6a9b-f2c4-4c7c-b6eb-924bf6ec0b10", "equipment_family_code": "sample string 8", "equipment_family": { "id": "63ce8587-dfe0-47ea-9a22-ea67d304888b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "01d1166e-2678-4b9b-a795-b7eb9054a180", "_parent_code": "sample string 6", "sales_organization_id": "79f12c99-7a18-45ec-94c8-82d54e1a71ef", "sales_organization_code": "sample string 8", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+00:00" }, "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00" }, "date_in_production_since": "2025-10-09T21:40:56.9858869+00:00", "date_out_of_production_since": "2025-10-09T21:40:56.9858869+00:00", "date_end_support": "2025-10-09T21:40:56.9858869+00:00", "sales_organization_id": "b85e532a-c951-4ed6-9542-988bef0e6ba5", "sales_organization_code": "sample string 13", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+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-10-09T21:40:56.9858869+00:00" }, "project_status_id": "07ad80db-0a24-4fbe-aac6-97ec42b7b992", "project_status_code": "sample string 10", "project_status": { "id": "59ffa409-de7a-43d5-923e-7192074459e9", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "bb120d0a-14a1-4e3c-8eaa-0311e8955c51", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00" }, "company_id": "896aa7ee-798c-4cbe-87b5-4f4d30265160", "company_code": "sample string 12", "db_address_id": "ea2ff971-3037-4b41-8a55-981aebed00fe", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "60a8f4f5-004c-438e-b002-581c91508870", "contact_reference_back_office": "sample string 17", "owner_user_id": "ee5482bd-c5f9-4e5d-987d-e03274173cfb", "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-10-09T21:40:56.9858869+00:00", "date_create": "2025-10-09T21:40:56.9858869+00:00", "date_update": "2025-10-09T21:40:56.9858869+00:00", "updated_by_user_id": "8e3b05e5-2a87-486f-b8c1-448a4949b2da", "customer_reference": "sample string 28", "warranty_date_until": "2025-10-09T21:40:56.9858869+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-10-09T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-10-09T21:40:56.9858869+00:00", "date_last_job": "2025-10-09T21:40:56.9858869+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-10-09T21:40:56.9858869+00:00", "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00", "is_mobile_installation": true }, "job_type_id": "a156d249-7794-4a8d-985e-cc3598ad6c28", "job_type_code": "sample string 7", "job_type": { "id": "2fa3a4f5-1bce-43a2-86b1-8f0332011fea", "name": "sample string 2", "sales_organization_id": "002dd9d1-4657-4ea1-896f-39478207a3b6", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00", "code": "sample string 7" }, "job_priority_id": "315642f8-a8e9-4729-a1e3-177184d5a088", "job_priority_code": "sample string 9", "job_priority": { "id": "fc873b67-ee78-48ed-a054-1dd02d37e5a9", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "4d1ab330-ee0f-43e7-9fe1-455bcac7cf05", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00" }, "job_status_id": "09920603-ae2b-4b4a-bf61-b72ca7501543", "job_status_code": "sample string 11", "db_address_id": "16a927b2-38ee-4de0-bb0c-05e9a5b080d1", "contact_id": "b499de6e-a169-42e6-a7f2-325ef09a48a4", "requested_by_company_id": "dbc09326-99f6-4cf4-b8b8-85c7a129b560", "requested_by_contact_id": "563c898e-3dd6-44c6-8e83-3d20d1f00dc4", "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-10-09T21:40:56.9858869+00:00", "due_date": "2025-10-09T21:40:56.9858869+00:00", "date_create": "2025-10-09T21:40:56.9858869+00:00", "date_update": "2025-10-09T21:40:56.9858869+00:00", "date_closed": "2025-10-09T21:40:56.9858869+00:00", "suggested_user_id": "81506a06-ec2e-4764-8bcd-2eeb9a8aa22f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "1443dfb7-43fb-46f3-aaaf-c773a769aea9", "db_language_id": "68a9ba4d-cb66-478b-9752-88deb2cbbc82", "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-10-09T21:40:56.9858869+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c41bb595-9f24-4597-a038-5f9b563fe72f", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "44fd6b07-6787-427e-abfa-32a5026ec804", "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": "22f447ae-90ff-4fa3-915b-72dc87d3389c", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "c2c99148-b2fe-488b-a838-2bc85b2a99d6" }, "suggested_date_start": "2025-10-09T21:40:56.9858869+00:00", "skill_id": "021650e0-d699-4e58-a38b-4c5305ec6f78", "skill_code": "sample string 32", "skill": { "id": "6ad2145c-835f-464b-81d6-2b030530a86d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "f1159076-e8fa-40a9-ae60-6947d65faeaa", "sales_organization_code": "sample string 6", "sales_organization": { "id": "b8afc465-452a-4b90-ae8a-8be502c69c0b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3692dcb0-31a6-4fa1-98f9-26c19a39c581", "db_currency_id": "44ea4de8-6d4f-4cb9-9be6-6ddfe8e7b6f5", "db_language_id": "ecf52f02-a04c-49a9-a376-05d5ad3da525", "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-10-09T21:40:56.9858869+00:00" }, "modified_dateutc": "2025-10-09T21:40:56.9858869+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "0e6a1d0d-744c-4285-bb20-1f6a23606191", "date_reported_by_company": "2025-10-09T21:40:56.9858869+00:00", "id2": 36, "company_id": "24dd6285-e76d-4227-ad5b-c1b20c214bcf", "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": "59725e28-de72-4592-ac7f-aef70d5c231a", "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-10-09T21:40:56.9858869+00:00" }