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": "515e8045-b368-41af-9893-34fd468dd3e9", "_parent_id": "a29a1b24-577e-4367-951f-0e5c10cb3b77", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "3a36c6c2-1ea7-4a2f-b3ab-f36374b29e9c", "project_reference_back_office": "sample string 5", "project": { "id": "9df1be84-64cf-4509-8bca-251c22d5eb2e", "_parent_id": "c7fab73e-ad0a-4d3d-94ec-a503810824ae", "root_parent_id": "82aec1a4-7e27-44b9-a223-a1851f252399", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "b4b24615-8d26-48e7-ae0c-e7e1eca2ed1b", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e95942ca-d184-4d51-9fce-fdccbbf4e4c3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5abc88c3-1482-4d0c-8ba3-6b9a8f9fe995", "_parent_code": "sample string 6", "sales_organization_id": "ae0774a2-a0e1-49c5-8bab-c6b13fead9bf", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+00:00" }, "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00" }, "equipment_model_id": "4889a974-ea67-485f-b032-2712c95d8643", "equipment_model_code": "sample string 8", "equipment_model": { "id": "d4e1e6ed-a369-4422-b620-e8008a8e5188", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "c98dbcc4-d08f-42ba-841e-939fedec0c21", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "97dcf118-5f36-4054-ac5f-6d90a8f5cdfc", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "608c8806-4d16-429e-ad6e-f51f7b7b14bb", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+00:00" }, "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00" }, "equipment_family_id": "69affa23-2090-41dc-aa9b-4ee3c6d54915", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e95942ca-d184-4d51-9fce-fdccbbf4e4c3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5abc88c3-1482-4d0c-8ba3-6b9a8f9fe995", "_parent_code": "sample string 6", "sales_organization_id": "ae0774a2-a0e1-49c5-8bab-c6b13fead9bf", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+00:00" }, "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00" }, "date_in_production_since": "2024-11-21T08:30:59.8947156+00:00", "date_out_of_production_since": "2024-11-21T08:30:59.8947156+00:00", "date_end_support": "2024-11-21T08:30:59.8947156+00:00", "sales_organization_id": "b2fcac3f-3815-49ff-9e14-11913bbbfff4", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+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-11-21T08:30:59.8947156+00:00" }, "project_status_id": "8955812c-09fb-4b3c-bf73-2be3227e303e", "project_status_code": "sample string 10", "project_status": { "id": "dc4a529a-0d8d-47f9-b510-7921ea8779d7", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "ff22e093-7c21-4c3a-b070-fe1743da6dcb", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00" }, "company_id": "012b7a14-c9eb-4c1d-bc6e-e81e8b19648b", "company_code": "sample string 12", "db_address_id": "cea6b6bb-0876-4622-af60-27cebfca9f6d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b9b7d085-b4ee-4e0c-a6cc-e0da06da8cc6", "contact_reference_back_office": "sample string 17", "owner_user_id": "a925c7d8-178c-46ed-b182-7b1b7f8ab4a1", "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-11-21T08:30:59.8947156+00:00", "date_create": "2024-11-21T08:30:59.8947156+00:00", "date_update": "2024-11-21T08:30:59.8947156+00:00", "updated_by_user_id": "1b7973f0-7f25-4c87-a5fd-e72618469739", "customer_reference": "sample string 28", "warranty_date_until": "2024-11-21T08:30:59.8947156+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-11-21T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-11-21T08:30:59.8947156+00:00", "date_last_job": "2024-11-21T08:30:59.8947156+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-11-21T08:30:59.8947156+00:00", "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00", "is_mobile_installation": true }, "job_type_id": "272e089e-41c8-4223-a631-83788ee055d3", "job_type_code": "sample string 7", "job_type": { "id": "f35e4011-7909-42f9-b6d9-ce811abb8fc8", "name": "sample string 2", "sales_organization_id": "74692c99-abc2-4937-aff7-59b8438fb477", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00", "code": "sample string 7" }, "job_priority_id": "a67c738d-e51d-4189-b9c5-30e0ac988d93", "job_priority_code": "sample string 9", "job_priority": { "id": "1e345714-7d47-4b55-abed-b308042ccbbc", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "57570933-248c-4651-a459-5f3c39bc00e2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00" }, "job_status_id": "8eb97c3f-6c18-405f-ab0e-6ce98bea4761", "job_status_code": "sample string 11", "db_address_id": "72cd2abb-d335-474d-9505-e80c111315aa", "contact_id": "8a53447b-20ec-448d-a427-526df61e12df", "requested_by_company_id": "d376a7f2-3444-4aa7-99ff-aec6653ac2a6", "requested_by_contact_id": "c3b1579e-a68f-4ae1-bc2f-7c4fd5d2e2a8", "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-11-21T08:30:59.8947156+00:00", "due_date": "2024-11-21T08:30:59.8947156+00:00", "date_create": "2024-11-21T08:30:59.8947156+00:00", "date_update": "2024-11-21T08:30:59.8947156+00:00", "date_closed": "2024-11-21T08:30:59.8947156+00:00", "suggested_user_id": "58c0d039-723e-4c16-b761-35292787db8f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "27cfab3f-8c28-45f8-b04c-6534f7d57fec", "db_language_id": "7d61d664-7356-4bb4-9898-b708d0b96964", "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-11-21T08:30:59.8947156+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "ec664ec7-5cda-4817-afb6-7c77016e4b94", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "9f073523-713d-48e9-a9a3-4a528554d042", "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": "938f29a9-ea91-4fed-905e-7fad2b57e557", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "0eac3c9d-1589-4a32-9f2a-7200b2de5af4" }, "suggested_date_start": "2024-11-21T08:30:59.8947156+00:00", "skill_id": "a8e26022-d79c-40ae-a380-9176b6c614c4", "skill_code": "sample string 32", "skill": { "id": "5b2c4d14-2fcb-4e78-ad01-d081dd0c0f17", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "264ee1eb-f7f2-45a0-9c45-af85a4f66c08", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1c515634-c1a1-40cd-a011-7a350fc3d031", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b531271c-3d33-4094-af78-2ee59599f681", "db_currency_id": "ed91fde4-f857-48f0-b5be-5bcfec57d865", "db_language_id": "21cbecc8-8ef1-4143-9d19-955b34f97357", "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-11-21T08:30:59.8790884+00:00" }, "modified_dateutc": "2024-11-21T08:30:59.8947156+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "b1c6945e-025c-477c-8cc1-11bdb1bea75c", "date_reported_by_company": "2024-11-21T08:30:59.8947156+00:00", "id2": 36, "company_id": "9f644b13-8bb3-4a64-8bef-93e153c08178", "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": "4ac7b847-699d-4be4-9da0-6586d195d80b", "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-11-21T08:30:59.8947156+00:00" }