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": "de839f74-9f74-4c77-bd1d-0dafacecf9ab",
"jobs_id": "c7d5aadf-2447-4f50-bd21-123fb99fdb55",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "90688545-1e06-44d7-a0e6-d23cf212e066",
"_parent_id": "aa0a9578-606b-4097-8ead-8822c808a8ac",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "37e1af48-2833-4677-a767-9b2aaf4be7ee",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f610923f-a17a-45ce-9452-8b4affb5b32c",
"_parent_id": "12a2d138-6e3b-4f8b-add9-35a4105a593d",
"root_parent_id": "71387203-5555-4c2a-a1dc-3ad8e34466fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9cb450f0-2079-4cf0-b0af-5f53f131b664",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ea1647f5-51ae-4b78-b611-44fba55f3233",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a91273ce-9991-4a97-89d1-a07c41663ceb",
"_parent_code": "sample string 6",
"sales_organization_id": "661335de-c80b-41da-9b67-a5189ca0f72b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+00:00"
},
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00"
},
"equipment_model_id": "65ea78ad-669c-4deb-ab0b-9b82a3218f53",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "128489d2-f4ed-472a-a5c0-ce8e504e899c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d393939e-4312-4423-9962-d6c4e483cc58",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "353acd16-73d6-416b-a546-abb6cf87a4fa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fa0a1806-c51d-4fff-9796-84e869e048d2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+00:00"
},
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00"
},
"equipment_family_id": "b930ce8c-cfaa-4fc5-9dc1-edee2d326d31",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ea1647f5-51ae-4b78-b611-44fba55f3233",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a91273ce-9991-4a97-89d1-a07c41663ceb",
"_parent_code": "sample string 6",
"sales_organization_id": "661335de-c80b-41da-9b67-a5189ca0f72b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+00:00"
},
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00"
},
"date_in_production_since": "2026-09-03T15:50:37.639189+00:00",
"date_out_of_production_since": "2026-09-03T15:50:37.639189+00:00",
"date_end_support": "2026-09-03T15:50:37.639189+00:00",
"sales_organization_id": "35e35775-c43e-41d6-ba8d-91f4a2e7752b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+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-09-03T15:50:37.639189+00:00"
},
"project_status_id": "e1045038-9279-41ec-8b0c-a19947d005e4",
"project_status_code": "sample string 10",
"project_status": {
"id": "7a7abcf8-42eb-48b6-853a-15d999333485",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "02191bc2-dc02-4a22-96c2-df32e5b9b74d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00"
},
"company_id": "282e0d8d-f939-4a0d-85c0-71dd44488adc",
"company_code": "sample string 12",
"db_address_id": "18369cf1-da04-427b-b26a-631195a33a24",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "298ec11f-d851-4c97-b6f8-44eb70142a57",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "605e1367-4e95-40da-8daf-9acf5d135903",
"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-09-03T15:50:37.639189+00:00",
"date_create": "2026-09-03T15:50:37.639189+00:00",
"date_update": "2026-09-03T15:50:37.639189+00:00",
"updated_by_user_id": "5d6a1401-fbe8-41bd-9be2-a0d8d99cf3db",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-03T15:50:37.639189+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-09-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-03T15:50:37.639189+00:00",
"date_last_job": "2026-09-03T15:50:37.639189+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-03T15:50:37.639189+00:00",
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00",
"is_mobile_installation": true
},
"job_type_id": "7d93ce50-c4f6-4b9a-8fb9-fbc376a04afb",
"job_type_code": "sample string 7",
"job_type": {
"id": "f5f0783c-43d9-4855-a2c5-ce9d6ced0266",
"name": "sample string 2",
"sales_organization_id": "251c90f2-928e-4952-931d-b8afa9d6f194",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00",
"code": "sample string 7"
},
"job_priority_id": "327f185f-ad11-4a27-a4d8-46ae502c5fc0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4452105f-fccd-49a7-b8d5-35b72f7489e9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ff5fba09-408b-45bb-9cbf-e2c60327ea32",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00"
},
"job_status_id": "cba21c63-11e0-4339-91f0-5899b459687f",
"job_status_code": "sample string 11",
"db_address_id": "2b4afaaa-bdeb-4550-994a-d0d71fd4da15",
"contact_id": "128f4f1d-3eba-4647-b705-3578982ab109",
"requested_by_company_id": "4c5124b0-ec81-4239-8f44-8be69cc2f8b7",
"requested_by_contact_id": "bc319850-fcd6-4904-bc9b-45e0c7915cab",
"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-09-03T15:50:37.639189+00:00",
"due_date": "2026-09-03T15:50:37.639189+00:00",
"date_create": "2026-09-03T15:50:37.639189+00:00",
"date_update": "2026-09-03T15:50:37.639189+00:00",
"date_closed": "2026-09-03T15:50:37.639189+00:00",
"suggested_user_id": "dc6ab57e-aa91-4d90-bf50-cad7f76440d7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5af91bc8-413a-4bf8-8a5f-8c5cadf32577",
"db_language_id": "cd213075-db9a-41c3-b0a9-da3006ae5366",
"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-09-03T15:50:37.639189+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3f9f9bcb-c914-4309-aaa1-444ad4f448e4",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8b15704c-2264-4851-b893-95177b937a4b",
"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": "fab9b1ca-535b-4ff8-b83f-f854c3f0c6fc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3cb7a462-d62b-4ebe-b6b9-ec727e213974"
},
"suggested_date_start": "2026-09-03T15:50:37.639189+00:00",
"skill_id": "46bc0445-ae4c-4e1b-80d5-2867079be861",
"skill_code": "sample string 32",
"skill": {
"id": "21c34f49-f5b3-4c7f-8c71-78ff5bb9d82c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "550b6f80-17ed-4408-9848-c0a9c6b51117",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "347b97a4-1352-46e2-9ab2-8facdf65e575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea8cae9e-9511-4bb1-b208-8485d77e0abc",
"db_currency_id": "9d7cac34-723e-450c-9496-1be75fcd1ac9",
"db_language_id": "7426b808-1dcd-4a41-9d0c-7d9e8fe52546",
"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-09-03T15:50:37.639189+00:00"
},
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8cd018c2-7b3b-4c5f-b2d6-73a5b188c109",
"date_reported_by_company": "2026-09-03T15:50:37.639189+00:00",
"id2": 36,
"company_id": "7fe3b115-dfdc-4e44-85fd-12215137dd66",
"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": "dec3b1f8-5337-430a-ba71-8a477822ba39",
"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-09-03T15:50:37.639189+00:00"
},
"work_instruction_details_id": "949075e8-a105-477d-80be-18d68a714f79",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f35a7de9-81da-4f4f-bc48-cdc69a5184ac",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1d820ff4-04dc-4c7a-bc6e-2094888d40ac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-03T15:50:37.639189+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": "45f664f0-c82b-4154-9b00-90281a33ce5f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-03T15:50:37.639189+00:00"
}