Retrieves the job work instruction list 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 :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "54e11436-8391-484f-853c-4a5380bc51cf",
"jobs_id": "498df5d6-5509-436c-8b4e-e51df65167cf",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "744406ba-62e7-427f-80fd-a9d17651e9b8",
"_parent_id": "4d98578d-38c1-4366-856d-85fce74df898",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "059404f7-1807-460c-9923-62fd014bfcde",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9f78d716-aad0-4514-96d1-13441455df17",
"_parent_id": "e6110cce-3bc7-413d-a9a0-67b566ba85ca",
"root_parent_id": "139390f2-a5a0-4a3a-9508-c70268049355",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f3e2b2a0-dab2-41dc-a9f4-87985e788ab8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8bc0b4c6-33f9-4ce5-9c7b-0a5d0d3deb4e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4134c8b-bcd2-49c2-8765-dc5f5ea07838",
"_parent_code": "sample string 6",
"sales_organization_id": "4d2d0828-5889-4b73-8418-b9e520c48e54",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+00:00"
},
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00"
},
"equipment_model_id": "eb10ded1-e42e-42c1-9831-e10ef1879467",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "433512f5-eeb9-41ad-81e5-844dbe6171c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eaf79713-a2c3-471b-a2f2-2cca8c3924c2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a2295ec0-fce2-4ef4-b8b4-05397e6fc82a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f35f69b5-2f20-4ae1-a021-ecf2329fd0c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+00:00"
},
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00"
},
"equipment_family_id": "d1e81896-6a4a-46c4-b187-174faafdc94d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8bc0b4c6-33f9-4ce5-9c7b-0a5d0d3deb4e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a4134c8b-bcd2-49c2-8765-dc5f5ea07838",
"_parent_code": "sample string 6",
"sales_organization_id": "4d2d0828-5889-4b73-8418-b9e520c48e54",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+00:00"
},
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00"
},
"date_in_production_since": "2023-03-31T22:13:12.1524838+00:00",
"date_out_of_production_since": "2023-03-31T22:13:12.1524838+00:00",
"date_end_support": "2023-03-31T22:13:12.1524838+00:00",
"sales_organization_id": "c203e764-e06b-41c2-a73b-9c2926cfdc4e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+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-31T22:13:12.1524838+00:00"
},
"project_status_id": "9764ff2f-53b0-4b1a-b48a-e53dc6dd6be0",
"project_status_code": "sample string 10",
"project_status": {
"id": "0c58c2c5-0dbf-4d20-99e3-d964fe12c5ae",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b087c5d5-f3be-48c9-9f71-2033e4a64f0f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00"
},
"company_id": "878a01e1-fcd5-4fba-87aa-aa1111c11da4",
"company_code": "sample string 12",
"db_address_id": "4c56f488-aaf9-4d89-8503-19a7fc2f2505",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9a68ef7c-ac14-45bc-a57b-cf5c67a49917",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f9da253d-8abe-4d66-b8cf-e43ddfa27675",
"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-31T22:13:12.1524838+00:00",
"date_create": "2023-03-31T22:13:12.1524838+00:00",
"date_update": "2023-03-31T22:13:12.1524838+00:00",
"updated_by_user_id": "85f5fc12-6277-43d9-83f0-b96f2b77bd65",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-03-31T22:13:12.1524838+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-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-03-31T22:13:12.1524838+00:00",
"date_last_job": "2023-03-31T22:13:12.1524838+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-03-31T22:13:12.1524838+00:00",
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00",
"is_mobile_installation": true
},
"job_type_id": "e68258a1-b4cc-48fe-a1a2-732fa771b2de",
"job_type_code": "sample string 7",
"job_type": {
"id": "397bd952-e53f-46b6-a4df-7de1615cca5e",
"name": "sample string 2",
"sales_organization_id": "4e724dae-8d7d-4861-b9e2-9ae1d2ac0b91",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00",
"code": "sample string 7"
},
"job_priority_id": "ef8c9d87-315a-4ae9-a504-048c32925bc9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3be57bc0-f0f3-4808-8fcf-204940ae245d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3f416e3e-cb4b-41ec-a84a-33f352781d31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00"
},
"job_status_id": "eb29aac5-19e0-42c9-af40-7b8b593a8c7e",
"job_status_code": "sample string 11",
"db_address_id": "81645455-8de6-4089-81c6-c9fca02d539e",
"contact_id": "092d5995-9ca7-410c-b72f-401a96589045",
"requested_by_company_id": "9cc8fdfd-afc1-45e9-8a28-75836e56c2c8",
"requested_by_contact_id": "dd11c932-6464-46c6-8a35-e586569c5447",
"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-31T22:13:12.1524838+00:00",
"due_date": "2023-03-31T22:13:12.1524838+00:00",
"date_create": "2023-03-31T22:13:12.1524838+00:00",
"date_update": "2023-03-31T22:13:12.1524838+00:00",
"date_closed": "2023-03-31T22:13:12.1524838+00:00",
"suggested_user_id": "7c473493-2df4-40a0-897d-3f2e6d07347c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9b2d8a7b-425b-4b7b-9bee-9579e6899c74",
"db_language_id": "2d12b7dc-58d4-4ca4-ae86-a900b4d8cd39",
"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-31T22:13:12.1524838+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b7b94ddc-52ac-4d7f-9773-28190cfd8114",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "108f6409-4bff-4460-b976-46c0208837d3",
"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": "82911609-2f9b-4472-b331-6097f05a6af5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4edd47ce-1340-4ecd-bd9d-092ef421ab05"
},
"suggested_date_start": "2023-03-31T22:13:12.1524838+00:00",
"skill_id": "a53989c8-b10d-4455-afac-a958121a18ca",
"skill_code": "sample string 32",
"skill": {
"id": "5c7ef38d-a068-4da6-a311-f4521f9b9565",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "175feb95-77fd-4a9c-aab2-27b22eecbbb2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a09b1b62-11fe-403a-a18e-e29ec5740e22",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77301452-3985-4240-8fb0-45447c078430",
"db_currency_id": "da19d4b7-9500-4c23-b216-923df48815a9",
"db_language_id": "51036876-f777-4b8e-bf8d-8d37c36a4669",
"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-31T22:13:12.1524838+00:00"
},
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e166e914-4a64-4e6a-bfc5-8d6a5175b077",
"date_reported_by_company": "2023-03-31T22:13:12.1524838+00:00",
"id2": 36,
"company_id": "168d459b-1a2c-4c58-b392-a382765ff2d3",
"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": "7d4e30e8-7601-4c3d-9e20-7d218f65bf31",
"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-31T22:13:12.1524838+00:00"
},
"work_instruction_details_id": "61bd7366-897a-4949-84a9-a7028c0ed462",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eb6bb73c-ef1b-4f7c-bd7e-9bf719b82bb6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1b74a027-b3cb-46f6-99cc-04ae93096ca4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-03-31T22:13:12.1524838+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "3a200425-5196-4101-9c9f-e689eedc0f3b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-03-31T22:13:12.1524838+00:00"
}