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": "6032139c-f90d-4d62-9d22-37cf6457bbba", "_parent_id": "571b9f19-0cd9-4b99-8c37-e3a5fca55fc8", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "93049562-42a7-4989-9512-aef24e754561", "project_reference_back_office": "sample string 5", "project": { "id": "eed34414-c522-4982-a303-c013063d538c", "_parent_id": "85f0efca-9932-427c-a7e8-10c2eb8568b8", "root_parent_id": "37af0514-6144-482e-a88e-1a1fee5bcd31", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "4b4231db-4cf8-4454-982a-d4f3a19cc05c", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e3beb85b-8d56-4644-bfdd-effeed4fa259", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "85349822-3a40-459f-99c4-709e034f67a4", "_parent_code": "sample string 6", "sales_organization_id": "ca9aa7b4-6da8-411f-9f20-50d52267fe0e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+00:00" }, "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00" }, "equipment_model_id": "012c184a-6475-4aab-85c2-377eab63184d", "equipment_model_code": "sample string 8", "equipment_model": { "id": "6a2a6bd0-83c9-462b-a8a0-06f0e530002c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "bcecc1ec-730a-434e-b0c9-4227c5c511e2", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "b8d6af0b-0253-464f-b320-416d39d2c2e2", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7f290418-9436-49e6-be1e-87940850941b", "sales_organization_code": "sample string 5", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+00:00" }, "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00" }, "equipment_family_id": "8c3e802c-93ee-4327-855c-6afb4c48811d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e3beb85b-8d56-4644-bfdd-effeed4fa259", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "85349822-3a40-459f-99c4-709e034f67a4", "_parent_code": "sample string 6", "sales_organization_id": "ca9aa7b4-6da8-411f-9f20-50d52267fe0e", "sales_organization_code": "sample string 8", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+00:00" }, "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00" }, "date_in_production_since": "2025-03-07T02:46:01.0419323+00:00", "date_out_of_production_since": "2025-03-07T02:46:01.0419323+00:00", "date_end_support": "2025-03-07T02:46:01.0419323+00:00", "sales_organization_id": "93b74384-3945-47a2-88ef-20c7f0dadc09", "sales_organization_code": "sample string 13", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+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-03-07T02:46:01.0419323+00:00" }, "project_status_id": "6d7ddc33-71c9-49eb-8d4e-6e7ca6421087", "project_status_code": "sample string 10", "project_status": { "id": "01237472-96f1-4a75-9060-c69769927a96", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "9e7fa49c-3db7-400b-bb39-3beb2d5e1d06", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00" }, "company_id": "6e1efb8d-dcfd-4181-8b7a-8773dd2b1c3e", "company_code": "sample string 12", "db_address_id": "6869a0a3-434d-4517-8db7-4dd145b63a60", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "0768d2cf-a4d6-4bff-a168-50c542e8b0ef", "contact_reference_back_office": "sample string 17", "owner_user_id": "1cc4e704-25d3-4e58-a9c7-4af5067d3aee", "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-03-07T02:46:01.0419323+00:00", "date_create": "2025-03-07T02:46:01.0419323+00:00", "date_update": "2025-03-07T02:46:01.0419323+00:00", "updated_by_user_id": "9cef7e68-9865-4644-ab8d-97e6cebdb4d4", "customer_reference": "sample string 28", "warranty_date_until": "2025-03-07T02:46:01.0419323+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-03-07T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-03-07T02:46:01.0419323+00:00", "date_last_job": "2025-03-07T02:46:01.0419323+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-03-07T02:46:01.0419323+00:00", "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00", "is_mobile_installation": true }, "job_type_id": "a16e584a-24ad-4889-bb86-dc36e23648f0", "job_type_code": "sample string 7", "job_type": { "id": "84035765-f109-4edb-b72f-b1756d9f5976", "name": "sample string 2", "sales_organization_id": "37e74c70-963a-4f91-b8df-d78abe5ab477", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00", "code": "sample string 7" }, "job_priority_id": "559c75ad-6846-4bef-baa3-59aa35745d1c", "job_priority_code": "sample string 9", "job_priority": { "id": "b3941887-272b-4e2d-b7ed-78047592438b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "28b47dd3-ac36-467c-b3de-daeda26315ec", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00" }, "job_status_id": "58560c33-e56a-4b01-abfd-a445dc8e7604", "job_status_code": "sample string 11", "db_address_id": "9966ca71-d307-4ddd-bef5-e3b06cec985a", "contact_id": "2f1d10df-5478-465a-acd2-d92c5aba6d08", "requested_by_company_id": "3d856d51-8e38-4cf9-abe8-d4130c633244", "requested_by_contact_id": "7575383a-a2c4-44b7-8ced-2bd09b0fa9f0", "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-03-07T02:46:01.0419323+00:00", "due_date": "2025-03-07T02:46:01.0419323+00:00", "date_create": "2025-03-07T02:46:01.0419323+00:00", "date_update": "2025-03-07T02:46:01.0419323+00:00", "date_closed": "2025-03-07T02:46:01.0419323+00:00", "suggested_user_id": "e49c3971-1978-4ef9-9ab7-091b24a96b63", "suggested_user_code": "sample string 29", "suggested_user": { "id": "006eea30-e6d8-4cdf-8970-89ba9751b494", "db_language_id": "97ee9e4b-c34f-4d05-bede-064d03e24b33", "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-03-07T02:46:01.0419323+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "06c121ac-f3ba-4983-ae48-9a7f33abb98e", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "fdbbe271-a594-445d-b678-73d7551cc717", "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": "357a4bdf-6689-4d21-82fd-4862ffee5fe7", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "8f7530fb-a2d3-4f56-8c00-f866d1a65b9c" }, "suggested_date_start": "2025-03-07T02:46:01.0419323+00:00", "skill_id": "bc80dda0-9524-4e7b-bde8-40b2b68ca1f4", "skill_code": "sample string 32", "skill": { "id": "f234650a-3226-4966-86e3-1e68d427c3b5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "f832a7e0-8033-44e3-b04e-961a51fdcafc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "f793dac2-b1aa-4bb4-9edb-ac376e5489b4", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "13720df6-8fd2-47d2-a6ca-98ef2546d0a3", "db_currency_id": "e3d3a344-b7d0-4499-a93c-644447017419", "db_language_id": "a8c0e67b-3803-48b5-abd1-bc8caf298c80", "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-03-07T02:46:01.0419323+00:00" }, "modified_dateutc": "2025-03-07T02:46:01.0419323+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "11a2bc24-bb31-4402-ae80-1b29efd89e7e", "date_reported_by_company": "2025-03-07T02:46:01.0419323+00:00", "id2": 36, "company_id": "1c08473c-4e44-4ca1-a791-9f4b40946f61", "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": "d3db4d34-885b-4ee3-9397-7326b4b7f501", "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-03-07T02:46:01.0419323+00:00" }