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": "2f349d6e-bb4d-4097-b843-2488dabd54cd",
"jobs_id": "db7b277b-a842-496e-8207-6fbdf78949ea",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ce1e1bac-0036-45ce-8cc2-b6f7f5f1c0d1",
"_parent_id": "6efa9e28-6d4a-4544-be67-ccd8c9c81b11",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2427f26d-5d02-46f0-9e91-4a09b722b9fb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9bded8f3-9221-42ef-95ea-d7542341905c",
"_parent_id": "6401658c-7c4b-4ba2-99b5-d4f460796c1d",
"root_parent_id": "7278b814-c7a3-44e1-818a-dd563446a8e7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f44b7016-1544-427a-b3af-98c9072d6210",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8d86cf6e-15c9-402d-950c-953fd48e0c2a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "793a41fd-9b02-4ab9-b048-e7a3d710089b",
"_parent_code": "sample string 6",
"sales_organization_id": "c4a37bcf-64f5-4ade-b55f-26a2d14cc9c4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+00:00"
},
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00"
},
"equipment_model_id": "1d057903-0b27-40d5-9ccd-70850d73cbdd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "036a612f-5332-4c0a-a490-5b9045c2f77c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "df114862-4ca5-4b16-ac4d-7b9e08acb113",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ea91c94e-81c9-47d5-9ddd-e8205a40fe94",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "65ef8e29-a60b-4cf9-96a3-92341d521a39",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+00:00"
},
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00"
},
"equipment_family_id": "25a565c7-b86d-4535-9a87-8f1496c2be14",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8d86cf6e-15c9-402d-950c-953fd48e0c2a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "793a41fd-9b02-4ab9-b048-e7a3d710089b",
"_parent_code": "sample string 6",
"sales_organization_id": "c4a37bcf-64f5-4ade-b55f-26a2d14cc9c4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+00:00"
},
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00"
},
"date_in_production_since": "2026-06-30T15:35:59.3606194+00:00",
"date_out_of_production_since": "2026-06-30T15:35:59.3606194+00:00",
"date_end_support": "2026-06-30T15:35:59.3606194+00:00",
"sales_organization_id": "38f62b26-5a16-4e8b-85c5-9623e31ea9c5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+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-30T15:35:59.3606194+00:00"
},
"project_status_id": "f996d224-c583-4200-a9d2-31e9f61f4ee9",
"project_status_code": "sample string 10",
"project_status": {
"id": "589a671a-31fe-4335-91e4-31ed9c5e2340",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "437e1472-cb0b-49b6-a9c3-fe4202b26680",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00"
},
"company_id": "9c1e7b07-dfab-4310-a72d-642eb88f3b7d",
"company_code": "sample string 12",
"db_address_id": "99490c95-f866-40fa-b6c8-3310a958f409",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "12f8482d-3fc7-4347-841f-0a05bd8f2312",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "73b6d9b5-7b13-4b78-90d7-2d3f9f7b458f",
"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-30T15:35:59.3606194+00:00",
"date_create": "2026-06-30T15:35:59.3606194+00:00",
"date_update": "2026-06-30T15:35:59.3606194+00:00",
"updated_by_user_id": "38cddc9d-16c1-46dc-8ddf-d1eda9625834",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-30T15:35:59.3606194+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-30T15:35:59.3606194+00:00",
"date_last_job": "2026-06-30T15:35:59.3606194+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-30T15:35:59.3606194+00:00",
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00",
"is_mobile_installation": true
},
"job_type_id": "5d0b90a6-b242-4c1a-aeb2-8f3b54a67b74",
"job_type_code": "sample string 7",
"job_type": {
"id": "72308316-d430-45ff-82c6-4fd17511e2ee",
"name": "sample string 2",
"sales_organization_id": "41381e8b-b11a-4de2-bf0c-f9f3ff94f71b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00",
"code": "sample string 7"
},
"job_priority_id": "7b31296c-c251-4eed-96fb-f3fc3d62dd27",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8463bffb-9a1d-4495-9760-87ad150a320d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5dae7f97-91f6-423b-bc95-cba2597b3645",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00"
},
"job_status_id": "1ee667f8-03fc-4dca-a31b-e1ce4d7d715c",
"job_status_code": "sample string 11",
"db_address_id": "1fa7c55a-7447-4251-b49d-f2dfa57047f6",
"contact_id": "d7d62e11-af15-4c83-96d2-a0977a68276c",
"requested_by_company_id": "7b473036-c375-4e3a-b439-e643f5664111",
"requested_by_contact_id": "61948757-eb57-45bd-8002-5c3cd4cfbc0e",
"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-30T15:35:59.3606194+00:00",
"due_date": "2026-06-30T15:35:59.3606194+00:00",
"date_create": "2026-06-30T15:35:59.3606194+00:00",
"date_update": "2026-06-30T15:35:59.3606194+00:00",
"date_closed": "2026-06-30T15:35:59.3606194+00:00",
"suggested_user_id": "a78183d2-0c3d-4bb4-b37e-cae9b8814ed3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e542f352-5c17-4134-8f59-0b277ed66030",
"db_language_id": "2a7dba1b-565f-4fbd-9164-50fa2a065fed",
"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-30T15:35:59.3606194+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cdbf8993-cc0f-4006-ac76-fb32de612457",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "88fd4a77-beb7-4c1d-ad99-8f07a09fa08f",
"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": "2e1e30a0-eb8a-44ae-b46c-d2922ab5f633",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cba445a9-afc4-45e6-9443-b8df2cbc5264"
},
"suggested_date_start": "2026-06-30T15:35:59.3606194+00:00",
"skill_id": "9eba0563-e8cd-4afb-95da-deff32e70ad5",
"skill_code": "sample string 32",
"skill": {
"id": "1f6b13e1-fbd0-4b9e-8303-220f27cf9223",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "835e971d-f15e-4944-8efd-e23ff079b230",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48434984-b4b1-4b4f-be3e-e0bd40c84b55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132a1f1a-2542-405e-9d1e-f23410bfbb27",
"db_currency_id": "490a18b6-7ef2-423c-a4c4-25d3aeeb6224",
"db_language_id": "3254c5ab-197b-4ba9-9c4e-9aec32d729cb",
"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-30T15:35:59.3606194+00:00"
},
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "893b9ae9-5381-4f08-8e0c-6afd87a378cc",
"date_reported_by_company": "2026-06-30T15:35:59.3606194+00:00",
"id2": 36,
"company_id": "30ca2ab9-639a-4ab3-b621-ffb78f4bb385",
"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": "d8b67802-8679-4c8f-8d4a-6dff87c7ab3e",
"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-30T15:35:59.3606194+00:00"
},
"work_instruction_details_id": "26c4273c-c459-44f8-bb67-2a5544fb3c6b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c2289dcc-da36-4da2-86ae-5b09c21c6098",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "27830d1c-72bf-4681-a739-3094e839938f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-30T15:35:59.3606194+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": "3589a6ab-ad6c-4e6d-bccf-89e44508c77a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-30T15:35:59.3606194+00:00"
}