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": "4a95f4bc-4dd9-4dd7-bf51-ac67ffac492a",
"jobs_id": "38274713-976c-46cb-a788-817519af9739",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a379f5ce-1a84-41a7-81b4-42dc01fdc48e",
"_parent_id": "5aea59b5-dac9-4c1e-a87c-49538e49fc30",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7ce12017-d999-435e-8670-e44c4cb8e748",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cfc046d4-db41-4060-84bc-fd38aaa44f30",
"_parent_id": "007c72f1-f3c0-4ad9-bbf0-786d59f8aedd",
"root_parent_id": "ced1306a-01c3-4f07-921c-00e5ea8cbf48",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f0356923-d1d0-42fe-a195-a43983314763",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8d527f4e-81de-4872-86d3-cc0bf7f5800c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f54e2c1c-c472-4ab5-a9cc-2e1a2e3e264f",
"_parent_code": "sample string 6",
"sales_organization_id": "1f10e8df-a6e0-4901-b819-e07deed014b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+00:00"
},
"modified_dateutc": "2026-06-01T22:34:18.521869+00:00"
},
"equipment_model_id": "aeefa567-2494-4703-80be-8ce2bfc65fa9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c53f78b-b78e-41c9-b5e6-ccde571150b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e5be72ec-6e07-440e-89b8-16246ae4e634",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dd28593a-e802-4b9a-b909-82bf4941c5f5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b2b9c5c3-8bac-4459-952c-44cd1fe5c3c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+00:00"
},
"modified_dateutc": "2026-06-01T22:34:18.521869+00:00"
},
"equipment_family_id": "5288ccbf-8f86-46aa-a34d-f057e08dbd78",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8d527f4e-81de-4872-86d3-cc0bf7f5800c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f54e2c1c-c472-4ab5-a9cc-2e1a2e3e264f",
"_parent_code": "sample string 6",
"sales_organization_id": "1f10e8df-a6e0-4901-b819-e07deed014b7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+00:00"
},
"modified_dateutc": "2026-06-01T22:34:18.521869+00:00"
},
"date_in_production_since": "2026-06-01T22:34:18.521869+00:00",
"date_out_of_production_since": "2026-06-01T22:34:18.521869+00:00",
"date_end_support": "2026-06-01T22:34:18.521869+00:00",
"sales_organization_id": "3f1a3103-7a68-4232-bd70-5987602364cf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+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": "2026-06-01T22:34:18.5374913+00:00"
},
"project_status_id": "e45e07c3-699b-434c-bd62-b4a3b716ca3c",
"project_status_code": "sample string 10",
"project_status": {
"id": "494c9edc-cc69-4f2f-9cf3-d639a2002eb5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "62572770-6a22-4681-8297-51bdf723a026",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-01T22:34:18.5374913+00:00"
},
"company_id": "f6b27158-2148-4c7c-914a-cffa140add02",
"company_code": "sample string 12",
"db_address_id": "541d8e89-20db-4ffe-b75c-906a92d9ee16",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "318d4963-26e3-49f6-839a-56dbe0af1ff2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "372f69d8-1764-421a-8b35-72533ec4a910",
"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": "2026-06-01T22:34:18.5374913+00:00",
"date_create": "2026-06-01T22:34:18.5374913+00:00",
"date_update": "2026-06-01T22:34:18.5374913+00:00",
"updated_by_user_id": "c842156d-e163-4bff-8a01-0cd515d8a032",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-01T22:34:18.5374913+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": "2026-06-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-01T22:34:18.5374913+00:00",
"date_last_job": "2026-06-01T22:34:18.5374913+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-01T22:34:18.5374913+00:00",
"modified_dateutc": "2026-06-01T22:34:18.5374913+00:00",
"is_mobile_installation": true
},
"job_type_id": "c0ebaa9d-df94-470a-8560-355797df465b",
"job_type_code": "sample string 7",
"job_type": {
"id": "7a5871a6-c777-42a5-86f9-394d18db6340",
"name": "sample string 2",
"sales_organization_id": "619389d6-adb8-4608-808a-e46425cf0c2c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-01T22:34:18.5374913+00:00",
"code": "sample string 7"
},
"job_priority_id": "2f0dfd03-2f2e-42d4-b569-f4bd7ab3155e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fc38b9c0-c285-4654-b708-efb9b423d67f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9c215ab9-a89c-4cff-b183-5f5679b7e6a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-01T22:34:18.5374913+00:00"
},
"job_status_id": "ed8f1208-2f0a-4aee-aa99-e9c9307642b9",
"job_status_code": "sample string 11",
"db_address_id": "e6a582ae-8e35-4144-869c-7f49d0244722",
"contact_id": "50c30425-249c-4ae2-8cda-5f0c99e7055d",
"requested_by_company_id": "15350607-c7fe-4743-bffc-ee588da9d352",
"requested_by_contact_id": "f423af34-25eb-463f-9e12-87aab107400e",
"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": "2026-06-01T22:34:18.5374913+00:00",
"due_date": "2026-06-01T22:34:18.5374913+00:00",
"date_create": "2026-06-01T22:34:18.5374913+00:00",
"date_update": "2026-06-01T22:34:18.5374913+00:00",
"date_closed": "2026-06-01T22:34:18.5374913+00:00",
"suggested_user_id": "1a6cbcd0-3ced-4d78-8318-8455bcdde3fc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5687530d-fdf1-4342-89b8-ae1290a256dc",
"db_language_id": "19d17201-2db4-44ba-b955-91182d6d815d",
"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": "2026-06-01T22:34:18.5374913+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "01d60523-7b41-4225-9278-1d2ef225c18c",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "61132685-df28-4c3e-83ba-2ecd3ee59add",
"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": "576b4c6d-59f8-4820-a38a-0553bd13ae90",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-01T22:34:18.5374913+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "66da6555-8b57-4e27-ad66-78a86f27f1e2"
},
"suggested_date_start": "2026-06-01T22:34:18.5374913+00:00",
"skill_id": "58db5c8f-5e0e-4809-a562-91a24c783ada",
"skill_code": "sample string 32",
"skill": {
"id": "af97fb51-8b05-4baa-a5cf-f932ef07aa42",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a5db02c0-acea-4b4f-89da-2d54242ce34b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9f755caa-1340-4b39-9d10-2e726ee366f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de6aeb5d-f0ba-43ad-8b7a-3e6ffb86dccd",
"db_currency_id": "e53d0e1f-b230-4e37-9cf5-26aa1bcf4619",
"db_language_id": "6022ef2a-d125-4b45-8689-1d91c3041165",
"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": "2026-06-01T22:34:18.521869+00:00"
},
"modified_dateutc": "2026-06-01T22:34:18.5374913+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8121c570-6d11-4730-8339-5888e134e438",
"date_reported_by_company": "2026-06-01T22:34:18.5374913+00:00",
"id2": 36,
"company_id": "16b322df-02a3-4b0e-ab7d-4d627cfed288",
"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": "0cc92762-a4c4-424b-8c52-9f13ead202b3",
"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": "2026-06-01T22:34:18.5374913+00:00"
},
"work_instruction_details_id": "c5725895-2cb8-44a1-af4d-0701c3af9ea2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9ca18624-f6a6-42da-9860-184f8bc4eea6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a083df15-c947-4756-b88f-72278fa3ae52",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-01T22:34:18.5374913+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": "be458a12-b97e-4443-8c4a-612e020a02d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-01T22:34:18.5374913+00:00"
}