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": "77097146-ec8a-4c38-8db5-ef76b91d3da5",
"jobs_id": "edfc1bdd-c7d5-48b4-b33c-9ca5c3740890",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "58c22b5f-e4c2-4b19-861a-294053bb22bb",
"_parent_id": "4676375a-8209-4c0f-aa06-30d71b1dd847",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "074f676b-a31a-41a4-8769-0b70544d5d67",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3bc6cc8c-fbc6-43d6-83c5-22a3030ca9bf",
"_parent_id": "9e6203fe-b9c2-4b59-99a0-0d8c9394261e",
"root_parent_id": "b3716481-9845-4fec-909b-f2362ab71e5a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0956eb9d-170d-4497-b2b4-15be3e3202e9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "870f708b-9bfe-4464-a01c-91d5e5e45b30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7497cc12-39db-4534-9d7b-6f1b72bf5b5b",
"_parent_code": "sample string 6",
"sales_organization_id": "d2a88e0f-2008-4cd9-a639-b257427bb3f9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+00:00"
},
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00"
},
"equipment_model_id": "18ab0a9d-7d85-4985-8b5b-1f94fc9c5b4d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "163825aa-0017-46e8-a21c-63daf1e1bc2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6971b8fa-8751-4d06-83a5-bee361125c3c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "75c0f115-3a60-4afe-97de-9193203087b0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5dfadc4a-e4ed-49e5-8cc4-54ab421da243",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+00:00"
},
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00"
},
"equipment_family_id": "c0a3b7f2-9096-449d-827c-2b40593f2e89",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "870f708b-9bfe-4464-a01c-91d5e5e45b30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7497cc12-39db-4534-9d7b-6f1b72bf5b5b",
"_parent_code": "sample string 6",
"sales_organization_id": "d2a88e0f-2008-4cd9-a639-b257427bb3f9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+00:00"
},
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00"
},
"date_in_production_since": "2026-07-22T11:30:34.645776+00:00",
"date_out_of_production_since": "2026-07-22T11:30:34.645776+00:00",
"date_end_support": "2026-07-22T11:30:34.645776+00:00",
"sales_organization_id": "4b33ff60-c895-4fd6-a130-3e1b57819a35",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+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-07-22T11:30:34.645776+00:00"
},
"project_status_id": "d87f59fd-48bb-4dc0-9949-486b4084f49b",
"project_status_code": "sample string 10",
"project_status": {
"id": "17550a53-431b-43ce-9d68-031511882e3f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a4e6adff-9596-40f3-9605-3a98fc29b056",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00"
},
"company_id": "349ec891-d5cb-4253-aefc-2ccf0baa6717",
"company_code": "sample string 12",
"db_address_id": "42cc8a79-0043-4f8e-925f-a6ed5f358ee3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d2c3f846-0d3f-4bcc-aec3-df9b7456559d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2935e4b9-8dd6-4ccf-b9e1-3e11302e6ea6",
"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-07-22T11:30:34.645776+00:00",
"date_create": "2026-07-22T11:30:34.645776+00:00",
"date_update": "2026-07-22T11:30:34.645776+00:00",
"updated_by_user_id": "b834eb25-9e95-418a-8878-bd44b9b43611",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-22T11:30:34.645776+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-07-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-22T11:30:34.645776+00:00",
"date_last_job": "2026-07-22T11:30:34.645776+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-22T11:30:34.645776+00:00",
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00",
"is_mobile_installation": true
},
"job_type_id": "15071309-1bb5-41fb-b9d3-4dfd95f0b187",
"job_type_code": "sample string 7",
"job_type": {
"id": "4864d5b2-13a7-421f-8928-366d3979a63d",
"name": "sample string 2",
"sales_organization_id": "d7b4dbf2-bdf8-4e27-80d2-fa31b4aace20",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00",
"code": "sample string 7"
},
"job_priority_id": "b24627f0-3308-4764-a747-a4b641aa6533",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f2c212f4-58fc-4baa-9f42-1c46558bf4dc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3184d8e0-16dd-4960-a0f1-e1a0b5fd5d3c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00"
},
"job_status_id": "df1d380f-8bc7-4528-ab30-56df7fe98c18",
"job_status_code": "sample string 11",
"db_address_id": "9193f2e3-f8fe-4966-a0b3-456b918060b4",
"contact_id": "217f8765-ff27-4602-83a1-aa5133cdf248",
"requested_by_company_id": "02acf03a-52b8-4dd4-bf8a-b7ac0f1bfffa",
"requested_by_contact_id": "1e44f528-41eb-4425-a6e7-88d2c784c535",
"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-07-22T11:30:34.645776+00:00",
"due_date": "2026-07-22T11:30:34.645776+00:00",
"date_create": "2026-07-22T11:30:34.645776+00:00",
"date_update": "2026-07-22T11:30:34.645776+00:00",
"date_closed": "2026-07-22T11:30:34.645776+00:00",
"suggested_user_id": "0555cb22-c978-4d6d-b457-8f93324efafd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "233ee26e-e479-43ab-8a71-d83cd4752ef0",
"db_language_id": "c09cd877-194e-4440-b488-aa4732476e1f",
"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-07-22T11:30:34.645776+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a9f940a2-4812-4bde-bcfe-04e52685a9a1",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5fb8a746-93a9-45dd-aba0-24529c670304",
"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": "ba08f42a-bd7b-4334-a066-21e1a4dcc266",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "643cd356-f80b-493d-b0a8-4fe5d21b01a5"
},
"suggested_date_start": "2026-07-22T11:30:34.645776+00:00",
"skill_id": "30e7771c-0f24-4a16-a442-4801e426e124",
"skill_code": "sample string 32",
"skill": {
"id": "57401c4d-75f9-46fe-83ee-8ffe81d97194",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "85a2b382-cb60-4ec9-bf40-0b2b0882bba9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f88e41c3-78cb-423a-ac75-b0be06f458aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48ac832c-9015-4b08-8dcb-6fd35d8efadc",
"db_currency_id": "9874b82a-cb83-4dc0-81c9-403a12c51b2d",
"db_language_id": "bd1de94a-21e1-49ab-b580-f81c0b20cb08",
"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-07-22T11:30:34.645776+00:00"
},
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c48f2898-b499-4d14-97dd-2fb1e1a7e081",
"date_reported_by_company": "2026-07-22T11:30:34.645776+00:00",
"id2": 36,
"company_id": "aabf18e2-59d1-423a-bde6-1ca9992b54bf",
"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": "9c377b16-6920-4f83-85de-3ca643aa5ba6",
"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-07-22T11:30:34.645776+00:00"
},
"work_instruction_details_id": "519c5edf-d815-4a86-85d5-0b42cbf3af49",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "25d69302-ee68-4be7-92a4-8fb76db49297",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "12fbdf46-ce0a-449b-9e70-ed4c5636ba40",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-22T11:30:34.645776+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": "4ad3d8fc-19bf-4fb8-877a-c0d4f121c583",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-22T11:30:34.645776+00:00"
}