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": "09c76e4f-0dd7-40cb-94db-920c0c36b793",
"jobs_id": "f5ef840c-bb22-48cb-bc6c-32be7345dfc9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dfb5cdcc-c441-4f96-9b1f-59e2f58b620f",
"_parent_id": "22d60302-d08e-4951-bed0-7900524239a2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b3b02ea9-dbe9-48c0-a46c-5adedf2e259f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "555311b9-4214-4490-8652-c7548cbd0333",
"_parent_id": "7b4bce9d-1df3-4b8f-b05d-a4bb9366a37f",
"root_parent_id": "acaf80fa-59ef-4787-9fa6-0e0a6617c599",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "76c7efda-0dfb-4560-84a8-4df81a603fb0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "70bb65f0-2e49-4c71-aaab-683aa5b98e2e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c10b51af-dd45-47e2-a350-72d16432f61a",
"_parent_code": "sample string 6",
"sales_organization_id": "26c3b47a-a30c-475d-8c02-fec0cb7d6ce4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+00:00"
},
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00"
},
"equipment_model_id": "2788b2cf-2512-4672-b080-6ccddfa59180",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "371e89c7-5b53-4263-98ba-9dd551eeea33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fddcb97a-be9b-42ac-b9a7-f41ec0210b0a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9cb6519e-3ec0-44cd-9c58-1995700a47bd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "01016f25-ca76-4c8d-b866-5a8a6acd1e79",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+00:00"
},
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00"
},
"equipment_family_id": "56ec463a-a88b-4efa-8a00-efca8dc46025",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "70bb65f0-2e49-4c71-aaab-683aa5b98e2e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c10b51af-dd45-47e2-a350-72d16432f61a",
"_parent_code": "sample string 6",
"sales_organization_id": "26c3b47a-a30c-475d-8c02-fec0cb7d6ce4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+00:00"
},
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00"
},
"date_in_production_since": "2026-09-14T23:10:16.7079134+00:00",
"date_out_of_production_since": "2026-09-14T23:10:16.7079134+00:00",
"date_end_support": "2026-09-14T23:10:16.7079134+00:00",
"sales_organization_id": "948eb5f1-0765-4a29-9dda-ba7f9e9661d9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+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-09-14T23:10:16.7079134+00:00"
},
"project_status_id": "e59bb69f-db05-4658-bc2f-d73ae0bcbd68",
"project_status_code": "sample string 10",
"project_status": {
"id": "055490b0-aed9-478a-8d55-c18b0a707b91",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "04115630-3573-4372-8e0b-b9205a6ecdd2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00"
},
"company_id": "65b206d1-3ede-4f98-bc38-eb266a10c130",
"company_code": "sample string 12",
"db_address_id": "107851e7-a20c-48c7-9005-d524ebea338a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a6534361-8802-4c63-9db5-ff632a94c4d8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d863d53c-529d-4540-8c7a-b060256557b7",
"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-09-14T23:10:16.7079134+00:00",
"date_create": "2026-09-14T23:10:16.7079134+00:00",
"date_update": "2026-09-14T23:10:16.7079134+00:00",
"updated_by_user_id": "27e738f6-2c80-444e-b55c-f3ed5768f96e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-14T23:10:16.7079134+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-09-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-14T23:10:16.7079134+00:00",
"date_last_job": "2026-09-14T23:10:16.7079134+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-14T23:10:16.7079134+00:00",
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00",
"is_mobile_installation": true
},
"job_type_id": "db5bf81d-71a4-4156-8595-d7848b76192a",
"job_type_code": "sample string 7",
"job_type": {
"id": "c5ed40b8-ab17-4ac6-bc73-d7a9501ee312",
"name": "sample string 2",
"sales_organization_id": "ec37ef31-3fec-4727-898b-6fe88adc3adf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00",
"code": "sample string 7"
},
"job_priority_id": "6a63a561-c09c-4a74-97c3-d9c37817f0cb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8668a414-6404-45de-8427-97dd01ae3af3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "92035e20-d78e-46bc-93dd-9a42b0db45f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00"
},
"job_status_id": "7036321b-79e2-413a-9881-6fb19a24784f",
"job_status_code": "sample string 11",
"db_address_id": "4cf60ad5-26d7-49c9-8705-099ec3132115",
"contact_id": "aae47e85-337f-472e-ad67-1013f29442ea",
"requested_by_company_id": "1870abd6-e298-4171-aa1c-129c8dd402c7",
"requested_by_contact_id": "66d0e6d6-b869-4030-802c-f4fce85f1ddb",
"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-09-14T23:10:16.7079134+00:00",
"due_date": "2026-09-14T23:10:16.7079134+00:00",
"date_create": "2026-09-14T23:10:16.7079134+00:00",
"date_update": "2026-09-14T23:10:16.7079134+00:00",
"date_closed": "2026-09-14T23:10:16.7079134+00:00",
"suggested_user_id": "76ab2831-1376-4fd6-b32c-6a7e995ff06c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4b84d14f-f7c1-4538-b0a4-950fa9de3f76",
"db_language_id": "cdea96a6-0efb-4054-91b5-aa883b215013",
"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-09-14T23:10:16.7079134+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7d4988cf-ff2a-4056-9ea1-bb2da5999822",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "eb673a20-90ee-4c2f-9aa2-d1d01df37797",
"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": "310e7bca-4a6c-4e15-b3c9-cd08bdc94d8a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "566f3480-808f-487e-8559-4990e216bbcc"
},
"suggested_date_start": "2026-09-14T23:10:16.7079134+00:00",
"skill_id": "04e55b41-5fc3-4133-9e61-acc52f4e5d6b",
"skill_code": "sample string 32",
"skill": {
"id": "7dbfad87-ce7f-4123-ad3b-512f8c220f91",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a91961e3-58e1-42c0-bddb-e6d05ecf7157",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2d29fb7-4569-4df0-9f21-99b3d0f92c96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d12aa93-45bf-4b8d-bbf1-1cc75e7e513d",
"db_currency_id": "b8267933-f168-4d10-8cf4-3d9b44dd4c4d",
"db_language_id": "13e0515e-5560-4764-b869-c33b5515fbe7",
"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-09-14T23:10:16.7079134+00:00"
},
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aed50dfb-15e4-42e6-901f-3eca7c807f4c",
"date_reported_by_company": "2026-09-14T23:10:16.7079134+00:00",
"id2": 36,
"company_id": "b928bfb2-db89-434c-b6d5-e8a164f1fe5f",
"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": "03143bf5-3ba7-45e0-98fe-e85e82e12430",
"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-09-14T23:10:16.7079134+00:00"
},
"work_instruction_details_id": "0ef8abd5-f964-4d3d-8525-ee73f565d0cf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7b982cee-d5f8-460f-8fdf-706e86e5f430",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f51fe384-ac54-492f-8033-2dfb057ad36e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-14T23:10:16.7079134+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": "48e202ff-18c7-49a6-909e-2ed82ac552fb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-14T23:10:16.7079134+00:00"
}