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": "f0ab242a-4063-4863-a608-f6a53cb14ada", "_parent_id": "0b988730-8a4d-4e19-a157-f1398d546d35", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "e70ea5af-6f2f-45f3-8741-98093a11127d", "project_reference_back_office": "sample string 5", "project": { "id": "a5c4b34f-f332-4697-8a4f-c912e5690ad4", "_parent_id": "82dfa177-2cca-4a3d-8f3d-dee51ee23b95", "root_parent_id": "5fc62cc1-a20b-4418-9bca-ccd819250373", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "7ea30670-0b90-4818-bc6f-ac6be201c264", "equipment_family_code": "sample string 6", "equipment_family": { "id": "508c90e3-28dc-4e7d-ac9e-7de6f77f4d0d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "afb39aa0-d490-4b55-ba66-97620f0d9522", "_parent_code": "sample string 6", "sales_organization_id": "b5fa043b-e4b6-443a-a634-56f9f556578b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+00:00" }, "modified_dateutc": "2024-04-16T21:33:10.5062679+00:00" }, "equipment_model_id": "2b8a6f52-cc1a-48ed-a351-e8cd67a9f39c", "equipment_model_code": "sample string 8", "equipment_model": { "id": "58c89a8f-57bb-4b41-818a-b42ce95d8062", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "872b93e3-802f-43f1-9280-301463f5480d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "332032c8-350e-405c-982d-ed2cfe5e4ed6", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "eebe06cc-889e-4216-aa12-bc36155ce281", "sales_organization_code": "sample string 5", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+00:00" }, "modified_dateutc": "2024-04-16T21:33:10.5062679+00:00" }, "equipment_family_id": "4e8875f9-8809-48ec-80c5-72317391f86d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "508c90e3-28dc-4e7d-ac9e-7de6f77f4d0d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "afb39aa0-d490-4b55-ba66-97620f0d9522", "_parent_code": "sample string 6", "sales_organization_id": "b5fa043b-e4b6-443a-a634-56f9f556578b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+00:00" }, "modified_dateutc": "2024-04-16T21:33:10.5062679+00:00" }, "date_in_production_since": "2024-04-16T21:33:10.5062679+00:00", "date_out_of_production_since": "2024-04-16T21:33:10.5062679+00:00", "date_end_support": "2024-04-16T21:33:10.5062679+00:00", "sales_organization_id": "a52a582e-1bfc-4ca5-8613-466aef81bf6d", "sales_organization_code": "sample string 13", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+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-04-16T21:33:10.5062679+00:00" }, "project_status_id": "32e662cb-c2fe-4cc5-8155-bb6038003ba4", "project_status_code": "sample string 10", "project_status": { "id": "4bcfd920-5642-40cd-b816-e7f5fcd08135", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "577a28cd-02c6-4ce9-b43c-aa40222e6283", "sales_organization_code": "sample string 6", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-16T21:33:10.5062679+00:00" }, "company_id": "7e007c87-5ef3-4454-b7d4-2c86bbd7f5bb", "company_code": "sample string 12", "db_address_id": "98ec71b2-453d-446c-9d78-7db9117cea7b", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "bbfff7b6-5e97-411d-99ea-81d5d03efdf6", "contact_reference_back_office": "sample string 17", "owner_user_id": "04f1b544-b351-4ec9-855e-6221f4ec9545", "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-04-16T21:33:10.5062679+00:00", "date_create": "2024-04-16T21:33:10.5062679+00:00", "date_update": "2024-04-16T21:33:10.5062679+00:00", "updated_by_user_id": "e7e997af-401e-431a-bb9f-f5751d1dad6c", "customer_reference": "sample string 28", "warranty_date_until": "2024-04-16T21:33:10.5062679+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-04-16T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-04-16T21:33:10.5062679+00:00", "date_last_job": "2024-04-16T21:33:10.5062679+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-04-16T21:33:10.5062679+00:00", "modified_dateutc": "2024-04-16T21:33:10.5062679+00:00", "is_mobile_installation": true }, "job_type_id": "ffc3550a-46f0-44e5-a785-5a7e3a1b1e2f", "job_type_code": "sample string 7", "job_type": { "id": "52024fb0-e8cf-4a90-89b8-2bda5b3e5089", "name": "sample string 2", "sales_organization_id": "e59b11dc-3f6d-403b-bf12-fee8bbdc01d5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-04-16T21:33:10.5062679+00:00", "code": "sample string 7" }, "job_priority_id": "73b0ef8f-7988-4360-a477-569cc47fdb5c", "job_priority_code": "sample string 9", "job_priority": { "id": "185601db-63a4-4ef3-8d2c-c64a9af81ea4", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "f202bdb3-b12f-4b28-b5a5-9400f85d0121", "sales_organization_code": "sample string 6", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-16T21:33:10.5218927+00:00" }, "job_status_id": "e5d86c9e-6291-4e1c-bf2b-fd6b9bb0f2c7", "job_status_code": "sample string 11", "db_address_id": "c9b6bd4d-3d01-4b24-92f0-40a5b6990160", "contact_id": "9b6e9330-afd7-4240-994b-5b77df0143aa", "requested_by_company_id": "cdc08229-9cdd-4c09-b51e-c91496d4927e", "requested_by_contact_id": "a00914e2-63a8-4ac7-b969-ac62467733fb", "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-04-16T21:33:10.5218927+00:00", "due_date": "2024-04-16T21:33:10.5218927+00:00", "date_create": "2024-04-16T21:33:10.5218927+00:00", "date_update": "2024-04-16T21:33:10.5218927+00:00", "date_closed": "2024-04-16T21:33:10.5218927+00:00", "suggested_user_id": "5b85513d-0036-4cdb-ac37-b9fbc84b3ab0", "suggested_user_code": "sample string 29", "suggested_user": { "id": "2a5ef5e0-0106-4d3a-a744-a7092a2d5e31", "db_language_id": "cfeac356-2b17-4e5d-b674-bd67f681d7b6", "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-04-16T21:33:10.5218927+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c103be6e-8acb-4b76-adb2-6b3aa5284eab", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "123fc445-9fb8-47d9-b725-0d7b03ac3c0d", "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": "6a2fb87c-63e5-4231-a09b-7aae762d9465", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-04-16T21:33:10.5218927+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "dfa45d59-fb4b-41f6-b4b2-83a30657972e" }, "suggested_date_start": "2024-04-16T21:33:10.5218927+00:00", "skill_id": "92613a63-336e-4592-9685-9b8eb56bb5a5", "skill_code": "sample string 32", "skill": { "id": "2110ae10-0118-4c09-90b3-df3ea9faa74b", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9d87eda3-2fe8-499c-a745-85cf288c2de3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "286a0fc6-ffeb-4e6d-9e79-847484d43cef", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "1e3b47a7-7765-48fd-a85d-e60b1075385e", "db_currency_id": "7ca96b66-6b07-44f4-8c9a-1118ccc37f41", "db_language_id": "e63665f8-da97-4ea2-8843-1763ef6087c9", "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-04-16T21:33:10.5062679+00:00" }, "modified_dateutc": "2024-04-16T21:33:10.5218927+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "e462f83d-2448-4a51-b2de-8dcf80d8ebe5", "date_reported_by_company": "2024-04-16T21:33:10.5218927+00:00", "id2": 36, "company_id": "6e6a0a97-7ae9-49c9-995e-5aecfd325b00", "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": "5930e310-ec9a-4db3-8698-cee0abb4ddd9", "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-04-16T21:33:10.5218927+00:00" }