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": "f2d3cae7-c516-4b65-b83c-26c7695f1de8", "_parent_id": "d378bf44-0644-4800-a34a-56d27159a410", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "5c982482-fba9-499a-8e46-0fc40b1b0440", "project_reference_back_office": "sample string 5", "project": { "id": "00195f89-010d-4417-9493-357f7f25ab52", "_parent_id": "4e993b64-f979-461c-adbe-3d55d930ccce", "root_parent_id": "feefdd81-bcdc-4215-bf25-b607b0627b4d", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "9addb025-7139-4bb6-9fc4-57b69543920f", "equipment_family_code": "sample string 6", "equipment_family": { "id": "57005670-437a-48cd-b2d0-bcccc75cd480", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "9fe5a042-d9a9-4176-9812-198c836af00e", "_parent_code": "sample string 6", "sales_organization_id": "c97aaa85-2f5b-4566-abfa-90688c284c3b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+00:00" }, "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00" }, "equipment_model_id": "b064a812-8da3-447e-b135-d60e5ff7757d", "equipment_model_code": "sample string 8", "equipment_model": { "id": "2579704a-3676-42ac-b03d-7b502fa7f4bd", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "250c1021-f7a4-483c-8cd6-d5bf0283be7b", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "b32c8dd6-f9d3-47a4-b604-c0e0e4c306ec", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7862dc95-9be7-463f-a4de-46a6b70d568a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+00:00" }, "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00" }, "equipment_family_id": "a743ad3d-ac27-4cc1-ae8d-22cc112fe345", "equipment_family_code": "sample string 8", "equipment_family": { "id": "57005670-437a-48cd-b2d0-bcccc75cd480", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "9fe5a042-d9a9-4176-9812-198c836af00e", "_parent_code": "sample string 6", "sales_organization_id": "c97aaa85-2f5b-4566-abfa-90688c284c3b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+00:00" }, "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00" }, "date_in_production_since": "2025-04-25T00:22:15.0023213+00:00", "date_out_of_production_since": "2025-04-25T00:22:15.0023213+00:00", "date_end_support": "2025-04-25T00:22:15.0023213+00:00", "sales_organization_id": "7771456b-7fea-47b5-bdea-40381607d304", "sales_organization_code": "sample string 13", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+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-04-25T00:22:15.0023213+00:00" }, "project_status_id": "40305148-3347-4398-9e34-20c6fc58fa8f", "project_status_code": "sample string 10", "project_status": { "id": "14c0bbba-76eb-4af5-be1f-867d80ec7eba", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "1b2ae9b4-0d3a-4445-a52a-220e19e7f447", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00" }, "company_id": "ce8ccd45-16b8-448b-ad15-60b0c44a37cc", "company_code": "sample string 12", "db_address_id": "9bff443c-6f54-4617-8a61-b3dd440cfffe", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "2305ecfc-4244-45fa-bd20-afd018dd40f1", "contact_reference_back_office": "sample string 17", "owner_user_id": "b82054dd-4ca1-442b-b5bf-71ddb72dcac6", "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-04-25T00:22:15.0023213+00:00", "date_create": "2025-04-25T00:22:15.0023213+00:00", "date_update": "2025-04-25T00:22:15.0023213+00:00", "updated_by_user_id": "1a9ea669-aafe-42d2-8b45-6a929c3dc40e", "customer_reference": "sample string 28", "warranty_date_until": "2025-04-25T00:22:15.0023213+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-04-25T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-04-25T00:22:15.0023213+00:00", "date_last_job": "2025-04-25T00:22:15.0023213+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-04-25T00:22:15.0023213+00:00", "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00", "is_mobile_installation": true }, "job_type_id": "219810fa-3935-48ce-8dd4-ef1e37e8535b", "job_type_code": "sample string 7", "job_type": { "id": "68e6fcf9-14cb-4156-8071-667fd5c9f278", "name": "sample string 2", "sales_organization_id": "40c6b581-77bc-4a75-a407-168f9a1c88bf", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00", "code": "sample string 7" }, "job_priority_id": "b4c0f255-fe34-4cc4-a579-039713bc1d7a", "job_priority_code": "sample string 9", "job_priority": { "id": "037f2742-ca23-44d4-b132-ec996493ef3d", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "15a2bb29-c59d-44e7-8bdc-fc8d0e850089", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00" }, "job_status_id": "4baf97da-9d71-41fb-a5fd-7553497d6f2d", "job_status_code": "sample string 11", "db_address_id": "6b82b233-bbb7-4d78-a7b4-33ca67865aad", "contact_id": "04fb99aa-edb3-4e32-a832-a0b6a9347496", "requested_by_company_id": "f21c29a2-6476-4a2d-ae51-99fe1b5274f6", "requested_by_contact_id": "fa3f4d2b-93df-4d35-adee-cfd7180a3ac7", "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-04-25T00:22:15.0023213+00:00", "due_date": "2025-04-25T00:22:15.0023213+00:00", "date_create": "2025-04-25T00:22:15.0023213+00:00", "date_update": "2025-04-25T00:22:15.0023213+00:00", "date_closed": "2025-04-25T00:22:15.0023213+00:00", "suggested_user_id": "6374610a-856e-451f-9433-5f09bc27041f", "suggested_user_code": "sample string 29", "suggested_user": { "id": "d1124347-4201-4be9-80d9-d68e1331e5af", "db_language_id": "8dc7bd9f-f505-4c9d-b102-87c42706567e", "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-04-25T00:22:15.0023213+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "a9547969-b6fa-4022-962e-78a2fca7b0b0", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "ad62f949-6380-485a-83b4-405ecbd3e65d", "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": "381f1ead-cc7c-4d75-b960-9747ce67f05e", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "b6ded12d-b24f-4aa9-8199-1dfb9ede5be9" }, "suggested_date_start": "2025-04-25T00:22:15.0023213+00:00", "skill_id": "7f886760-1d24-42c7-a5e9-14e4c1d5325a", "skill_code": "sample string 32", "skill": { "id": "a4cb8f3e-a08f-4256-a79d-d426dd0d2f7d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a6a09076-a45c-4ff4-a813-fa444e5ba161", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ec3c0f11-845b-4729-82ab-498eca17f186", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "513e2d41-b129-44ff-9ddd-f1ca97063420", "db_currency_id": "8f6c8e4b-7aea-4f72-b4fd-fe3e0a90dab5", "db_language_id": "9d8e0829-d04a-4d07-8c93-c327568a1505", "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-04-25T00:22:15.0023213+00:00" }, "modified_dateutc": "2025-04-25T00:22:15.0023213+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "167ab93f-52d2-4e76-9d07-fbe0e18a6466", "date_reported_by_company": "2025-04-25T00:22:15.0023213+00:00", "id2": 36, "company_id": "ccf470ed-ef7e-443c-8207-a0c922910650", "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": "743368da-e3f6-45e0-b375-917b21ae5976", "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-04-25T00:22:15.0023213+00:00" }