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": "9049b99a-7959-4d51-a29a-dcb76bf39777", "_parent_id": "0c7802e6-d518-4e83-842b-10d1c3021f75", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "c0fbf63a-046d-4841-8d5b-50c459bc0121", "project_reference_back_office": "sample string 5", "project": { "id": "bde74012-c591-4168-8320-65bcc20d3921", "_parent_id": "5d29794b-60b6-41be-ba0e-6166cb818501", "root_parent_id": "de84ebda-af51-414d-a4fe-e09f45ad847d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "e7d4d8ca-960b-4c85-ac8d-cfd58a67e0f9", "equipment_family_code": "sample string 6", "equipment_family": { "id": "8ff49602-2427-4de6-89bf-7dc0147c6ac3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bc4c815b-61a8-4730-81ab-036b86bc3c9e", "_parent_code": "sample string 6", "sales_organization_id": "079d5f48-363f-4dd0-b43f-e8ab80535650", "sales_organization_code": "sample string 8", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+00:00" }, "modified_dateutc": "2025-07-08T05:59:10.8397956+00:00" }, "equipment_model_id": "4a8292ed-fab1-4cea-bbaa-49083052c8aa", "equipment_model_code": "sample string 8", "equipment_model": { "id": "0b6b859c-512c-4a06-9012-f58c886b8abf", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "146fcf51-099d-4e07-b218-77996d269690", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "128f64ae-a387-48be-b858-509d561606a8", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "78c98756-a02c-4d31-976b-d195abeff9fe", "sales_organization_code": "sample string 5", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+00:00" }, "modified_dateutc": "2025-07-08T05:59:10.8397956+00:00" }, "equipment_family_id": "de5b4923-5128-49e9-a585-99611603abd1", "equipment_family_code": "sample string 8", "equipment_family": { "id": "8ff49602-2427-4de6-89bf-7dc0147c6ac3", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "bc4c815b-61a8-4730-81ab-036b86bc3c9e", "_parent_code": "sample string 6", "sales_organization_id": "079d5f48-363f-4dd0-b43f-e8ab80535650", "sales_organization_code": "sample string 8", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+00:00" }, "modified_dateutc": "2025-07-08T05:59:10.8397956+00:00" }, "date_in_production_since": "2025-07-08T05:59:10.8397956+00:00", "date_out_of_production_since": "2025-07-08T05:59:10.8397956+00:00", "date_end_support": "2025-07-08T05:59:10.8397956+00:00", "sales_organization_id": "240f977d-1256-46aa-8287-1a3cc551fdde", "sales_organization_code": "sample string 13", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+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-07-08T05:59:10.8397956+00:00" }, "project_status_id": "89535be8-3d7b-4286-8f8c-4004aa4f47c7", "project_status_code": "sample string 10", "project_status": { "id": "90e5615f-118c-4e2a-bce7-6ab60d3a2cd1", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "4c9c41f1-a616-4a4e-828b-60790ab51914", "sales_organization_code": "sample string 6", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-08T05:59:10.8397956+00:00" }, "company_id": "12156fff-ab3d-474b-a5b6-30efcdf407db", "company_code": "sample string 12", "db_address_id": "f4eda3b7-4eab-477b-ac19-8df44a1cdc01", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "f11eccdf-fabc-4c1e-a543-385382dc2781", "contact_reference_back_office": "sample string 17", "owner_user_id": "a7dfb981-d847-456e-89f8-8e5fb6dc288e", "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-07-08T05:59:10.8397956+00:00", "date_create": "2025-07-08T05:59:10.8397956+00:00", "date_update": "2025-07-08T05:59:10.8397956+00:00", "updated_by_user_id": "1911d660-2c8f-493c-81c6-687b8ce4dd82", "customer_reference": "sample string 28", "warranty_date_until": "2025-07-08T05:59:10.8397956+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-07-08T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-07-08T05:59:10.8397956+00:00", "date_last_job": "2025-07-08T05:59:10.8397956+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-07-08T05:59:10.8397956+00:00", "modified_dateutc": "2025-07-08T05:59:10.8397956+00:00", "is_mobile_installation": true }, "job_type_id": "25af33ee-3d2d-4972-bb75-3da6af54a031", "job_type_code": "sample string 7", "job_type": { "id": "4863a2bc-8c72-4ef8-9052-eb91f1e7d882", "name": "sample string 2", "sales_organization_id": "05f329c0-9f69-409a-9e18-c096cb09f2d7", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-07-08T05:59:10.8397956+00:00", "code": "sample string 7" }, "job_priority_id": "fb4fc0d6-96b5-43cb-b8b2-1dec1edc43a9", "job_priority_code": "sample string 9", "job_priority": { "id": "a02f1a80-f6ac-4b38-a1b7-fe1a26fd64c2", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "3156fb8a-34e8-40dc-a328-145af4fc4866", "sales_organization_code": "sample string 6", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-07-08T05:59:10.8397956+00:00" }, "job_status_id": "e12e5e68-3bfc-4d51-8bdf-64a4659161a4", "job_status_code": "sample string 11", "db_address_id": "39ab7711-6173-4d8e-80d8-1d11acc3b7fd", "contact_id": "aeaae78d-e6ca-4435-a788-c6e48f79037d", "requested_by_company_id": "78b094f8-76eb-473f-af18-0e58b160a179", "requested_by_contact_id": "3c573a67-d45d-407f-bfb4-6684f132bde1", "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-07-08T05:59:10.8397956+00:00", "due_date": "2025-07-08T05:59:10.8397956+00:00", "date_create": "2025-07-08T05:59:10.8397956+00:00", "date_update": "2025-07-08T05:59:10.8397956+00:00", "date_closed": "2025-07-08T05:59:10.8397956+00:00", "suggested_user_id": "d4f3a601-e996-4270-8dcf-7a2346ce3bd5", "suggested_user_code": "sample string 29", "suggested_user": { "id": "c2e5b395-d531-4a47-b242-0a0883298843", "db_language_id": "4d7f8061-5bbe-474f-8c5e-f99dca801080", "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-07-08T05:59:10.8554208+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "938f1f70-bca5-463d-b970-bfea2a57e01b", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "9ba57e58-2685-4af4-8a30-682b8f381bae", "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": "a5461b62-13b1-4ced-9729-52ad508780b4", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-08T05:59:10.8554208+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "22115911-4f4a-4c7f-bf77-63973bcc049e" }, "suggested_date_start": "2025-07-08T05:59:10.8554208+00:00", "skill_id": "60dd7761-71a1-494c-9a73-d5f4acd341d7", "skill_code": "sample string 32", "skill": { "id": "33eadf09-81f1-468f-ac57-1cb9dc90d52d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "04ada533-8bb2-4ff1-826e-3a737b281e4e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "180afa99-7cd0-489d-ac04-29987d7785d7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "944d749c-5c62-4888-a281-ebb7e95000dd", "db_currency_id": "f16bde2e-2526-42cc-a7ff-1a7d5c42d071", "db_language_id": "270d9067-5de8-429c-8ccd-970fdc2b6f80", "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-07-08T05:59:10.8397956+00:00" }, "modified_dateutc": "2025-07-08T05:59:10.8554208+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "a9bd3554-6f5a-46f7-a723-1736202fc93f", "date_reported_by_company": "2025-07-08T05:59:10.8554208+00:00", "id2": 36, "company_id": "d8794b68-773e-4a1e-8202-1bbe4a7b3a7c", "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": "04b120d2-3764-43b8-a67b-5e9e13b5ce5d", "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-07-08T05:59:10.8554208+00:00" }