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": "ed85bf2a-3bc9-4114-a92c-d20bf950ec74", "_parent_id": "d4bbc063-609d-4cde-a9cd-1e2654445b80", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "8da51b48-d21c-4024-9a11-6106779b0e86", "project_reference_back_office": "sample string 5", "project": { "id": "586eadd3-ce71-44af-a927-53a3657b9b22", "_parent_id": "725c1fc4-7c60-4667-870c-86221b3858e3", "root_parent_id": "e72136c6-51ec-4ef1-9af2-e69a508a121b", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "5ca99ac6-bc8f-4323-8760-c2574aa5d83d", "equipment_family_code": "sample string 6", "equipment_family": { "id": "550fba30-5ed0-4200-b815-643030a67d11", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1f5555e8-03a8-4a7e-ad1d-1adab16e6a92", "_parent_code": "sample string 6", "sales_organization_id": "4e884a1d-1740-4c7d-889d-5ed8e081bfa0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+00:00" }, "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00" }, "equipment_model_id": "affa55dc-97be-4418-881a-bb8e5834ff30", "equipment_model_code": "sample string 8", "equipment_model": { "id": "63eefbc7-c2b8-4399-9df3-22fdc253f2ba", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "8bb12332-1dfc-48db-85e5-1d9e30ec5cdb", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "06904c8e-2384-4684-a7cf-22ad60251193", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "ed47d86b-992e-4367-8b1b-274db2beb7ba", "sales_organization_code": "sample string 5", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+00:00" }, "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00" }, "equipment_family_id": "2ce6b66b-28eb-4be7-9da8-b1b910c0592b", "equipment_family_code": "sample string 8", "equipment_family": { "id": "550fba30-5ed0-4200-b815-643030a67d11", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1f5555e8-03a8-4a7e-ad1d-1adab16e6a92", "_parent_code": "sample string 6", "sales_organization_id": "4e884a1d-1740-4c7d-889d-5ed8e081bfa0", "sales_organization_code": "sample string 8", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+00:00" }, "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00" }, "date_in_production_since": "2025-01-22T01:06:43.9400853+00:00", "date_out_of_production_since": "2025-01-22T01:06:43.9400853+00:00", "date_end_support": "2025-01-22T01:06:43.9400853+00:00", "sales_organization_id": "91d84f87-76f0-4308-bb8d-6dd7883a756f", "sales_organization_code": "sample string 13", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+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-01-22T01:06:43.9400853+00:00" }, "project_status_id": "ed7de2ca-3c51-446f-b4ea-6140939881ce", "project_status_code": "sample string 10", "project_status": { "id": "d17d4e1e-ed20-43d3-ab68-d9c35916c120", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "1b5be7d0-4c0a-4bef-a627-9c2dbd166ab2", "sales_organization_code": "sample string 6", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00" }, "company_id": "7ff88ddd-1f32-4aa5-8d76-5d1fbe33b7c0", "company_code": "sample string 12", "db_address_id": "4fb0680e-7281-4c13-a0a0-4ac3a76996bb", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "3f97a438-88a1-44f1-bf8d-a1998248d9e3", "contact_reference_back_office": "sample string 17", "owner_user_id": "28faff63-9d77-4987-b877-5b35274a92f4", "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-01-22T01:06:43.9400853+00:00", "date_create": "2025-01-22T01:06:43.9400853+00:00", "date_update": "2025-01-22T01:06:43.9400853+00:00", "updated_by_user_id": "6eec4c71-ba6e-4de4-88c6-46892ae20506", "customer_reference": "sample string 28", "warranty_date_until": "2025-01-22T01:06:43.9400853+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-01-22T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-01-22T01:06:43.9400853+00:00", "date_last_job": "2025-01-22T01:06:43.9400853+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-01-22T01:06:43.9400853+00:00", "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00", "is_mobile_installation": true }, "job_type_id": "003d807f-e977-4760-a14f-6894ccfd913b", "job_type_code": "sample string 7", "job_type": { "id": "a93913ee-9dd0-4ec1-ae7c-70256fb7c77d", "name": "sample string 2", "sales_organization_id": "14e57949-afc8-4635-8b03-aaa33402f879", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00", "code": "sample string 7" }, "job_priority_id": "1f47b32e-13aa-4a74-9e2a-86fa1a652833", "job_priority_code": "sample string 9", "job_priority": { "id": "f76f4128-6f90-4f32-aa66-6105c7ec10d7", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "bd123d29-265f-4ce2-8a24-b58140ea7159", "sales_organization_code": "sample string 6", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00" }, "job_status_id": "ca218984-31f2-4800-831b-52d09901c2ed", "job_status_code": "sample string 11", "db_address_id": "81f00d30-f976-4bbd-a0c0-5edbce04ed4b", "contact_id": "5d71540b-c9a1-47c7-a2f8-834b02347cfe", "requested_by_company_id": "04da0339-7421-402a-aed7-ea5ad90a16d1", "requested_by_contact_id": "c06d2d97-8a41-4b49-82dc-3ea49b719479", "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-01-22T01:06:43.9400853+00:00", "due_date": "2025-01-22T01:06:43.9400853+00:00", "date_create": "2025-01-22T01:06:43.9400853+00:00", "date_update": "2025-01-22T01:06:43.9400853+00:00", "date_closed": "2025-01-22T01:06:43.9400853+00:00", "suggested_user_id": "11a0cfdc-a330-434a-a7db-4b1036a605da", "suggested_user_code": "sample string 29", "suggested_user": { "id": "fb0b1cdc-3b43-4777-a5ec-f2aea6bab50e", "db_language_id": "1fdd8ab6-5467-4c7f-92e9-087720b10a15", "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-01-22T01:06:43.9400853+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "5075e906-8ece-46a6-9e2c-718d61d80d3e", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "1f8a8c0c-87e3-4330-98f7-50dbec2d5356", "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": "ce2b2a72-f84d-4ee7-8db3-2491600864cd", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "de927a54-f659-4d9d-b165-4c127e7bb9c1" }, "suggested_date_start": "2025-01-22T01:06:43.9400853+00:00", "skill_id": "9c84eae4-b39b-447f-b1e9-ee9b3d606bee", "skill_code": "sample string 32", "skill": { "id": "1ed1cb09-b686-4428-b963-4e5cd0d20376", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "2be463e1-95e6-49c6-a2ad-ef4f37a625b4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "07ceaa95-8a94-4d43-a220-c426bfc52d50", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fd8c5515-7c44-47ed-b62d-78aacb1fc058", "db_currency_id": "4e78afc7-8ab1-42f1-9404-0ee1f2dd982b", "db_language_id": "c22872d5-4bf5-40f4-8096-a529e451316a", "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-01-22T01:06:43.9400853+00:00" }, "modified_dateutc": "2025-01-22T01:06:43.9400853+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "90558d30-3872-467e-be0a-f3a9067b3a5b", "date_reported_by_company": "2025-01-22T01:06:43.9400853+00:00", "id2": 36, "company_id": "c05c8662-a7f4-4693-aeb1-f8746ea3adf2", "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": "0c046d56-e927-4696-bc3f-1e440acd1859", "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-01-22T01:06:43.9400853+00:00" }