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": "2faf57a3-29ba-49a8-b291-cfc013dd32c2",
"jobs_id": "aa94832d-bf49-4ef8-9fc4-54634243638f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b9c1462d-609c-4c88-9100-e4656b386b08",
"_parent_id": "2e39b6b9-8340-47b9-9617-84a4953676d0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "70dad376-bf39-4fc1-8138-6a6608107f1a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1f44b863-4b47-48aa-ba98-cdcb63f8a1b5",
"_parent_id": "dd0b24fc-ff0e-4f93-a3bb-65e7819129ae",
"root_parent_id": "f2f74795-3d11-4e36-88b5-62ac04d623f7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "412cd0b4-af09-40fd-bb2d-5c34a6e94b77",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fa5dc3cf-3ab8-4959-bfde-78c5caec5fe7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "10e2a9af-4e40-4bd5-8c43-6c4af7464e7f",
"_parent_code": "sample string 6",
"sales_organization_id": "cbbc7c74-ba56-42af-8a1b-6c14f73aba6d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+00:00"
},
"modified_dateutc": "2026-04-09T15:27:53.8273235+00:00"
},
"equipment_model_id": "de969835-ebe0-42e4-8dcd-75d4e86f5046",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "360b9353-ef91-48e9-933e-0b0bd2b60b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f626a6c2-94b3-4af7-bb91-b783b98e64ed",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "03f6e186-3fd7-4aa9-bce1-a181bf8f1ba0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9e28b0d-84e6-4163-8753-0ad46bfda72e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+00:00"
},
"modified_dateutc": "2026-04-09T15:27:53.8273235+00:00"
},
"equipment_family_id": "c8f7465d-95d5-48e5-b0a8-85dd32f49d9c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fa5dc3cf-3ab8-4959-bfde-78c5caec5fe7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "10e2a9af-4e40-4bd5-8c43-6c4af7464e7f",
"_parent_code": "sample string 6",
"sales_organization_id": "cbbc7c74-ba56-42af-8a1b-6c14f73aba6d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+00:00"
},
"modified_dateutc": "2026-04-09T15:27:53.8273235+00:00"
},
"date_in_production_since": "2026-04-09T15:27:53.8273235+00:00",
"date_out_of_production_since": "2026-04-09T15:27:53.8273235+00:00",
"date_end_support": "2026-04-09T15:27:53.8273235+00:00",
"sales_organization_id": "ad0870ca-8721-4ef3-9e7e-603a20752456",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+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-04-09T15:27:53.8273235+00:00"
},
"project_status_id": "74352033-e505-4155-b36e-ff288685459c",
"project_status_code": "sample string 10",
"project_status": {
"id": "c58dbf85-e5f4-4cdc-91da-c94d13a11e79",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "37e594cf-452d-4763-88bd-366784a36229",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T15:27:53.8273235+00:00"
},
"company_id": "496e9e1b-c9c3-4f67-afae-1974c580850c",
"company_code": "sample string 12",
"db_address_id": "873e4fda-16c4-4bfb-a036-f538752754c0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e116ac8a-a98d-4968-9575-b2bf22239376",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7e3bf5d2-6842-4b0c-9543-cac95f91ee3a",
"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-04-09T15:27:53.842951+00:00",
"date_create": "2026-04-09T15:27:53.842951+00:00",
"date_update": "2026-04-09T15:27:53.842951+00:00",
"updated_by_user_id": "b7535673-a535-4c8f-ba19-16d5f5a2d443",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-09T15:27:53.842951+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-04-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-09T15:27:53.842951+00:00",
"date_last_job": "2026-04-09T15:27:53.842951+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-09T15:27:53.842951+00:00",
"modified_dateutc": "2026-04-09T15:27:53.842951+00:00",
"is_mobile_installation": true
},
"job_type_id": "98440b9d-05c4-434f-a054-78ad50ae83b9",
"job_type_code": "sample string 7",
"job_type": {
"id": "3c0f932a-22c0-4b55-95ff-c7dabad87a41",
"name": "sample string 2",
"sales_organization_id": "23c0b317-321c-432e-bb1f-745a255e5c84",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-09T15:27:53.842951+00:00",
"code": "sample string 7"
},
"job_priority_id": "0e8c5f78-ec8e-43f9-9158-d0dfdc6b15c7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b21154e0-e7fc-4261-8194-19d6e34fb069",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c57872ce-7d4e-4a11-9cf5-1a3aa68c4500",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T15:27:53.842951+00:00"
},
"job_status_id": "daf7f766-fdd9-489c-b339-88bb582f2f0b",
"job_status_code": "sample string 11",
"db_address_id": "197451b9-cccb-4d57-bf06-2ca009deff6b",
"contact_id": "ec687da7-89a5-4903-b75f-b7d86a60eb8d",
"requested_by_company_id": "416d8d30-39e0-4a11-afaf-35f61a18f23a",
"requested_by_contact_id": "86aa380e-9b0e-46bc-ae66-8d4b289ae8e7",
"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-04-09T15:27:53.842951+00:00",
"due_date": "2026-04-09T15:27:53.842951+00:00",
"date_create": "2026-04-09T15:27:53.842951+00:00",
"date_update": "2026-04-09T15:27:53.842951+00:00",
"date_closed": "2026-04-09T15:27:53.842951+00:00",
"suggested_user_id": "2efb3a21-97c2-4862-bb46-197f3eb13d28",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c8bd2b8c-c302-4a3d-bbed-56e0b60a1194",
"db_language_id": "d05c4f52-40fd-43e7-8f97-9e356580b69b",
"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-04-09T15:27:53.842951+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cc45a4a5-6514-4108-ad21-68d469cd804c",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "387b02f2-9434-4066-a4ab-7745e90168d6",
"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": "957ac9fc-64eb-4406-bf4a-b5a864ea5044",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-09T15:27:53.842951+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2f502dcb-c814-4c46-bc8f-74ef71abfac4"
},
"suggested_date_start": "2026-04-09T15:27:53.842951+00:00",
"skill_id": "57c72ea0-797c-4d5d-a5df-84737d2cb36d",
"skill_code": "sample string 32",
"skill": {
"id": "b07d5e7e-2fbb-4a43-bd49-b3498d37fb62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d42adcfd-985a-4df5-a41c-62cc8e261ba4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4bdc40c2-5b04-4156-9429-b13cf3106b8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "068b2e1d-4763-4e38-a05d-176f92ed902e",
"db_currency_id": "3fca2f90-5dc7-44ae-90c7-3f579a78e00c",
"db_language_id": "5933d8f9-d9ac-4929-8880-ae3a6e691e84",
"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-04-09T15:27:53.8273235+00:00"
},
"modified_dateutc": "2026-04-09T15:27:53.842951+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "58422ab2-aa86-4bd3-84ef-9d03f50f582d",
"date_reported_by_company": "2026-04-09T15:27:53.842951+00:00",
"id2": 36,
"company_id": "3caaa37c-a895-48c8-be6f-2bb3659cca48",
"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": "cb980846-13aa-4150-b1ff-f4c3cbc95c15",
"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-04-09T15:27:53.842951+00:00"
},
"work_instruction_details_id": "933a2ee7-ccc5-4807-8d50-17b95c6a5371",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a7f14324-b7ac-44b8-a842-732d749e45b9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8702a40b-a06d-43e3-907b-48559437f0f9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-09T15:27:53.842951+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": "88eb0389-7691-4ff1-b170-1b79d3426c4b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-09T15:27:53.842951+00:00"
}