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": "592a3414-92b6-43a2-8fe2-c0fcc5b4308e", "_parent_id": "1926b231-65d4-4db0-90b4-2f6ef458617c", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "19e8cf50-0330-4363-9e83-a5f94f7d2d73", "project_reference_back_office": "sample string 5", "project": { "id": "2dfa5b64-4f19-4ab2-a38b-ea8711d9e3c3", "_parent_id": "60be9ef0-f3a5-4c38-bda0-37e02caa0c75", "root_parent_id": "e9e36a36-eaf5-4db6-b374-a413151db003", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "5d9306ca-b1a9-48fd-aca6-60d288703784", "equipment_family_code": "sample string 6", "equipment_family": { "id": "e07fcc8a-4e80-4609-9cd6-878dfdbd6bc1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "945d152b-77b7-4603-a16b-fa7a24783c50", "_parent_code": "sample string 6", "sales_organization_id": "b4949c11-6bc1-4dce-88f0-0f2686ce6177", "sales_organization_code": "sample string 8", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+00:00" }, "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00" }, "equipment_model_id": "63690ff7-39dc-474e-adcc-7932536f3778", "equipment_model_code": "sample string 8", "equipment_model": { "id": "ee7690db-155f-4e35-8aaf-79187a868574", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "53edb064-8ca4-4ec4-933a-3af7285e12fd", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "cb2663bf-1907-476b-85ee-9e0e421173e0", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "72913da5-83b3-4cb8-a630-7b7f406436e5", "sales_organization_code": "sample string 5", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+00:00" }, "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00" }, "equipment_family_id": "8645cacd-cced-49a9-bc78-fa3772ea5bd4", "equipment_family_code": "sample string 8", "equipment_family": { "id": "e07fcc8a-4e80-4609-9cd6-878dfdbd6bc1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "945d152b-77b7-4603-a16b-fa7a24783c50", "_parent_code": "sample string 6", "sales_organization_id": "b4949c11-6bc1-4dce-88f0-0f2686ce6177", "sales_organization_code": "sample string 8", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+00:00" }, "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00" }, "date_in_production_since": "2025-02-22T17:25:50.1109377+00:00", "date_out_of_production_since": "2025-02-22T17:25:50.1109377+00:00", "date_end_support": "2025-02-22T17:25:50.1109377+00:00", "sales_organization_id": "69dea5a0-95b8-4abe-9144-0bd2b16a7ff3", "sales_organization_code": "sample string 13", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+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-02-22T17:25:50.1109377+00:00" }, "project_status_id": "eef38b51-82e6-44b0-89c9-920431e383fd", "project_status_code": "sample string 10", "project_status": { "id": "f35583be-f994-49cb-835c-66d7b6dc76d0", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "cd60135e-240d-42d0-9da7-3f0152bc55d8", "sales_organization_code": "sample string 6", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00" }, "company_id": "600a7eac-ee02-49d7-a61f-cf079a7ff50c", "company_code": "sample string 12", "db_address_id": "c26af866-a41f-41b4-8e30-6224f58ffdc8", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "e417dfe6-bfb9-4e99-a183-8ea929edd51a", "contact_reference_back_office": "sample string 17", "owner_user_id": "4706b5dc-5ffd-48c6-bfb4-635cc18d2e2d", "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-02-22T17:25:50.1109377+00:00", "date_create": "2025-02-22T17:25:50.1109377+00:00", "date_update": "2025-02-22T17:25:50.1109377+00:00", "updated_by_user_id": "0b8eeb45-2d24-4a5f-bde4-3a29c9562a50", "customer_reference": "sample string 28", "warranty_date_until": "2025-02-22T17:25:50.1109377+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-02-22T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-02-22T17:25:50.1109377+00:00", "date_last_job": "2025-02-22T17:25:50.1109377+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-02-22T17:25:50.1109377+00:00", "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00", "is_mobile_installation": true }, "job_type_id": "42f16930-bb24-4ab6-8f44-356ee5eb9068", "job_type_code": "sample string 7", "job_type": { "id": "f5324aac-e955-4e74-b82c-74f3e775d630", "name": "sample string 2", "sales_organization_id": "1cf9b299-c242-491d-9ff3-b0b75194a52e", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00", "code": "sample string 7" }, "job_priority_id": "7e2f52bc-0844-4669-abc4-19b356a617a5", "job_priority_code": "sample string 9", "job_priority": { "id": "ce5111f6-777a-4310-92eb-d8e82ccaa5a2", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "b67f7e6d-1ea9-4122-b438-2b63241306c7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00" }, "job_status_id": "4c5d32a9-a619-4d45-a40b-ec5dc7280044", "job_status_code": "sample string 11", "db_address_id": "68a086d3-f1e1-4f86-bd8c-659fe14af83c", "contact_id": "9146aa03-67f6-4217-b984-fffec84096a6", "requested_by_company_id": "61dbcd7d-54f0-47c7-868d-5116b39f764a", "requested_by_contact_id": "489d9558-0e1b-4191-ad1b-986310055534", "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-02-22T17:25:50.1109377+00:00", "due_date": "2025-02-22T17:25:50.1109377+00:00", "date_create": "2025-02-22T17:25:50.1109377+00:00", "date_update": "2025-02-22T17:25:50.1109377+00:00", "date_closed": "2025-02-22T17:25:50.1109377+00:00", "suggested_user_id": "7385f956-80dc-452d-b6cd-b8c5a9d299d4", "suggested_user_code": "sample string 29", "suggested_user": { "id": "c6a0a98e-bc9e-493a-aa6e-e6909e866cbd", "db_language_id": "c8a79f84-84d0-464d-96b6-3c7986787e5b", "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-02-22T17:25:50.1109377+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "eb541a81-7706-4e8b-bde3-bef2ac8d2bf9", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "e2111756-dcf9-484a-a93f-3b1af9389e2b", "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": "fe0d2827-3d4e-496b-9c5b-00663b01ae95", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "4b0eaffc-725e-4fc6-9e49-e2b57044464a" }, "suggested_date_start": "2025-02-22T17:25:50.1109377+00:00", "skill_id": "5ffbe33d-c334-403c-ae12-c6e215f7df63", "skill_code": "sample string 32", "skill": { "id": "4a84c391-69c2-4d1e-9114-3772428fc942", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "8cc0e578-1e35-4216-ae50-7cad8645dd80", "sales_organization_code": "sample string 6", "sales_organization": { "id": "653e9025-42b6-49e3-832c-e3d808d0979f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "edce5923-14d2-4119-a235-52ae5b2b2c63", "db_currency_id": "74185898-5971-435a-a760-ccbbc002f418", "db_language_id": "94235b50-2f04-4eaa-bc87-61403c38e66d", "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-02-22T17:25:50.1109377+00:00" }, "modified_dateutc": "2025-02-22T17:25:50.1109377+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "3a3daa90-b0ea-4b2a-b8fa-0f534b40ebfd", "date_reported_by_company": "2025-02-22T17:25:50.1109377+00:00", "id2": 36, "company_id": "df15211e-242e-41d2-a5c1-9e01efa3e6e5", "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": "bc92f015-8cb4-4644-9ed5-71a49ae5692e", "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-02-22T17:25:50.1109377+00:00" }