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": "4764bca0-34c4-4e15-96fd-bebf09b33222",
"jobs_id": "f9adf720-733a-48f8-be53-322c5859815f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "17b33256-ce18-4657-9142-34e44b965073",
"_parent_id": "06f5176a-fec2-40c6-a1b4-097b9254385a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a02c58c5-f61e-4215-821c-70a152ef640c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9ac3fed5-239a-4f5d-9786-9cb06dd17668",
"_parent_id": "cc1e9080-0757-40ee-8b26-b2d9d1dc0cdb",
"root_parent_id": "28094ea9-137b-454a-89d3-fbed01c15436",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b87bcdad-c53d-4518-9d60-b7a3efc07feb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9026cb65-02b0-4355-a0ef-bbb488d28d63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df718dac-1903-4846-9fe3-028c0a276b88",
"_parent_code": "sample string 6",
"sales_organization_id": "a0375632-3dce-4562-988a-224c29a31d0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+00:00"
},
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00"
},
"equipment_model_id": "92492480-62f5-44df-9e36-99e9260b1a65",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e325764b-2070-4e8d-bff8-c8e91e7bb7d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1b9a1156-6c88-420b-b94f-9d1843f9e2d6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bdedde3c-9a2c-4820-abbb-074c96444712",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "08feafa3-5286-4611-9b8c-e10d8d0ad252",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+00:00"
},
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00"
},
"equipment_family_id": "794eb87a-5587-4896-aa3a-7f523f57ccf0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9026cb65-02b0-4355-a0ef-bbb488d28d63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df718dac-1903-4846-9fe3-028c0a276b88",
"_parent_code": "sample string 6",
"sales_organization_id": "a0375632-3dce-4562-988a-224c29a31d0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+00:00"
},
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00"
},
"date_in_production_since": "2026-06-10T20:50:33.9526569+00:00",
"date_out_of_production_since": "2026-06-10T20:50:33.9526569+00:00",
"date_end_support": "2026-06-10T20:50:33.9526569+00:00",
"sales_organization_id": "9eb942d4-0d94-4a0f-9007-7f416d0b755e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+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-10T20:50:33.9526569+00:00"
},
"project_status_id": "1fa541f5-2499-458b-889b-cf129680b60b",
"project_status_code": "sample string 10",
"project_status": {
"id": "294908b7-5eae-45f5-a46e-0e45e1818be9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1766ad62-1175-48e5-b4dd-5e3e4aeeb5a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00"
},
"company_id": "d6276039-9a1a-4815-929e-fe060b49e109",
"company_code": "sample string 12",
"db_address_id": "2ad17d4d-bf9f-4dd3-8d4f-29c4942f4a0a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c38fa036-99df-4ea4-9d7a-cb1f68cafc14",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d07f30d9-85c9-4079-81e5-3d11b66c36dc",
"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-10T20:50:33.9526569+00:00",
"date_create": "2026-06-10T20:50:33.9526569+00:00",
"date_update": "2026-06-10T20:50:33.9526569+00:00",
"updated_by_user_id": "c2c497b1-3046-4f07-a245-a39300bd161a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-10T20:50:33.9526569+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-10T20:50:33.9526569+00:00",
"date_last_job": "2026-06-10T20:50:33.9526569+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-10T20:50:33.9526569+00:00",
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c5beaf5-59cc-433b-abbf-fc307e067419",
"job_type_code": "sample string 7",
"job_type": {
"id": "4fe00c92-4c00-4f2e-bfd5-1a21500d26b9",
"name": "sample string 2",
"sales_organization_id": "0911702f-eeca-401e-a43b-b370f34cf0fd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00",
"code": "sample string 7"
},
"job_priority_id": "25fcf175-300d-4141-a566-e0c1b5277844",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "95e5733d-849a-440a-9338-7a7f3ebb6ff4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "587b2ea3-011a-4d30-8981-c4dd4e577874",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00"
},
"job_status_id": "851bdd8b-b378-4732-bc48-2e5433d26a4d",
"job_status_code": "sample string 11",
"db_address_id": "bb2babf0-cace-453c-ae8c-ad2bae8a7812",
"contact_id": "ecd5fa27-5d4b-49f7-9b4c-983cd6ab1a60",
"requested_by_company_id": "e273fdfc-b060-4c43-abeb-6fb9df9ca3a6",
"requested_by_contact_id": "c776fd6c-9239-44a3-8d97-42cd7cd368e5",
"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-10T20:50:33.9526569+00:00",
"due_date": "2026-06-10T20:50:33.9526569+00:00",
"date_create": "2026-06-10T20:50:33.9526569+00:00",
"date_update": "2026-06-10T20:50:33.9526569+00:00",
"date_closed": "2026-06-10T20:50:33.9526569+00:00",
"suggested_user_id": "b2cb1e92-d929-4815-a1d8-fcd91f26bc88",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1ee2247b-c742-488a-b81a-21aaefb0888a",
"db_language_id": "1ee49b25-910a-4f7c-b381-5727f6e15415",
"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-10T20:50:33.9526569+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "833da95c-5c81-443c-884e-8228fbca4bde",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "52b9f0cb-7d8b-4e01-92ca-46720d4b5e96",
"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": "2bfcefa6-eafe-4040-9b81-70b4605c8b70",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0e01bcb9-e4e2-441f-bc94-7c9b74cf92ac"
},
"suggested_date_start": "2026-06-10T20:50:33.9526569+00:00",
"skill_id": "6436cb64-8b74-453a-a4de-f81cb1317b04",
"skill_code": "sample string 32",
"skill": {
"id": "822aa998-ce2d-4cbd-8222-27bfa0af09d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c4606650-8dd8-41cb-b620-9829b8e14c20",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f12a209-ee64-48d0-bc41-a89a029f8354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c59237e-a122-4cc2-b10f-47150cf92c71",
"db_currency_id": "e0465dc4-a149-4267-86b8-b2ffa5578754",
"db_language_id": "9f992cd4-d4c3-4fbd-b8ff-468607551a8b",
"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-10T20:50:33.9526569+00:00"
},
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "857b1af3-c0a1-454f-a9c1-3098d336b7cf",
"date_reported_by_company": "2026-06-10T20:50:33.9526569+00:00",
"id2": 36,
"company_id": "1f5d89b1-8910-4173-85ae-fec9a14c5ed7",
"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": "64ccefbf-e9a0-4188-8b52-8d31aaf4ffc1",
"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-10T20:50:33.9526569+00:00"
},
"work_instruction_details_id": "be2d4b85-b391-450b-b150-8839264c8b87",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e3082d66-4eae-4105-b85f-d22360e76c22",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e1a196fa-2f64-4bce-95ce-5398b45e4566",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-10T20:50:33.9526569+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": "1354ace9-bacd-46c0-bfb0-a0db4a374739",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-10T20:50:33.9526569+00:00"
}