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": "877fb24a-040d-4d24-ac72-f9e175aa65c7",
"jobs_id": "bf3e72a8-92d5-459c-af03-20dea7211593",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "79fe15e0-aa0a-491a-b83d-3878205add32",
"_parent_id": "f5080616-2cbf-4840-bb96-b61fe17c894d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8beb0f51-fdb9-4e74-a488-8025d66b7471",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a3fb68b0-0556-4773-b34f-2229b61bd1f8",
"_parent_id": "c04cf274-71c3-41ca-816b-246ff6a620df",
"root_parent_id": "e96c4244-a3e7-4ed3-bafc-251a5f550a19",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2c42749b-979a-4555-8860-8408507ef676",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3cd363c0-ae63-481f-9107-9337e8e576c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3022c224-d2d6-44a4-ae7c-f6eaecdf8bce",
"_parent_code": "sample string 6",
"sales_organization_id": "e20504c9-747f-47e1-b265-2dfae9a72315",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+00:00"
},
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00"
},
"equipment_model_id": "dbc8673c-bad2-4664-a34a-b059b55e7b0e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "60d2b723-8f71-4cbe-b03a-42669aeab9c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d921ec9e-61d4-4c47-976c-45328c125b13",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ffbec012-05e1-49fa-b863-8273d4efbaa7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "40574764-463a-4ce8-9133-5aae43e5e47a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+00:00"
},
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00"
},
"equipment_family_id": "a8bb51c6-0992-4a49-9dca-fc912fa6dc74",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3cd363c0-ae63-481f-9107-9337e8e576c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3022c224-d2d6-44a4-ae7c-f6eaecdf8bce",
"_parent_code": "sample string 6",
"sales_organization_id": "e20504c9-747f-47e1-b265-2dfae9a72315",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+00:00"
},
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00"
},
"date_in_production_since": "2026-08-30T17:52:31.4147076+00:00",
"date_out_of_production_since": "2026-08-30T17:52:31.4147076+00:00",
"date_end_support": "2026-08-30T17:52:31.4147076+00:00",
"sales_organization_id": "6f4e9ec6-f24f-4c92-aa35-dc6fed9df8f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+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-08-30T17:52:31.4147076+00:00"
},
"project_status_id": "481640e1-5324-4abd-9401-02a407cb6fdb",
"project_status_code": "sample string 10",
"project_status": {
"id": "a6b624b5-02a9-4cc3-97bf-4b9712fde29f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c26fc6ae-b7e6-4077-9b95-3169467d9096",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00"
},
"company_id": "3c354d7d-98e9-4554-8eac-05b3ab6084a9",
"company_code": "sample string 12",
"db_address_id": "07535e88-0bda-41f3-a838-076e2044f0f5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "db014a39-a1ad-4d4b-9f9a-6290c584925f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ad5d74b0-5c06-479c-a488-8f2f442767e1",
"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-08-30T17:52:31.4147076+00:00",
"date_create": "2026-08-30T17:52:31.4147076+00:00",
"date_update": "2026-08-30T17:52:31.4147076+00:00",
"updated_by_user_id": "83a1cde6-d9e1-4806-9774-52388f100b87",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-30T17:52:31.4147076+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-08-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-30T17:52:31.4147076+00:00",
"date_last_job": "2026-08-30T17:52:31.4147076+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-30T17:52:31.4147076+00:00",
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00",
"is_mobile_installation": true
},
"job_type_id": "304c9b08-1ea1-402c-b8ed-4f7119f29a90",
"job_type_code": "sample string 7",
"job_type": {
"id": "9be58e04-eb2e-4f66-abf2-3a71c52d29cd",
"name": "sample string 2",
"sales_organization_id": "a7ddec05-81d2-4085-bd4f-59f6b5bc679f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00",
"code": "sample string 7"
},
"job_priority_id": "cb938517-6913-43f4-a795-6a2c6d8878b3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "25dff519-45f3-4f03-9540-80499117dd78",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "760ba76f-52fa-492d-b03a-52a1be99793a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00"
},
"job_status_id": "128f88bb-fb34-43c0-842f-c4b363843d2a",
"job_status_code": "sample string 11",
"db_address_id": "a1d1a993-549d-4ce5-8bf7-20870ee4e381",
"contact_id": "1c70d256-28c0-4f0c-a1dc-048ef7ab9eda",
"requested_by_company_id": "7f48fc13-3448-4c18-937e-6c954e28ca3b",
"requested_by_contact_id": "21604854-74c8-4381-9e1c-26c3b4054ff3",
"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-08-30T17:52:31.4147076+00:00",
"due_date": "2026-08-30T17:52:31.4147076+00:00",
"date_create": "2026-08-30T17:52:31.4147076+00:00",
"date_update": "2026-08-30T17:52:31.4147076+00:00",
"date_closed": "2026-08-30T17:52:31.4147076+00:00",
"suggested_user_id": "5e5be96f-7c9d-4760-a8db-69ab48b1ceab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "04760f19-0bc2-49f3-bb68-81a843200848",
"db_language_id": "29734368-6288-4bc8-99b6-b3899f446347",
"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-08-30T17:52:31.4147076+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fd3bd247-02a1-40f9-93b2-db096bd27e39",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b7eecd80-1d06-4dd2-8ed0-58cb61830db1",
"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": "f4956d28-55fa-49c3-86f3-da96172038c8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aecf423a-e7cd-4ddd-b292-57dbabb88623"
},
"suggested_date_start": "2026-08-30T17:52:31.4147076+00:00",
"skill_id": "6c0e3dbe-c5a1-4ec9-8261-e3422804fb04",
"skill_code": "sample string 32",
"skill": {
"id": "4d483b3e-727f-4168-8caf-9979d8611960",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9a78584c-10fb-459c-884c-fe84db21c1fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c03f538a-3056-4b23-9ee3-7cb8dc5dd783",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22dbb42d-5eb0-4252-acdf-5805c147a2d0",
"db_currency_id": "9cb917c4-f248-4e2b-854f-eda709db206f",
"db_language_id": "733be03c-5475-47b9-ad58-790e61cc8b4f",
"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-08-30T17:52:31.4147076+00:00"
},
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a7dbaff5-56d9-4dfd-97a0-a51bca5e9110",
"date_reported_by_company": "2026-08-30T17:52:31.4147076+00:00",
"id2": 36,
"company_id": "1c67c88c-4638-4654-ac48-1010a98b399f",
"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": "03121056-4fd3-46f8-8bd8-b074beeaafba",
"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-08-30T17:52:31.4147076+00:00"
},
"work_instruction_details_id": "8ad9c9af-9ac0-4493-80e0-4fd4c1ca12a4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "49f1522e-e12b-45b6-982c-c5974dd977e1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "627fd53e-e12e-4730-b8ce-aa87d3b8164a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-30T17:52:31.4147076+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": "e13d2922-6dc2-485d-ac96-e6c3e519890a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-30T17:52:31.4147076+00:00"
}