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": "67515e1f-78a4-43f6-915a-d18c6d0eed56", "_parent_id": "582fd8f3-d79d-496c-b67f-c0cf47fb8741", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "1e12bfa5-57ce-444e-b1f6-912139389cba", "project_reference_back_office": "sample string 5", "project": { "id": "1eefaebc-312e-49cf-926e-3a7d6073aa2c", "_parent_id": "653ba0fb-9afb-4e84-9da8-8aebc4487ad7", "root_parent_id": "060c082b-6c59-459a-bd77-07153584e86a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "13995df3-0814-4be9-916e-641426042446", "equipment_family_code": "sample string 6", "equipment_family": { "id": "27a4c7af-dac2-4ffd-957b-9164262f9a4f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "45924163-3bfe-46af-99d7-6942ebad749d", "_parent_code": "sample string 6", "sales_organization_id": "1c4c20a9-f99c-4c30-8c33-eeafed13c351", "sales_organization_code": "sample string 8", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+00:00" }, "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00" }, "equipment_model_id": "6220a249-d60d-4bb0-8157-0a5f34cea8bd", "equipment_model_code": "sample string 8", "equipment_model": { "id": "e26bffe5-100d-47ac-a2c8-df176ee2baed", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "eecfad09-b668-4bb6-8868-ac39709ba624", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "4f30b061-f564-46df-a9ad-6c6846999d29", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "0f896abc-9e85-4364-b9b2-0a8578924693", "sales_organization_code": "sample string 5", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+00:00" }, "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00" }, "equipment_family_id": "7f6d7056-2446-4e48-bb21-9f6017271d19", "equipment_family_code": "sample string 8", "equipment_family": { "id": "27a4c7af-dac2-4ffd-957b-9164262f9a4f", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "45924163-3bfe-46af-99d7-6942ebad749d", "_parent_code": "sample string 6", "sales_organization_id": "1c4c20a9-f99c-4c30-8c33-eeafed13c351", "sales_organization_code": "sample string 8", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+00:00" }, "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00" }, "date_in_production_since": "2025-03-19T00:44:58.0465749+00:00", "date_out_of_production_since": "2025-03-19T00:44:58.0465749+00:00", "date_end_support": "2025-03-19T00:44:58.0465749+00:00", "sales_organization_id": "3d39350c-1858-4ab7-8e87-87c860bc2527", "sales_organization_code": "sample string 13", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+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-03-19T00:44:58.0465749+00:00" }, "project_status_id": "9b14bafb-994d-45d4-b7da-b3d4779f861a", "project_status_code": "sample string 10", "project_status": { "id": "98393b2b-bd11-44b9-9833-d56b378e3f42", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "c762a100-e6d3-4d47-955b-b40268578e8b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00" }, "company_id": "c4ec6ce9-badd-4017-b90d-c59b0f420835", "company_code": "sample string 12", "db_address_id": "cf4c1773-f1d8-49f6-9b69-c87183a5a3b6", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "200970f2-6afc-455c-bf0f-9f9415ed9734", "contact_reference_back_office": "sample string 17", "owner_user_id": "bed2e40c-b661-4678-9d22-0f5acf6960f5", "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-03-19T00:44:58.0465749+00:00", "date_create": "2025-03-19T00:44:58.0465749+00:00", "date_update": "2025-03-19T00:44:58.0465749+00:00", "updated_by_user_id": "29cb8a87-703d-46ba-a95f-46092f198217", "customer_reference": "sample string 28", "warranty_date_until": "2025-03-19T00:44:58.0465749+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-03-19T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-03-19T00:44:58.0465749+00:00", "date_last_job": "2025-03-19T00:44:58.0465749+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-03-19T00:44:58.0465749+00:00", "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00", "is_mobile_installation": true }, "job_type_id": "f99dd6ca-67b4-4309-afb4-1dc7af7e6055", "job_type_code": "sample string 7", "job_type": { "id": "c510cdaa-4ed1-4b05-902c-8654748acb16", "name": "sample string 2", "sales_organization_id": "8a8bd27e-6961-42ef-aa9f-57398b998f1b", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00", "code": "sample string 7" }, "job_priority_id": "eedd3658-e3a4-46ae-a1b3-46f24e61631c", "job_priority_code": "sample string 9", "job_priority": { "id": "4d83c4fe-b926-4ee2-8060-d2c60d2139d8", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "c726dfe1-5307-48a7-9803-a52f9852fad0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00" }, "job_status_id": "0bc6ab94-0f82-40f9-8171-021a883667ed", "job_status_code": "sample string 11", "db_address_id": "532382af-233a-4965-87e6-1e34eae0182d", "contact_id": "b832b7de-eb81-4721-9d78-4ffbf937e94b", "requested_by_company_id": "e08ef170-d781-42b7-be78-002e81fa3f16", "requested_by_contact_id": "5b6cac1e-f7c8-4374-9044-9ddfcca19355", "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-03-19T00:44:58.0465749+00:00", "due_date": "2025-03-19T00:44:58.0465749+00:00", "date_create": "2025-03-19T00:44:58.0465749+00:00", "date_update": "2025-03-19T00:44:58.0465749+00:00", "date_closed": "2025-03-19T00:44:58.0465749+00:00", "suggested_user_id": "3ec976ff-3d73-488a-b300-bee63c3f5aab", "suggested_user_code": "sample string 29", "suggested_user": { "id": "fc2d61dc-147b-44c9-9f4f-c426521d4acb", "db_language_id": "29df625c-a7d3-4b8a-adef-38912ae4443b", "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-03-19T00:44:58.0465749+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "d9a19bbc-ae1f-43d1-a929-0b99fcf6faae", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0a0f0378-4ec1-4ca4-8cb2-8aeef2f40490", "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": "cdd5415e-e1bc-481d-9f23-dee74d09fdca", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "d33ab042-20f1-45c8-8dcc-9bf0335a0699" }, "suggested_date_start": "2025-03-19T00:44:58.0465749+00:00", "skill_id": "837d5843-dbc0-4567-831f-cd1126ef7ddd", "skill_code": "sample string 32", "skill": { "id": "2d73c29a-91dd-49f2-8f26-dd92b59980aa", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "b697a5b0-2330-4f35-a970-4ab7f26e839d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "5bdcc457-a057-4a68-ab1b-830562c9b7f2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "71e21f99-cef5-4b7c-8b89-6e8d6c6a6b10", "db_currency_id": "bdc7b634-db2b-4e70-85ef-275db653db9e", "db_language_id": "bbcaf94c-a2e7-4fba-b85a-d85956c32fbe", "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-03-19T00:44:58.0465749+00:00" }, "modified_dateutc": "2025-03-19T00:44:58.0465749+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "43470626-1b90-4991-a57f-ecfdb713080e", "date_reported_by_company": "2025-03-19T00:44:58.0465749+00:00", "id2": 36, "company_id": "e8d7b4a0-e7dd-40d8-90e5-76acd359b923", "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": "84b83f41-c083-44ce-ac2c-eb7a7da0b3a7", "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-03-19T00:44:58.0622036+00:00" }