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": "d35de0d2-c2b7-4859-bd0f-99b00e44964f",
"jobs_id": "c1352b9f-e546-426f-98e6-401db2ec17c7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d4107506-c83b-4e96-8b1b-171b12fd68e9",
"_parent_id": "437409de-eb32-4dd1-b87d-047241abf8d5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4c89243d-25f9-43a7-abff-72cf1edd2969",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3c67f97f-06ce-47f4-9730-f582b8d9305d",
"_parent_id": "6078d489-3474-4337-8aec-54b14b44130b",
"root_parent_id": "81eaa520-90c0-445f-bdec-f24445d55007",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "52418900-7072-49a0-96bd-623e9092b355",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "af68a76d-4d3c-4578-9b2d-6f3eb1c3a7dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3ced4c90-a426-4eec-b42e-78214eb7400f",
"_parent_code": "sample string 6",
"sales_organization_id": "0f8cf836-aaa5-44ea-8c53-1bd52176036a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+00:00"
},
"modified_dateutc": "2025-11-10T20:00:07.9474146+00:00"
},
"equipment_model_id": "57477a62-2613-4c09-99be-f6c61fecc91e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a310f1a2-965f-4189-ae6e-3ce97a1dc929",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "306b058a-bf80-4835-b747-9ca17ae8b668",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dbc8b574-08eb-4317-8761-9b598f520eed",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5758e0e2-9867-4d70-b804-d0f3fb006fe4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+00:00"
},
"modified_dateutc": "2025-11-10T20:00:07.9474146+00:00"
},
"equipment_family_id": "e6483e17-e3bc-4e7e-9a64-7b6f254d64fd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "af68a76d-4d3c-4578-9b2d-6f3eb1c3a7dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3ced4c90-a426-4eec-b42e-78214eb7400f",
"_parent_code": "sample string 6",
"sales_organization_id": "0f8cf836-aaa5-44ea-8c53-1bd52176036a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+00:00"
},
"modified_dateutc": "2025-11-10T20:00:07.9474146+00:00"
},
"date_in_production_since": "2025-11-10T20:00:07.9474146+00:00",
"date_out_of_production_since": "2025-11-10T20:00:07.9474146+00:00",
"date_end_support": "2025-11-10T20:00:07.9474146+00:00",
"sales_organization_id": "2781c90f-c465-4859-a9d9-f6768e97033c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+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": "2025-11-10T20:00:07.9474146+00:00"
},
"project_status_id": "357f89dc-0486-437b-8df5-6ce72e014a29",
"project_status_code": "sample string 10",
"project_status": {
"id": "36d96a88-9507-4bc5-97af-a13a64603888",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9cd0bc46-a646-4ab4-a1e6-0d16b1d64f6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-10T20:00:07.9474146+00:00"
},
"company_id": "a23ba3b2-862c-49a9-86cf-f656636b49ab",
"company_code": "sample string 12",
"db_address_id": "b134c420-bffa-41fa-bc80-03147a18c81f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "15dbc319-7b63-4c00-b90d-f4826e0e6d1f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d23b5a7d-58ba-419c-b996-778220b6f765",
"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": "2025-11-10T20:00:07.9474146+00:00",
"date_create": "2025-11-10T20:00:07.9474146+00:00",
"date_update": "2025-11-10T20:00:07.9474146+00:00",
"updated_by_user_id": "2401c325-4bd6-4377-9c45-595c90e85b86",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-10T20:00:07.9474146+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": "2025-11-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-10T20:00:07.9474146+00:00",
"date_last_job": "2025-11-10T20:00:07.9474146+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-10T20:00:07.9474146+00:00",
"modified_dateutc": "2025-11-10T20:00:07.9474146+00:00",
"is_mobile_installation": true
},
"job_type_id": "0e22e7d6-01e8-4bc6-b6ce-e1482df0d327",
"job_type_code": "sample string 7",
"job_type": {
"id": "1520554e-d22b-43ae-b6a8-a99f28a1715d",
"name": "sample string 2",
"sales_organization_id": "e4ee2ea1-1d2e-44a3-922c-6bc4d9775fe8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-10T20:00:07.9474146+00:00",
"code": "sample string 7"
},
"job_priority_id": "51ca7747-a8c6-438f-b060-11944b2a6658",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6def847d-8bec-4db9-bb18-3b5c0fb6250d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "17485b3f-8aa6-4113-81e3-7ada5486629f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-10T20:00:07.9474146+00:00"
},
"job_status_id": "061e4413-6d4a-4e3c-917e-cc15fc3fe645",
"job_status_code": "sample string 11",
"db_address_id": "835674d4-794b-4a0c-977f-e0bc7adbf3ce",
"contact_id": "719eaf5d-8a43-4715-a9fc-c2595d5acf4c",
"requested_by_company_id": "90cfbdfe-a69c-4853-8c73-5bbe4cd9fba1",
"requested_by_contact_id": "cdc72897-7e08-452b-8562-20f06a98536d",
"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": "2025-11-10T20:00:07.9474146+00:00",
"due_date": "2025-11-10T20:00:07.9474146+00:00",
"date_create": "2025-11-10T20:00:07.9474146+00:00",
"date_update": "2025-11-10T20:00:07.9474146+00:00",
"date_closed": "2025-11-10T20:00:07.9474146+00:00",
"suggested_user_id": "af6e50d6-1e78-455c-bc4f-bc91ec6e1d9e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ea93113c-40a4-4718-a63f-c732f42fb767",
"db_language_id": "d8aa716e-b704-42e4-9c38-c4db6c9db0a6",
"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": "2025-11-10T20:00:07.9474146+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fead0a76-15fe-45bf-ab1a-a6fce99a2247",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "15012dbf-b187-40af-9880-44670b7cba8a",
"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": "3c4bda68-b7d9-4470-9df6-b9d6cb3e4fd8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-10T20:00:07.9630397+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0b9cb3d8-decf-4205-8a1a-dd17a0d057c9"
},
"suggested_date_start": "2025-11-10T20:00:07.9630397+00:00",
"skill_id": "30b382e7-3f07-4182-b4aa-b650b80be373",
"skill_code": "sample string 32",
"skill": {
"id": "638c7db7-47cf-492f-9b4e-e6489951daaf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c09bd36f-156c-45ae-b27d-c9543aa4a281",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "51cf3de3-b336-4c57-bbdf-1ade0493201f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e304894e-95dc-4f36-a327-edbc589aa092",
"db_currency_id": "147750da-9886-4d2b-843b-b0521e70964f",
"db_language_id": "6225b2ac-2fee-488f-b22f-4aea1541816b",
"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": "2025-11-10T20:00:07.9474146+00:00"
},
"modified_dateutc": "2025-11-10T20:00:07.9630397+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5207fb70-0096-463c-aca0-5241dc6e0d08",
"date_reported_by_company": "2025-11-10T20:00:07.9630397+00:00",
"id2": 36,
"company_id": "15440ec0-5f70-4f74-9aa0-de048a4f0700",
"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": "d1eb0df3-122c-4364-972d-c10a884e8945",
"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": "2025-11-10T20:00:07.9630397+00:00"
},
"work_instruction_details_id": "18680e3e-415f-4a9a-adbe-f584ce1a2b66",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2b7473f7-3136-4742-9b43-cc4abd731c23",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bc6fbbca-7812-4029-b198-15672494d0d4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-10T20:00:07.9630397+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": "cc0dc2c9-99ee-4808-80d7-fe587fc76450",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-10T20:00:07.9630397+00:00"
}