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": "0689b70c-4c80-455b-91b0-0db1cbfe3019",
"jobs_id": "b6a2fd1d-7314-4143-88ac-75ef3072e028",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5a795c16-b6c6-4e60-8170-519ed58236b2",
"_parent_id": "6e6e1919-0ca8-476d-802c-be34816fea31",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aafb8020-3791-4811-8222-e8354b49af37",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fe11ddaf-7536-4cfb-9593-e176c6b80aa0",
"_parent_id": "028b7424-ea73-491f-affe-e1432e2dc6ac",
"root_parent_id": "90986564-d14d-4d06-865b-aa32444b53bb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "252fd591-3399-4672-aa8d-80035c3a4a9b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7801368f-6b1b-44f2-8458-cd13124b7a92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e83c3e5-6e35-4608-b304-03531411d92f",
"_parent_code": "sample string 6",
"sales_organization_id": "2a911420-0e31-48e8-9517-33f95899cc83",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+00:00"
},
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00"
},
"equipment_model_id": "c247a3a3-bda1-48ac-ab00-df0a57307e1b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5dbb5268-d2b4-466e-805e-214b6876d2db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a6921ee2-a334-4301-83c3-27a4092a8573",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0d100a85-0a00-47d9-a2b8-c7ddb70377a8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b25f11c-36c4-48fd-b07b-e9b102fd72aa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+00:00"
},
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00"
},
"equipment_family_id": "458d1e03-42e9-48d7-9b8d-d0862f2ccf6f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7801368f-6b1b-44f2-8458-cd13124b7a92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e83c3e5-6e35-4608-b304-03531411d92f",
"_parent_code": "sample string 6",
"sales_organization_id": "2a911420-0e31-48e8-9517-33f95899cc83",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+00:00"
},
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00"
},
"date_in_production_since": "2026-06-27T15:07:55.6436754+00:00",
"date_out_of_production_since": "2026-06-27T15:07:55.6436754+00:00",
"date_end_support": "2026-06-27T15:07:55.6436754+00:00",
"sales_organization_id": "bacd4cd2-fc90-4678-82c7-9870897d89ba",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+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-27T15:07:55.6436754+00:00"
},
"project_status_id": "b74697b5-53b0-4489-a6e2-c06aca108152",
"project_status_code": "sample string 10",
"project_status": {
"id": "da7590f1-4742-4132-8ee2-1782b2ad230a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "187d8008-0219-49b8-8b56-b65c5c57e33f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00"
},
"company_id": "4b8848f8-c716-4cc8-a59e-228d87e4161e",
"company_code": "sample string 12",
"db_address_id": "e658ee0e-ba25-4cd5-84ec-b43702c219fc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cdbc29c1-13ae-4835-acfd-2749016c14e8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ceabeaa5-563d-4c91-b02a-8d40e37e341c",
"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-27T15:07:55.6436754+00:00",
"date_create": "2026-06-27T15:07:55.6436754+00:00",
"date_update": "2026-06-27T15:07:55.6436754+00:00",
"updated_by_user_id": "b41b1b98-b828-4411-9996-6624e5d65940",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-27T15:07:55.6436754+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-27T15:07:55.6436754+00:00",
"date_last_job": "2026-06-27T15:07:55.6436754+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-27T15:07:55.6436754+00:00",
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00",
"is_mobile_installation": true
},
"job_type_id": "03651810-f77b-4035-8089-82fb9d5e0c77",
"job_type_code": "sample string 7",
"job_type": {
"id": "86f29107-361f-42af-b41c-d89af98026d3",
"name": "sample string 2",
"sales_organization_id": "e568a5e7-eb4e-4860-95f9-36d7fcdd599b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00",
"code": "sample string 7"
},
"job_priority_id": "2746e9e7-7828-4261-bab5-9e4645f58d3f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "eb5a402f-69a6-46b2-b2b6-e0ca2b8e3294",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1e5dd1c2-e9cf-4474-ab64-fb0dc191360d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00"
},
"job_status_id": "0bb719d8-4578-481b-8ae0-50ab97a8a8c9",
"job_status_code": "sample string 11",
"db_address_id": "df003a43-3319-43fe-b87f-4836a66d40a5",
"contact_id": "98fa1de9-dd1d-4973-8419-5c69323a0a74",
"requested_by_company_id": "4a402a2d-a3a5-4d54-ab63-73b4070e7efc",
"requested_by_contact_id": "690b2422-c119-4188-97b9-1c11e4d69a01",
"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-27T15:07:55.6436754+00:00",
"due_date": "2026-06-27T15:07:55.6436754+00:00",
"date_create": "2026-06-27T15:07:55.6436754+00:00",
"date_update": "2026-06-27T15:07:55.6436754+00:00",
"date_closed": "2026-06-27T15:07:55.6436754+00:00",
"suggested_user_id": "c82ac61b-85ed-4558-8ebf-4dc0353450da",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7412480a-29e4-4f3e-b08c-77f5ce35eeed",
"db_language_id": "10b32a1a-6356-4db5-aca4-ff137262e000",
"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-27T15:07:55.6436754+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "008416a3-6542-47b9-aecf-7987fce474ef",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bb487ba5-1b50-42a4-aa36-eeb1991a0a12",
"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": "7f52011d-f1c2-496b-a1fc-cbbd0ddfa106",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4c32339a-7d75-403d-b225-a1ea18c47ae6"
},
"suggested_date_start": "2026-06-27T15:07:55.6436754+00:00",
"skill_id": "928b4a0c-41a4-461f-9225-c7fb323c10e5",
"skill_code": "sample string 32",
"skill": {
"id": "968a9b89-4e6f-41ac-b223-ef3a819b5bc1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6cf21161-d40e-42e1-bc6e-63c7adb705b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "50439102-80d9-4377-b10f-7c0c90a90dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04e1230-6355-4f6d-bd95-9475dee7ef83",
"db_currency_id": "f3cbf590-90b6-4e82-99fc-ca56812b5210",
"db_language_id": "23b62752-64a6-4292-b1a8-f243fea6d979",
"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-27T15:07:55.6436754+00:00"
},
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "79361805-85f9-497d-a32d-89fbf40d6114",
"date_reported_by_company": "2026-06-27T15:07:55.6436754+00:00",
"id2": 36,
"company_id": "a33e4ddf-b4c0-4c58-ba50-eb6283d351f3",
"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": "5609292d-3ebe-49c8-9f49-0b4349782a77",
"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-27T15:07:55.6436754+00:00"
},
"work_instruction_details_id": "2471cfe6-9192-4621-95ff-d0ba5bfd5156",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2000ddc0-04cf-4e17-8b98-d7e7fac0f8aa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fe0ae042-d17a-4fd2-a39d-862af6608a2d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-27T15:07:55.6436754+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": "20d373a1-0ff2-4921-9810-418d819ae408",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-27T15:07:55.6436754+00:00"
}