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": "a3b0efa5-2922-4421-928f-05d25642e2cf", "_parent_id": "12908898-d170-4948-927e-24b986c99bf8", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "0ca12971-c19f-4fb2-91a3-f3794732cd4b", "project_reference_back_office": "sample string 5", "project": { "id": "32a35aae-ae29-46e5-885c-0c3c286e9562", "_parent_id": "ae07d5a6-f769-4a49-8622-5f4913c688de", "root_parent_id": "88a22e47-3d00-42a1-a22f-539136c7f3b2", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d9df77f0-42be-4577-a74c-ae28bdbfe947", "equipment_family_code": "sample string 6", "equipment_family": { "id": "51810a6e-f418-4c5c-b338-afd8122dab81", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "142e3d62-6dc2-44f8-90aa-2ad79166a704", "_parent_code": "sample string 6", "sales_organization_id": "ea1a8616-6935-462e-84a6-9a6253dba684", "sales_organization_code": "sample string 8", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+00:00" }, "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00" }, "equipment_model_id": "6614209e-f747-489d-a62e-653d829492d4", "equipment_model_code": "sample string 8", "equipment_model": { "id": "4ab375bd-7f60-4f2c-a0ba-c02bd0c6cc43", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "ac1c6526-4ad1-4f9b-a3c5-f2d2ead9afb0", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "7cb67bd5-39d4-4be8-96a5-e2d96c80972b", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "0038331b-765a-42ea-b349-ea0285940645", "sales_organization_code": "sample string 5", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+00:00" }, "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00" }, "equipment_family_id": "66100ee4-b5e5-4c43-9a01-37905637b4f7", "equipment_family_code": "sample string 8", "equipment_family": { "id": "51810a6e-f418-4c5c-b338-afd8122dab81", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "142e3d62-6dc2-44f8-90aa-2ad79166a704", "_parent_code": "sample string 6", "sales_organization_id": "ea1a8616-6935-462e-84a6-9a6253dba684", "sales_organization_code": "sample string 8", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+00:00" }, "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00" }, "date_in_production_since": "2023-03-29T03:26:41.2223129+00:00", "date_out_of_production_since": "2023-03-29T03:26:41.2223129+00:00", "date_end_support": "2023-03-29T03:26:41.2223129+00:00", "sales_organization_id": "81d92113-74e0-4073-8fd4-55f75ceabea1", "sales_organization_code": "sample string 13", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+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": "2023-03-29T03:26:41.2223129+00:00" }, "project_status_id": "f0d63031-3201-4733-8227-0ace426aa0e0", "project_status_code": "sample string 10", "project_status": { "id": "6f6a4b8e-8c92-49e2-b044-c8d4560c4cf0", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "a60095e6-0d90-4611-bd41-8b031c93a86d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00" }, "company_id": "4a4b327f-a338-478b-9c3d-75726b6260de", "company_code": "sample string 12", "db_address_id": "e1556ec1-e93e-4c4b-bd63-afc12c3822f7", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "577c709d-5f5a-40f4-9939-37543e55a28b", "contact_reference_back_office": "sample string 17", "owner_user_id": "44f662e7-d3e7-4bc8-b4f6-f735a8ecd107", "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": "2023-03-29T03:26:41.2223129+00:00", "date_create": "2023-03-29T03:26:41.2223129+00:00", "date_update": "2023-03-29T03:26:41.2223129+00:00", "updated_by_user_id": "f0fc5e0a-2e99-4263-82c8-8a0c9372882f", "customer_reference": "sample string 28", "warranty_date_until": "2023-03-29T03:26:41.2223129+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": "2023-03-29T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2023-03-29T03:26:41.2223129+00:00", "date_last_job": "2023-03-29T03:26:41.2223129+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2023-03-29T03:26:41.2223129+00:00", "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00", "is_mobile_installation": true }, "job_type_id": "42fa4428-5664-4514-ae30-e943afa0b6e5", "job_type_code": "sample string 7", "job_type": { "id": "95229c65-dcc5-449f-a432-175705f926f2", "name": "sample string 2", "sales_organization_id": "d1dfae0c-aa59-46e4-8488-47eb8e5972c2", "description": "sample string 4", "is_default": true, "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00", "code": "sample string 7" }, "job_priority_id": "6a3fa64e-eedb-4909-b808-ab7a974fd54f", "job_priority_code": "sample string 9", "job_priority": { "id": "ddda1b91-57d3-46d2-92a3-221c2aec0c0c", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "cb4b5b95-c7a2-4262-be1c-305ed12532e3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00" }, "job_status_id": "ca7c7f68-f496-4914-9bb8-0d6c9188a994", "job_status_code": "sample string 11", "db_address_id": "3737fc8e-55ff-49a0-b64d-b342bb5281d1", "contact_id": "b5f27629-d625-467f-b044-3f51bd46e745", "requested_by_company_id": "4818e871-af54-4c5d-a894-afab406b9b25", "requested_by_contact_id": "803516a2-6f15-4bac-b56e-c337ad7e2d60", "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": "2023-03-29T03:26:41.2223129+00:00", "due_date": "2023-03-29T03:26:41.2223129+00:00", "date_create": "2023-03-29T03:26:41.2223129+00:00", "date_update": "2023-03-29T03:26:41.2223129+00:00", "date_closed": "2023-03-29T03:26:41.2223129+00:00", "suggested_user_id": "bdfc291b-e0d9-4680-abd6-eb6a67269262", "suggested_user_code": "sample string 29", "suggested_user": { "id": "438d0ec1-574a-41df-aa89-a0e1fa36704c", "db_language_id": "41e757ae-8b9f-4e45-9860-6d75f92cda63", "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": "2023-03-29T03:26:41.2223129+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e51ddd2c-23a8-4597-85d0-e67eaa2da6aa", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "1b39f817-3f6f-4e50-8d76-4ab2b8acfe26", "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": "b52b086a-90d9-4126-af7b-7959c85a0421", "private_db_country_code": "sample string 35", "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "ab03f1f3-e778-4573-b97b-9f6381780c62" }, "suggested_date_start": "2023-03-29T03:26:41.2223129+00:00", "skill_id": "e34ba0e5-f7b8-4b50-8a4a-b28f1727131f", "skill_code": "sample string 32", "skill": { "id": "be23cbb4-b688-468b-b057-085c89f2a39d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "8b031b55-40ba-4c71-bc86-ca5c4c3b5860", "sales_organization_code": "sample string 6", "sales_organization": { "id": "039dac46-7c89-4979-bd0d-1606077f02ce", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d4a3ed24-dadd-403f-b06c-6e38b1d8905b", "db_currency_id": "b7d22c17-5bfb-4c85-98dc-b00b3ace40b5", "db_language_id": "66afa7c9-c144-47d3-8846-b32b7a1ecf3c", "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": "2023-03-29T03:26:41.2223129+00:00" }, "modified_dateutc": "2023-03-29T03:26:41.2223129+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "68eb740c-4003-4110-b1cc-d84ef95aca4c", "date_reported_by_company": "2023-03-29T03:26:41.2223129+00:00", "id2": 36, "company_id": "6662fe2a-011d-4cf1-bcde-6c6586904a3c", "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": "fcd874a7-1f8b-4fa5-9faa-25393197bb07", "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": "2023-03-29T03:26:41.2223129+00:00" }