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": "bcb8aec5-cb22-4a80-9d28-ca0eea6824ca",
"jobs_id": "7c48e07d-9abd-40e7-a351-24cb5fe71d25",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2cab7a98-af15-481e-a30b-f91b05e81b2a",
"_parent_id": "cb319266-a8af-49b7-997c-5210798c774f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "519f8e58-49ed-4dc8-844f-3b8d75ae0784",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e8a3e34f-a994-44cb-a94c-ec79eea5c368",
"_parent_id": "b2af0120-2649-4029-b6fd-dde282efbdab",
"root_parent_id": "2ffc3d8b-397c-47ae-a56e-b0f263f341c6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3e65e7d0-21aa-4a9b-b25c-64024fa1f625",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6e00a757-aa6b-42b0-b877-556bd0a9e993",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "99cc7d62-829f-4d67-a96a-76c44513480f",
"_parent_code": "sample string 6",
"sales_organization_id": "78083873-83f3-473d-84a6-2603a67a9e59",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+00:00"
},
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00"
},
"equipment_model_id": "aab15801-9c48-4b5f-9ff0-5d857c14ba19",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5be88efd-fb0f-45cd-b6ae-f58d5685a63b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "831c72e9-2501-4eb7-a227-bb5a9eba1489",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bbdaaacd-ac34-4db9-865d-fae18be10ba2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "351d39a8-a041-4390-a654-c0f7a4c78edd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+00:00"
},
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00"
},
"equipment_family_id": "fab91a98-3538-44d0-9503-ba4bbc3be34c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6e00a757-aa6b-42b0-b877-556bd0a9e993",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "99cc7d62-829f-4d67-a96a-76c44513480f",
"_parent_code": "sample string 6",
"sales_organization_id": "78083873-83f3-473d-84a6-2603a67a9e59",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+00:00"
},
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00"
},
"date_in_production_since": "2026-01-19T13:52:45.8746097+00:00",
"date_out_of_production_since": "2026-01-19T13:52:45.8746097+00:00",
"date_end_support": "2026-01-19T13:52:45.8746097+00:00",
"sales_organization_id": "8be241ec-0943-4b3b-b0bc-3ea8999630e6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+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-01-19T13:52:45.8746097+00:00"
},
"project_status_id": "0660e431-1287-4c68-9042-5dd81d898141",
"project_status_code": "sample string 10",
"project_status": {
"id": "5087955d-7146-4ebb-b225-cef01f8665c7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8b45c6b9-b225-41ef-ae84-a6e9d1bf4171",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00"
},
"company_id": "d3c38a49-98e2-4583-9fe0-273da9d5126e",
"company_code": "sample string 12",
"db_address_id": "ef917eac-9ca7-4a89-9d7b-15a3a0f04412",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "68ee4f0f-8772-4266-bce1-2b0a082be537",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3803169f-6053-4949-af14-786693950940",
"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-01-19T13:52:45.8746097+00:00",
"date_create": "2026-01-19T13:52:45.8746097+00:00",
"date_update": "2026-01-19T13:52:45.8746097+00:00",
"updated_by_user_id": "b77220d4-f17f-46b2-945c-294a5223e866",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-19T13:52:45.8746097+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-01-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-19T13:52:45.8746097+00:00",
"date_last_job": "2026-01-19T13:52:45.8746097+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-19T13:52:45.8746097+00:00",
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00",
"is_mobile_installation": true
},
"job_type_id": "418c5d52-2f00-4f36-84a5-00ad4f04b1f7",
"job_type_code": "sample string 7",
"job_type": {
"id": "6a376624-a7c9-42c4-9cbd-21092aba6f41",
"name": "sample string 2",
"sales_organization_id": "c73446f0-30c3-407f-a7a5-cf1babd6b239",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00",
"code": "sample string 7"
},
"job_priority_id": "35859dee-c419-4af1-b573-13dab993413c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0a83250d-b1db-4359-8910-260e7196d642",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "43aedcab-267a-4188-8d98-7b69890a9500",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00"
},
"job_status_id": "59724ce6-1e69-4706-beee-a99c41970ae8",
"job_status_code": "sample string 11",
"db_address_id": "77fd5514-0069-4a33-89dd-0b908a3f9df9",
"contact_id": "4f6ca7c8-368e-4692-860a-915e6ea2e936",
"requested_by_company_id": "1f8118b7-9332-4da4-ad25-6a905f88de1f",
"requested_by_contact_id": "38045d38-b76c-4e91-8c99-8031c691ccd6",
"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-01-19T13:52:45.8746097+00:00",
"due_date": "2026-01-19T13:52:45.8746097+00:00",
"date_create": "2026-01-19T13:52:45.8746097+00:00",
"date_update": "2026-01-19T13:52:45.8746097+00:00",
"date_closed": "2026-01-19T13:52:45.8746097+00:00",
"suggested_user_id": "3456d73c-cd79-47dd-a8e2-3f3fba9d2d24",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c1ee0604-65f1-41e1-98f2-b00adb3161a7",
"db_language_id": "a4d735d8-d834-438f-9e2f-0f27e06f5f43",
"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-01-19T13:52:45.8746097+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "36692937-999b-4094-bebc-c75eb59ea76d",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6b4a0249-3300-44b6-86f9-b42e53d38430",
"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": "87718acf-809a-451f-a0e2-917185167123",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "35dff985-ed6c-419c-af85-a65290d499b4"
},
"suggested_date_start": "2026-01-19T13:52:45.8746097+00:00",
"skill_id": "7bdca39b-a21a-432e-8d5b-e9b86acb5db8",
"skill_code": "sample string 32",
"skill": {
"id": "c182069a-2160-4bfd-a432-f5245d96b8ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ae34a5ca-315c-4dd9-abaa-05bc3f263bfc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6c87f04e-8f3e-4789-af12-7d992199817b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01143f95-2eef-442f-8b65-9a09e1cd3365",
"db_currency_id": "04ba0928-1600-4c00-8d98-2cb31d625ef6",
"db_language_id": "65be15d5-eb31-4cd0-975c-7b1654d381fb",
"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-01-19T13:52:45.8746097+00:00"
},
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1421e165-7513-4ac1-bb17-ffcd2d352faf",
"date_reported_by_company": "2026-01-19T13:52:45.8746097+00:00",
"id2": 36,
"company_id": "5f8d8305-b0ca-4cfd-b57d-ae1663641f7e",
"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": "6793b913-7cb7-4d9a-ad9f-d362a349e75a",
"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-01-19T13:52:45.8746097+00:00"
},
"work_instruction_details_id": "f39ce129-00be-418c-a417-bb87583fd930",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "db07bb36-9a31-45f6-8f8c-756b726a23e4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "499de185-5e8d-4e69-bf38-90d3da81fe53",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-19T13:52:45.8746097+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": "e937eb22-3d64-43ca-8dea-7a5fb26a1450",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-19T13:52:45.8746097+00:00"
}