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": "8792ab11-b639-40dc-88ec-abbeefff9b03", "_parent_id": "53be7f24-05ae-43ed-b4af-5c4ed3218c29", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "97b3c0e4-115b-4f85-bb80-90b0124c8e6e", "project_reference_back_office": "sample string 5", "project": { "id": "b57fee35-c1ea-4638-aacf-d4026f3a8ca6", "_parent_id": "5f3014e8-0fee-4010-864c-91b79bb932b2", "root_parent_id": "447918cd-ce72-4fde-aba1-375c194880e5", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d5e2fb9e-df30-43b6-acf8-711fdf4a8c32", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f4efc792-20c4-446f-9420-7ce3a00d20dd", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b085a909-ebfe-4a49-a865-dbd79c6e629a", "_parent_code": "sample string 6", "sales_organization_id": "b619318a-6910-4704-bb4b-0e357e0959d2", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+00:00" }, "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00" }, "equipment_model_id": "27b0a859-7c41-4ce6-aee8-63690947bbcb", "equipment_model_code": "sample string 8", "equipment_model": { "id": "47635b43-7c6e-45f4-bf89-3d8137dcdf23", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "d247d3f1-0080-4e55-9650-2a996db3cdf7", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "ee62f93e-7b5f-4af0-a0da-8cabf9834a23", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "f8afed61-3ce4-4664-b829-7f2483318e87", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+00:00" }, "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00" }, "equipment_family_id": "e42b8024-bd5a-499c-91b9-8dbc4c1942ac", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f4efc792-20c4-446f-9420-7ce3a00d20dd", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "b085a909-ebfe-4a49-a865-dbd79c6e629a", "_parent_code": "sample string 6", "sales_organization_id": "b619318a-6910-4704-bb4b-0e357e0959d2", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+00:00" }, "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00" }, "date_in_production_since": "2024-04-17T09:26:08.8307352+00:00", "date_out_of_production_since": "2024-04-17T09:26:08.8307352+00:00", "date_end_support": "2024-04-17T09:26:08.8307352+00:00", "sales_organization_id": "7a534c05-ee6a-4c77-827c-b769772d77e1", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+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": "2024-04-17T09:26:08.8307352+00:00" }, "project_status_id": "c965d712-441a-4dee-8648-73d3046da3de", "project_status_code": "sample string 10", "project_status": { "id": "392003d5-ad1f-45a8-8423-695b2d290ee1", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "33efe846-44c6-4bd2-8c83-39679c766e6d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00" }, "company_id": "952fb0ca-9ccd-4d69-abea-4f969334fe34", "company_code": "sample string 12", "db_address_id": "90039f59-3b12-448e-991e-61f432ad909d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "b13f2887-922c-4cdd-891c-52ebd051d66f", "contact_reference_back_office": "sample string 17", "owner_user_id": "c09633b3-b0dc-4554-ba47-d22a34e21c47", "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": "2024-04-17T09:26:08.8307352+00:00", "date_create": "2024-04-17T09:26:08.8307352+00:00", "date_update": "2024-04-17T09:26:08.8307352+00:00", "updated_by_user_id": "aab32e26-53d4-4eca-84be-545e6b485c56", "customer_reference": "sample string 28", "warranty_date_until": "2024-04-17T09:26:08.8307352+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": "2024-04-17T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-04-17T09:26:08.8307352+00:00", "date_last_job": "2024-04-17T09:26:08.8307352+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-04-17T09:26:08.8307352+00:00", "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00", "is_mobile_installation": true }, "job_type_id": "df147728-a5b4-4684-92a2-4cce2d8c50f4", "job_type_code": "sample string 7", "job_type": { "id": "fbb0e34c-0434-4926-8aa8-91aa89216a0f", "name": "sample string 2", "sales_organization_id": "ad02f4a1-bb34-4c88-99c7-99ae97ba1890", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00", "code": "sample string 7" }, "job_priority_id": "980ed09d-454e-425f-8079-50984a345132", "job_priority_code": "sample string 9", "job_priority": { "id": "a4222697-4dc8-4f78-b9ac-7bedbbfa9cba", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "beaaa533-150c-4e4b-9455-57b4cf09cfb3", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00" }, "job_status_id": "498e08ac-2610-4d4b-a260-347e4387c83d", "job_status_code": "sample string 11", "db_address_id": "45132ef5-a0ba-4c3b-a2db-9d63dd09a529", "contact_id": "e8d6ebdb-c574-4f5b-bb33-6ad1c03d5087", "requested_by_company_id": "3e8ef646-2649-4201-b25c-864144314f45", "requested_by_contact_id": "144c8205-daf2-47ba-9710-1faf2e90dd6a", "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": "2024-04-17T09:26:08.8307352+00:00", "due_date": "2024-04-17T09:26:08.8307352+00:00", "date_create": "2024-04-17T09:26:08.8307352+00:00", "date_update": "2024-04-17T09:26:08.8307352+00:00", "date_closed": "2024-04-17T09:26:08.8307352+00:00", "suggested_user_id": "0e0b6fae-998d-485f-abbb-32d312f4aa92", "suggested_user_code": "sample string 29", "suggested_user": { "id": "b8540a48-116a-47f9-9904-a1f131296dfe", "db_language_id": "7547d7a7-d160-4d6f-b302-6084e2086ff7", "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": "2024-04-17T09:26:08.8307352+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "94f345bd-f767-4e29-8220-9d4d935277ff", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "1d7e8240-7143-4d08-8743-09bebfe2545b", "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": "110496f2-e31a-4689-ac6d-12bbf2dd81f3", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "0b063b5b-69e3-45f1-9512-cd55d760b352" }, "suggested_date_start": "2024-04-17T09:26:08.8307352+00:00", "skill_id": "6986e6b3-5ff0-4c72-8cdf-42cac249e7a5", "skill_code": "sample string 32", "skill": { "id": "1d4a92c1-62f9-4a6b-9719-a2efa94aa775", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "30d7486f-6ad5-4374-9c4f-5933834b5b40", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1b09ebee-d928-40d9-bf81-b363ae1c65b5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c543303b-6d0a-4141-ae2e-9eaa13b49bb6", "db_currency_id": "8199d708-bb6a-4df5-9281-80ee0934b427", "db_language_id": "a0e14095-97b6-4f4d-b6cc-4eb27ef970bc", "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": "2024-04-17T09:26:08.8307352+00:00" }, "modified_dateutc": "2024-04-17T09:26:08.8307352+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "76e5ba7c-5c7b-42f9-801e-15c6707fbc6b", "date_reported_by_company": "2024-04-17T09:26:08.8307352+00:00", "id2": 36, "company_id": "a7e59b22-bfc4-430d-8ce2-3014bf6c499e", "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": "e49f1db2-7286-4326-8ad0-c12e138a1da8", "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": "2024-04-17T09:26:08.8307352+00:00" }