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": "0846138b-db54-4738-b97c-3d30c30a3c11",
"jobs_id": "a8f9dce1-fe3d-4cf9-b771-a259a528fc8a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "67d9206d-4214-44c3-8596-c22ac53a2516",
"_parent_id": "083e59f5-1afd-4b69-8209-7c115e5d75bf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf1f56a8-f014-4cd7-8a3a-b6805d5cb18c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "11fd0b6c-8a0b-4678-b521-f3aba52af182",
"_parent_id": "54a3bfb4-eb82-4b11-8ceb-5b482a6e007a",
"root_parent_id": "e8c316ba-fbe7-4073-a8b2-5a48d71ea3eb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1bde8467-880c-4617-a898-632308431ab1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d4b4e030-fe57-471e-9cac-678d1eda5748",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "462e3c5d-b14f-4a1f-9995-337b4c947176",
"_parent_code": "sample string 6",
"sales_organization_id": "699a42ce-5dc2-4806-af33-2d630b2eadec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+00:00"
},
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00"
},
"equipment_model_id": "0405aa9e-5483-4f98-95cd-bba128c02190",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d8b5b427-62f6-4bb3-8948-fe5866de0f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2d4393d5-ab08-4853-a34b-9ea0251cae70",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "544c0df6-0b0e-4810-9cf9-c321421dd4ad",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "488a9fcf-dda6-453a-bab0-05639554740a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+00:00"
},
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00"
},
"equipment_family_id": "192d1fcc-e10f-483f-949a-fee9100c5d90",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d4b4e030-fe57-471e-9cac-678d1eda5748",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "462e3c5d-b14f-4a1f-9995-337b4c947176",
"_parent_code": "sample string 6",
"sales_organization_id": "699a42ce-5dc2-4806-af33-2d630b2eadec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+00:00"
},
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00"
},
"date_in_production_since": "2025-12-20T18:13:36.7631461+00:00",
"date_out_of_production_since": "2025-12-20T18:13:36.7631461+00:00",
"date_end_support": "2025-12-20T18:13:36.7631461+00:00",
"sales_organization_id": "90b7d9a6-42a8-4331-90b7-b9efb19ed488",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+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-12-20T18:13:36.7631461+00:00"
},
"project_status_id": "b08ad0f3-a8a3-48bf-8edf-19aef3ccf02a",
"project_status_code": "sample string 10",
"project_status": {
"id": "a37a07ec-6375-415b-9f04-525c7819918b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f98110cb-d647-4dbb-8f56-380b657130eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00"
},
"company_id": "5f228eb2-0228-4a01-ae64-f5ac32c7ce66",
"company_code": "sample string 12",
"db_address_id": "c67ab493-9cba-45ce-8827-b6f68a473e79",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1b03cc42-0238-475e-bf79-c8ad9154035d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "42d51555-b0fb-48ba-935e-cea705810204",
"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-12-20T18:13:36.7631461+00:00",
"date_create": "2025-12-20T18:13:36.7631461+00:00",
"date_update": "2025-12-20T18:13:36.7631461+00:00",
"updated_by_user_id": "788f93ef-397c-4528-ac28-37f8c415cf73",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-20T18:13:36.7631461+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-12-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-20T18:13:36.7631461+00:00",
"date_last_job": "2025-12-20T18:13:36.7631461+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-20T18:13:36.7631461+00:00",
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00",
"is_mobile_installation": true
},
"job_type_id": "93e97b44-1f6d-4054-9030-a8f53cdeed48",
"job_type_code": "sample string 7",
"job_type": {
"id": "b5bf14e5-0912-46eb-86c6-7646e5a5c447",
"name": "sample string 2",
"sales_organization_id": "30379bcd-d034-4025-b85a-c5299d235830",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00",
"code": "sample string 7"
},
"job_priority_id": "56581c51-41dc-48b5-9867-d4aaf80f8c2b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "90dee2f5-d715-496c-9aab-6c80bd068f2e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ccba6986-f0bb-4783-a45c-3b32af46c97d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00"
},
"job_status_id": "09a24cfc-16da-4dbf-9bc6-d564dabafead",
"job_status_code": "sample string 11",
"db_address_id": "41a4a1f4-1a5c-49cd-89d6-b696a802894e",
"contact_id": "11ed289a-19b8-4370-9376-32f12ceab8cb",
"requested_by_company_id": "875ede62-2d4b-4160-a3ad-ec140bca4a40",
"requested_by_contact_id": "6005bc72-95e4-42aa-9a64-2793215ea3d9",
"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-12-20T18:13:36.7631461+00:00",
"due_date": "2025-12-20T18:13:36.7631461+00:00",
"date_create": "2025-12-20T18:13:36.7631461+00:00",
"date_update": "2025-12-20T18:13:36.7631461+00:00",
"date_closed": "2025-12-20T18:13:36.7631461+00:00",
"suggested_user_id": "cbd493bc-9105-49f4-837b-58556d527ae1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c4f74239-7c48-431a-ae39-8d02b8d19265",
"db_language_id": "ffc82351-dc79-4d40-a6ca-76a719eedc45",
"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-12-20T18:13:36.7631461+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e5d4442c-94f3-4a38-8587-a200d5802657",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "aa628cb5-182d-44c2-add9-d4457889124d",
"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": "6dc6c47d-fefd-44da-a976-a0e2f53cf8c1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "27b6893d-f51c-4812-9e2b-49a0f999087e"
},
"suggested_date_start": "2025-12-20T18:13:36.7631461+00:00",
"skill_id": "fe6b1913-d366-40f6-91ec-462f0d5c6273",
"skill_code": "sample string 32",
"skill": {
"id": "91a2c421-5f24-46dd-a23f-a504e3b24d3a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4049d6c5-d1eb-40b6-97a1-36a169767926",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6dc5dc82-255f-4363-aebc-a1fdc4a6247c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d840d98-6944-44ad-af2a-dbf52aa0656d",
"db_currency_id": "e0d11062-45cf-4b26-96f9-3ef9e0eca26a",
"db_language_id": "967ef83b-ea3f-43bc-8591-1be7ab2e4358",
"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-12-20T18:13:36.7631461+00:00"
},
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "493ced9f-4804-4b79-a12a-00ced9224a3a",
"date_reported_by_company": "2025-12-20T18:13:36.7631461+00:00",
"id2": 36,
"company_id": "35d3d920-3bf6-4521-9d2b-f13490d487ec",
"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": "232770ee-4bdf-4879-a329-f33bbcfd9642",
"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-12-20T18:13:36.7631461+00:00"
},
"work_instruction_details_id": "7a28041f-1302-437c-90e6-737f2b4a4dd3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a6d213a8-19df-4e65-8f5b-634658793c2c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d6c2fe25-59c8-4b7d-9928-5a6465acbeac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-20T18:13:36.7631461+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": "83a05c82-158d-4065-8a24-4c5592d3213b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-20T18:13:36.7631461+00:00"
}