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": "7dc0a94d-c911-41bc-8620-42fedbc7e73c", "_parent_id": "b3817475-eb7e-4dba-b6d5-cf0375e6d2b3", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "aefd095a-f579-4360-983c-cda110aa5874", "project_reference_back_office": "sample string 5", "project": { "id": "16e4c529-bb31-41f9-b670-87725e9fe928", "_parent_id": "b800c708-c87e-4f79-948d-43503535040c", "root_parent_id": "22b589b9-70b3-4e2e-9974-0df5c1bb7c0f", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "bb167d6f-364d-438b-9173-e22a56c35e05", "equipment_family_code": "sample string 6", "equipment_family": { "id": "491ea45c-397b-474e-b038-cef236fc4a6a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "93942ef9-8478-4d24-9eee-be8b84f650b3", "_parent_code": "sample string 6", "sales_organization_id": "6c0bb5fb-c8ab-4984-a06b-4aacf49d10b3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02:00" }, "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00" }, "equipment_model_id": "c7fef004-d58a-4fbc-bf28-c185622c1c42", "equipment_model_code": "sample string 8", "equipment_model": { "id": "7f7cfed6-2ebb-4e7e-a72d-ca4d7d3b0d71", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "3324466e-5088-4dfc-819b-6c102d029dfc", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "3509f144-bd54-454f-a395-0d445f7cecfe", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "97418dbb-a20f-4b87-b337-7ecd04a675dd", "sales_organization_code": "sample string 5", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02:00" }, "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00" }, "equipment_family_id": "3262cb56-fcda-44c5-ab20-6d9e121615a8", "equipment_family_code": "sample string 8", "equipment_family": { "id": "491ea45c-397b-474e-b038-cef236fc4a6a", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "93942ef9-8478-4d24-9eee-be8b84f650b3", "_parent_code": "sample string 6", "sales_organization_id": "6c0bb5fb-c8ab-4984-a06b-4aacf49d10b3", "sales_organization_code": "sample string 8", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02:00" }, "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00" }, "date_in_production_since": "2022-08-08T07:20:16.8654654+02:00", "date_out_of_production_since": "2022-08-08T07:20:16.8654654+02:00", "date_end_support": "2022-08-08T07:20:16.8654654+02:00", "sales_organization_id": "8265bcc8-22b0-46dc-ab52-2b0137cc7526", "sales_organization_code": "sample string 13", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02: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": "2022-08-08T07:20:16.8654654+02:00" }, "project_status_id": "79c88772-eef4-4f48-9991-2806f38df204", "project_status_code": "sample string 10", "project_status": { "id": "e1d6acfc-1645-4e74-a828-2446e8af5e1a", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "683320c7-a929-45dd-b1b2-4418bd940419", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02:00" }, "code": "sample string 7", "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00" }, "company_id": "d2699b68-10cb-4471-89d7-46d0ea7b76a1", "company_code": "sample string 12", "db_address_id": "2926bfca-6d35-4616-bca7-1d72a1cb6e87", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "0b260f20-a2ae-40c1-ac4b-a57a678a6805", "contact_reference_back_office": "sample string 17", "owner_user_id": "5dc41b23-f958-4fb1-8d2a-dc4b3ca0b503", "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": "2022-08-08T07:20:16.8654654+02:00", "date_create": "2022-08-08T07:20:16.8654654+02:00", "date_update": "2022-08-08T07:20:16.8654654+02:00", "updated_by_user_id": "0f54efd8-18f8-43a5-ba62-7d9c445152f0", "customer_reference": "sample string 28", "warranty_date_until": "2022-08-08T07:20:16.8654654+02: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": "2022-08-08T00:00:00+02:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2022-08-08T07:20:16.8654654+02:00", "date_last_job": "2022-08-08T07:20:16.8654654+02:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2022-08-08T07:20:16.8654654+02:00", "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00", "is_mobile_installation": true }, "job_type_id": "793b733e-747f-4a26-b03d-a44c8bb268e1", "job_type_code": "sample string 7", "job_type": { "id": "66c32f24-0003-4108-8766-b9da668f00fe", "name": "sample string 2", "sales_organization_id": "34cdf080-f7ef-4d7a-937d-bf9f3563dea4", "description": "sample string 4", "is_default": true, "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00", "code": "sample string 7" }, "job_priority_id": "9bbe27d1-1bbf-4070-93ab-2aa6b335197f", "job_priority_code": "sample string 9", "job_priority": { "id": "d6e8153e-e58c-4c8a-927e-075b1c70298a", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "863a557d-e105-4914-84d3-d48dfe258968", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02:00" }, "code": "sample string 7", "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00" }, "job_status_id": "265184fe-17b5-4d18-95b1-cc2b18423422", "job_status_code": "sample string 11", "db_address_id": "d7add813-c5f5-4e99-8864-b114ad986dd6", "contact_id": "c2caf290-ade0-40e0-9d37-d5c8ab43777c", "requested_by_company_id": "6347adfe-4ca5-4b72-b78c-d46a74aa19d1", "requested_by_contact_id": "b9452bf5-0dc2-4ae3-b5c0-4b760e5beb9c", "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": "2022-08-08T07:20:16.8654654+02:00", "due_date": "2022-08-08T07:20:16.8654654+02:00", "date_create": "2022-08-08T07:20:16.8654654+02:00", "date_update": "2022-08-08T07:20:16.8654654+02:00", "date_closed": "2022-08-08T07:20:16.8654654+02:00", "suggested_user_id": "9b456c2e-f751-4de6-89b8-500b07c275fc", "suggested_user_code": "sample string 29", "suggested_user": { "id": "4460d6d8-1b90-4696-8ed7-0f815f4318e9", "db_language_id": "93fee1ce-5661-4030-a272-282fa453357e", "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": "2022-08-08T07:20:16.8654654+02:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "700432e9-1c03-4a62-bf99-be6f3358fd29", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b0a8fbcf-9628-48a0-8819-2d6d7bb5e490", "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": "8a7c34a6-0043-4cfc-92a0-6ff08da188ca", "private_db_country_code": "sample string 35", "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "1e67b534-6de8-4f27-a44d-a285e7a36be5" }, "suggested_date_start": "2022-08-08T07:20:16.8654654+02:00", "skill_id": "7fa8a287-fefb-4644-81a0-676def16417c", "skill_code": "sample string 32", "skill": { "id": "a6b2a27c-fff7-463a-903d-70771f257907", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9ce0de52-32f6-48c1-b378-437398493e15", "sales_organization_code": "sample string 6", "sales_organization": { "id": "6d781f29-836b-4a4f-a6ba-fd5778202d2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4ccd4cf6-fb81-46aa-837a-0507b9e15a46", "db_currency_id": "0587e21c-7f1d-4971-9c1b-2516d09bfaf3", "db_language_id": "11b87ced-b54a-4e44-9fa9-faa110761a90", "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": "2022-08-08T07:20:16.8654654+02:00" }, "modified_dateutc": "2022-08-08T07:20:16.8654654+02:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "8f476169-16e1-4034-ae47-78003718fa81", "date_reported_by_company": "2022-08-08T07:20:16.8654654+02:00", "id2": 36, "company_id": "113dab04-5b1e-4966-941c-1b3bdfdde2a9", "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": "8c3bcbf4-9e5f-4c93-96da-ecbbdd3eb4f2", "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": "2022-08-08T07:20:16.8654654+02:00" }