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": "35b43cd3-a5aa-4b7c-9905-d1ee8d977cf2",
"jobs_id": "a926dcb3-c973-4f84-b53a-42e6f8e8ef5e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aeb4b7d3-0ed4-4852-9cd1-064b6e11028b",
"_parent_id": "2b0ed51f-b155-4518-a095-b36a0c23b040",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8ffeb0bb-f47c-4735-a30b-f0740ce1a7a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "59531dcb-f434-452b-91ad-e15c6c8b7ed9",
"_parent_id": "086b35e4-eea5-4492-8b0a-08af329a4d20",
"root_parent_id": "d24dbc6b-1997-49e2-8e2e-428f79ee627c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "897473fc-f1e4-495f-9e40-d1866017f907",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e03dea84-764f-4064-90d1-e56dfa80e75c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ddb75942-022a-4bc9-8963-f4ff4d352282",
"_parent_code": "sample string 6",
"sales_organization_id": "aa1e07b7-4007-4d68-88aa-b01d91f5d4fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+00:00"
},
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00"
},
"equipment_model_id": "4364d201-27e3-4cc5-b46e-3c4b3a6d5569",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c56aa1e-3958-43ee-9866-dce8d70af825",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fe623918-166f-4946-835e-964dd52c5873",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7b4677ac-b015-4f7c-9e8f-6208b0e2912f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "98097503-8d60-4e20-ad92-1fb602fd36fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+00:00"
},
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00"
},
"equipment_family_id": "d3aef58f-40c9-4ef0-858d-566c49f58dac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e03dea84-764f-4064-90d1-e56dfa80e75c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ddb75942-022a-4bc9-8963-f4ff4d352282",
"_parent_code": "sample string 6",
"sales_organization_id": "aa1e07b7-4007-4d68-88aa-b01d91f5d4fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+00:00"
},
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00"
},
"date_in_production_since": "2026-10-31T22:58:03.5905894+00:00",
"date_out_of_production_since": "2026-10-31T22:58:03.5905894+00:00",
"date_end_support": "2026-10-31T22:58:03.5905894+00:00",
"sales_organization_id": "1977f97a-5eaa-4d5d-a44f-88e38e1d0f17",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+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-10-31T22:58:03.5905894+00:00"
},
"project_status_id": "077de62e-0aaf-4547-b8d5-47dcae207e6a",
"project_status_code": "sample string 10",
"project_status": {
"id": "4f85e10b-a57b-49f6-8719-b7551400ae3f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c9eb4ea1-ed84-48b7-a60c-ee9b797e3c8e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00"
},
"company_id": "7cf11b76-3334-4947-8251-9953f2c51c29",
"company_code": "sample string 12",
"db_address_id": "074672bb-471b-47ec-9984-780c0310d4e2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4190004d-8742-459c-9bf9-8f4aae476746",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8e67244f-0a21-4baa-9043-329ca4e028ba",
"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-10-31T22:58:03.5905894+00:00",
"date_create": "2026-10-31T22:58:03.5905894+00:00",
"date_update": "2026-10-31T22:58:03.5905894+00:00",
"updated_by_user_id": "647344c9-113d-4348-9a27-fc2387f6f74a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-31T22:58:03.5905894+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-10-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-31T22:58:03.5905894+00:00",
"date_last_job": "2026-10-31T22:58:03.5905894+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-31T22:58:03.5905894+00:00",
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00",
"is_mobile_installation": true
},
"job_type_id": "6a22747f-1288-4332-ba31-5c9493f5f53c",
"job_type_code": "sample string 7",
"job_type": {
"id": "a3f1befd-9137-48e1-abb3-5bb084dfa665",
"name": "sample string 2",
"sales_organization_id": "e3bfcabb-6201-4863-b46f-1c7f5ed741b1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00",
"code": "sample string 7"
},
"job_priority_id": "959afeff-0ba8-4614-8526-253614f481f4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "034a7659-451a-443b-a93b-28e5f9818e39",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bce17d69-1b5b-43a1-91fb-f0aed456258c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00"
},
"job_status_id": "a8071cc3-4f2b-4dd4-a8ae-f16ea760b874",
"job_status_code": "sample string 11",
"db_address_id": "52d67599-ee01-4d55-8203-7e23682e19ff",
"contact_id": "61dcd3cc-1f0b-44b6-b3e2-c18e630ad6cc",
"requested_by_company_id": "9f792f50-0123-424f-b237-cfbc9f327284",
"requested_by_contact_id": "134b08f4-b911-4106-a684-e48b441e37ea",
"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-10-31T22:58:03.5905894+00:00",
"due_date": "2026-10-31T22:58:03.5905894+00:00",
"date_create": "2026-10-31T22:58:03.5905894+00:00",
"date_update": "2026-10-31T22:58:03.5905894+00:00",
"date_closed": "2026-10-31T22:58:03.5905894+00:00",
"suggested_user_id": "c39859e2-d713-482d-bdc2-76d306e6e707",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b6b617c1-1811-478a-8e37-b2af55f130a1",
"db_language_id": "49d58b63-6833-450c-9ec5-5a9a5d665993",
"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-10-31T22:58:03.5905894+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ee945a32-b86c-4435-9c66-76ac4c3ffcb8",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "73a943f5-297f-4e17-b965-db4cc605a627",
"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": "741743da-5e5a-4377-ade3-7e6b19494028",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7648f2d7-83d0-4b85-bb46-a3d27d8fd1d9"
},
"suggested_date_start": "2026-10-31T22:58:03.5905894+00:00",
"skill_id": "220c4b81-275d-4bb6-9feb-375bf7c717c5",
"skill_code": "sample string 32",
"skill": {
"id": "fda59f7a-de7d-41d6-b856-c7f7a77a2312",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "af6eb589-ad86-4d1d-b3f0-203a52b22add",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1845b369-26a6-42a0-90ab-da1d10ec1f7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf4ae36b-7f71-40dd-8cdc-b3fec70ae3e3",
"db_currency_id": "8c87ccd2-ab32-4af7-9ce3-fdf1002e5718",
"db_language_id": "7f69f66f-cecf-47b2-9f6d-55842ad2ec30",
"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-10-31T22:58:03.5905894+00:00"
},
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "62c8a389-e76f-4b53-b121-6e8f83fe614c",
"date_reported_by_company": "2026-10-31T22:58:03.5905894+00:00",
"id2": 36,
"company_id": "c3075e1e-4b89-4591-aa37-4bc18295bd3d",
"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": "fdb6d802-1dd5-4f77-b718-7c2fb24a4de0",
"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-10-31T22:58:03.5905894+00:00"
},
"work_instruction_details_id": "d6388633-e7c4-419e-a9cc-e1309c589f4d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f212d5aa-fa1d-4347-8be0-58dcac703a1f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "974f4698-4418-41ab-a382-7222948d8113",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-31T22:58:03.5905894+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": "924f8c17-3e58-4085-8289-c9cb2fe686b5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-31T22:58:03.5905894+00:00"
}