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": "9dbe2637-e815-4bea-92e6-28bcadd50ed3", "_parent_id": "d400b88b-2fdb-4970-a101-272a0698275e", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "33fda86a-271e-4382-bca6-f6d979fb3b13", "project_reference_back_office": "sample string 5", "project": { "id": "4eb0ed5d-5764-40d4-9bde-1280668d0ab2", "_parent_id": "3dfd70f9-a087-4fc7-97a0-361d590f38b2", "root_parent_id": "8f5e063d-e7f0-406d-9ce3-586f9ae7d7b7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "2af73578-9f6c-4ef1-b97b-15ac330e7ccb", "equipment_family_code": "sample string 6", "equipment_family": { "id": "2356ba4a-0a7e-415d-965d-ee02d7dd377f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ffae13d2-d6c8-4be8-95e3-7a0f3b5afef4", "_parent_code": "sample string 6", "sales_organization_id": "a3bda524-95ca-4274-8062-e316ddc60785", "sales_organization_code": "sample string 8", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+00:00" }, "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00" }, "equipment_model_id": "cbfe486e-2618-40dc-a5db-d7d3bce6ddaf", "equipment_model_code": "sample string 8", "equipment_model": { "id": "c50f2aa9-c9ee-410c-b249-1e7da819749e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "1c9f3833-edba-449f-9ae0-0ac44ee25a75", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "264873f9-35f5-48f2-b214-69e9fe25417f", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "3dc585f9-bce6-4526-99cc-0e1b0b3a9fef", "sales_organization_code": "sample string 5", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+00:00" }, "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00" }, "equipment_family_id": "6d69c0c9-6f6b-4053-93e6-fa4f40cff07c", "equipment_family_code": "sample string 8", "equipment_family": { "id": "2356ba4a-0a7e-415d-965d-ee02d7dd377f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ffae13d2-d6c8-4be8-95e3-7a0f3b5afef4", "_parent_code": "sample string 6", "sales_organization_id": "a3bda524-95ca-4274-8062-e316ddc60785", "sales_organization_code": "sample string 8", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+00:00" }, "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00" }, "date_in_production_since": "2025-04-25T15:53:22.4782747+00:00", "date_out_of_production_since": "2025-04-25T15:53:22.4782747+00:00", "date_end_support": "2025-04-25T15:53:22.4782747+00:00", "sales_organization_id": "0218a9f7-5be0-476e-a288-db2eb1010c71", "sales_organization_code": "sample string 13", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+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-04-25T15:53:22.4782747+00:00" }, "project_status_id": "4d8ad24d-4ef4-4e0b-a9a0-f293a419264a", "project_status_code": "sample string 10", "project_status": { "id": "92c3766b-d82e-4b56-aaf5-9fcc82a7b4ab", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "01e256f2-feef-48a2-bde3-c0817856fa72", "sales_organization_code": "sample string 6", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00" }, "company_id": "ff634b91-5d56-4325-abd7-d616d6d73d7c", "company_code": "sample string 12", "db_address_id": "2c7e3225-820c-4976-be63-e4b4d3a48614", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b3bd5f79-1f38-41ce-b30b-727e059d41fd", "contact_reference_back_office": "sample string 17", "owner_user_id": "31e2d34d-45f3-452e-8d67-a30762b3e8fe", "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-04-25T15:53:22.4782747+00:00", "date_create": "2025-04-25T15:53:22.4782747+00:00", "date_update": "2025-04-25T15:53:22.4782747+00:00", "updated_by_user_id": "6ef0d9ec-9a4a-4c17-ab7d-d44ab54caa81", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-25T15:53:22.4782747+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-04-25T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-25T15:53:22.4782747+00:00", "date_last_job": "2025-04-25T15:53:22.4782747+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-25T15:53:22.4782747+00:00", "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00", "is_mobile_installation": true }, "job_type_id": "33fbbd0d-cea0-439f-bd7b-538003660ef4", "job_type_code": "sample string 7", "job_type": { "id": "63972d5f-278a-4ff7-84d5-807636546b1f", "name": "sample string 2", "sales_organization_id": "d469c02d-d3de-4fd6-9215-e67a0e2797fa", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00", "code": "sample string 7" }, "job_priority_id": "b158ec92-3b2b-4930-8e28-5bbf5e7460d6", "job_priority_code": "sample string 9", "job_priority": { "id": "3652cfc1-50f8-41ff-bc2c-4d1cd81b2de7", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "6365e3c9-230e-46b9-8e7d-4a1ed3688363", "sales_organization_code": "sample string 6", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00" }, "job_status_id": "51c866d2-7952-4dbd-a87a-4afc757817ec", "job_status_code": "sample string 11", "db_address_id": "01f64179-0a89-4d4f-baaa-0bc4d8da1ffc", "contact_id": "4f3c6bda-2111-49aa-9bcf-4b83b9edfee2", "requested_by_company_id": "f8f00386-20db-4b84-b9a2-44319c04fb34", "requested_by_contact_id": "019e43e2-1a9f-4cf4-864a-64b6de3eb709", "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-04-25T15:53:22.4782747+00:00", "due_date": "2025-04-25T15:53:22.4782747+00:00", "date_create": "2025-04-25T15:53:22.4782747+00:00", "date_update": "2025-04-25T15:53:22.4782747+00:00", "date_closed": "2025-04-25T15:53:22.4782747+00:00", "suggested_user_id": "3093ab63-3831-484e-960f-c3d5e903eeb1", "suggested_user_code": "sample string 29", "suggested_user": { "id": "94605eaf-f879-470a-933f-fae7630a6371", "db_language_id": "ea186e1b-058c-406d-91f6-82ebc85c2601", "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-04-25T15:53:22.4782747+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "177fa6c4-8e24-4cb0-b7fe-4e3267ac8dec", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "8c2325ac-6322-4960-b81e-5617c36764e4", "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": "92bfe6dd-3126-410f-a25a-62458298458f", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "fb8228d1-3931-4a2d-baca-66334463d422" }, "suggested_date_start": "2025-04-25T15:53:22.4782747+00:00", "skill_id": "1cee3883-16cc-44d1-a483-b1722a093f54", "skill_code": "sample string 32", "skill": { "id": "043fed8b-dfb7-4e29-810a-ddd28ac0bbb7", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "21b8d79a-6376-4a27-adad-5f7a12c277ec", "sales_organization_code": "sample string 6", "sales_organization": { "id": "836fd94a-882e-4123-b303-3316cac574f0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "3e6a6f40-73fc-4f9c-8099-10d7e49032a2", "db_currency_id": "eedcf80d-69fa-48b3-9519-f9a10cfca54f", "db_language_id": "45124259-82a8-4979-9202-eb96f87993dd", "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-04-25T15:53:22.4782747+00:00" }, "modified_dateutc": "2025-04-25T15:53:22.4782747+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "3e0deeac-ae9d-40c9-a640-ba7db16a6e52", "date_reported_by_company": "2025-04-25T15:53:22.4782747+00:00", "id2": 36, "company_id": "ea43cacc-dc5d-49e0-90a4-0ac4c7d95535", "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": "959ddc49-04b0-4f4c-9cfb-f77c2f711a4b", "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-04-25T15:53:22.4782747+00:00" }