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": "388dfba8-8ef7-4456-9b71-acd8f7e55359", "_parent_id": "6d90d5cc-9988-438f-939c-53240b5e9de7", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "ee9a1bce-ee37-4be3-b0a4-bd7cd6c8eb2d", "project_reference_back_office": "sample string 5", "project": { "id": "5e314cff-c5a9-474f-9208-689499987af5", "_parent_id": "b4f31a61-54cb-482e-95e5-1b7e9a608213", "root_parent_id": "179b18c2-0e94-453c-8e9d-e0423a606cd3", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "5daa1cd0-2e77-40a0-a6d7-d31bf224e2cf", "equipment_family_code": "sample string 6", "equipment_family": { "id": "1fdcc1bf-bbaf-4f05-9c20-ca486a8e4939", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "190fb3ee-6220-4181-9977-2f34294e281a", "_parent_code": "sample string 6", "sales_organization_id": "cf5df7eb-7047-4f7f-91ff-da0c9c851745", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+00:00" }, "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00" }, "equipment_model_id": "46c6e0f9-17bc-4c71-9151-cc1835f762b8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "960c2678-f187-4844-8f36-3c0fb26e8d8b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "f8746926-74cb-4a36-a557-13405c4f0799", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "4aa44fc2-2150-4e27-b9e1-c2866fab1d61", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "4bccca78-e6d6-4e32-97db-2bb007250d46", "sales_organization_code": "sample string 5", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+00:00" }, "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00" }, "equipment_family_id": "714d5fb8-acac-4960-958a-d9c50e185b98", "equipment_family_code": "sample string 8", "equipment_family": { "id": "1fdcc1bf-bbaf-4f05-9c20-ca486a8e4939", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "190fb3ee-6220-4181-9977-2f34294e281a", "_parent_code": "sample string 6", "sales_organization_id": "cf5df7eb-7047-4f7f-91ff-da0c9c851745", "sales_organization_code": "sample string 8", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+00:00" }, "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00" }, "date_in_production_since": "2025-05-07T02:34:40.3217175+00:00", "date_out_of_production_since": "2025-05-07T02:34:40.3217175+00:00", "date_end_support": "2025-05-07T02:34:40.3217175+00:00", "sales_organization_id": "cceb19a0-37ae-4c2b-ba7d-56040c28c6a7", "sales_organization_code": "sample string 13", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+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-05-07T02:34:40.3217175+00:00" }, "project_status_id": "740b22f9-e708-450a-a35f-2de504a15084", "project_status_code": "sample string 10", "project_status": { "id": "76f8b3f4-7db3-4edb-bddc-cd9ad6dc874e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "3d1d6291-12d5-491e-a451-c68e085cb9d9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00" }, "company_id": "07243b4c-6622-4d3a-a60b-76fe086b889c", "company_code": "sample string 12", "db_address_id": "9139b5ef-4835-4443-a799-3130e4546220", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "9256572f-2636-41a0-896e-704b238c41d6", "contact_reference_back_office": "sample string 17", "owner_user_id": "3ea46e65-d67a-4ebd-9fdd-2f6222e19513", "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-05-07T02:34:40.3217175+00:00", "date_create": "2025-05-07T02:34:40.3217175+00:00", "date_update": "2025-05-07T02:34:40.3217175+00:00", "updated_by_user_id": "c282ec9e-9480-4758-8bcf-52cd35f4751e", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-07T02:34:40.3217175+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-05-07T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-07T02:34:40.3217175+00:00", "date_last_job": "2025-05-07T02:34:40.3217175+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-07T02:34:40.3217175+00:00", "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00", "is_mobile_installation": true }, "job_type_id": "cecb61e0-4043-436e-8990-3ef5c61f2d36", "job_type_code": "sample string 7", "job_type": { "id": "e6dc1a95-b9ed-41d0-a910-a14a36e84c11", "name": "sample string 2", "sales_organization_id": "8b0e7dab-f851-40b6-8e64-03a23e0174d0", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00", "code": "sample string 7" }, "job_priority_id": "74f7aa37-8593-4396-9b02-2263bd1489c0", "job_priority_code": "sample string 9", "job_priority": { "id": "2af4750a-0060-46bf-a291-21e6987444d2", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "b2bb4135-7a63-47c8-8198-602c46cdad4a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00" }, "job_status_id": "c2d950c6-b2cd-4771-9df3-4cfbc7d4f42f", "job_status_code": "sample string 11", "db_address_id": "d7960526-d44e-4cae-96c3-2e8c1288ebc3", "contact_id": "3669c3f4-d309-4c28-a875-e4f1a1eed6c7", "requested_by_company_id": "fd90a88d-9634-4d3f-a5c8-fa7c316e72b8", "requested_by_contact_id": "ab648377-04a5-482f-9e36-bd4af4fb8707", "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-05-07T02:34:40.3217175+00:00", "due_date": "2025-05-07T02:34:40.3217175+00:00", "date_create": "2025-05-07T02:34:40.3217175+00:00", "date_update": "2025-05-07T02:34:40.3217175+00:00", "date_closed": "2025-05-07T02:34:40.3217175+00:00", "suggested_user_id": "cc185bf5-b0d7-4a09-b097-071a7570664b", "suggested_user_code": "sample string 29", "suggested_user": { "id": "08d10d2f-dd02-45bc-b6ec-dc6a9841320a", "db_language_id": "c5e8353b-9138-4990-9433-298b21579bd3", "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-05-07T02:34:40.3217175+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "0bec822b-1ed5-41ae-ac30-85fb7d49b821", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "ee90e9b8-049c-47ed-a00c-75893a9e8127", "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": "0a7c7d07-7d81-474a-931a-4711336c2dad", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-07T02:34:40.3217175+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "ad99e240-20cf-495b-a44e-7364a3102659" }, "suggested_date_start": "2025-05-07T02:34:40.3217175+00:00", "skill_id": "782a467a-fa22-4911-8ad8-9c94a03795a6", "skill_code": "sample string 32", "skill": { "id": "7f641fe2-60e5-47d0-a463-e5637f60a109", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "31fef66f-43d6-462b-928e-c8b8fc4faa8a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "d4a1030e-6f4e-462c-aba3-e3111d7c1cd7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9914c59a-342e-4e5d-bb74-dfca9a3eea9e", "db_currency_id": "3a116df2-cd2f-49a1-bb31-0cec7c589a2c", "db_language_id": "abbc8b31-5c30-45c8-a308-5700c5a3b336", "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-05-07T02:34:40.3217175+00:00" }, "modified_dateutc": "2025-05-07T02:34:40.3373377+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "6d4c323f-a8e9-43ac-967c-2f2e355e738d", "date_reported_by_company": "2025-05-07T02:34:40.3373377+00:00", "id2": 36, "company_id": "86580408-ed45-426c-bd18-4b2bd158dcb6", "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": "129faf73-36ce-4435-b152-f6f8d1365e0e", "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-05-07T02:34:40.3373377+00:00" }