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": "311c035c-886c-415a-ba67-4985c0a5e0a5",
"jobs_id": "c5956696-4776-4b17-99f2-4459f3b2f3ab",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3e7ad83d-bd92-4316-a582-0f04c2a2aeac",
"_parent_id": "537d2827-721d-420d-b96b-4b9e96d765f1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "31fa2658-ec98-43c9-b8d7-c77b709caa1e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e9983b22-db76-4447-be11-83496d702c5e",
"_parent_id": "240f774d-fb27-40a0-a971-8f44e4795d12",
"root_parent_id": "6127c3ae-65b4-4a36-a160-a44469945f41",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "adc2a89b-ffef-41e9-82ff-547cffc90b34",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "38ea6abc-3be7-4e80-a2c5-501d7d86e504",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db7779d6-a2a2-4c02-ba3e-1cfa6212f35a",
"_parent_code": "sample string 6",
"sales_organization_id": "6899dbcc-1574-4e4f-ae32-2c4f72629274",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+00:00"
},
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00"
},
"equipment_model_id": "ac97e918-f339-49c6-8abf-62e4833c4bfb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5d90be02-51d0-4c5a-bda6-24364f5717ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d30f7e85-5c10-44d1-a9a2-980fce7402e8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d5bb4e8b-93d7-43ec-864b-5189d71bce86",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70388cd0-e038-4715-af20-1f69b3798851",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+00:00"
},
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00"
},
"equipment_family_id": "312893ed-04e7-414e-a797-b877278f59f5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "38ea6abc-3be7-4e80-a2c5-501d7d86e504",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db7779d6-a2a2-4c02-ba3e-1cfa6212f35a",
"_parent_code": "sample string 6",
"sales_organization_id": "6899dbcc-1574-4e4f-ae32-2c4f72629274",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+00:00"
},
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00"
},
"date_in_production_since": "2026-07-13T02:27:32.999553+00:00",
"date_out_of_production_since": "2026-07-13T02:27:32.999553+00:00",
"date_end_support": "2026-07-13T02:27:32.999553+00:00",
"sales_organization_id": "a58bda8b-148a-4a63-b826-8cd0a4a2e1cc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+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-07-13T02:27:32.999553+00:00"
},
"project_status_id": "5544b424-40c3-4cb7-ad5b-435df776d463",
"project_status_code": "sample string 10",
"project_status": {
"id": "2748d701-28c8-4612-82dc-2a3602fa63cb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f9eb811d-476c-4d12-b010-a905908591d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00"
},
"company_id": "93445748-7733-4cdf-8b0b-afd2c53215c2",
"company_code": "sample string 12",
"db_address_id": "a5df2ba3-2312-46a0-b04f-e3ec9f25df2d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eaa5ab33-5ce4-4695-8756-1986ef7bf5ff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "028c19e0-6208-4950-bdc3-ae6621d0f447",
"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-07-13T02:27:32.999553+00:00",
"date_create": "2026-07-13T02:27:32.999553+00:00",
"date_update": "2026-07-13T02:27:32.999553+00:00",
"updated_by_user_id": "31788fbf-524a-4cab-8251-3eb4fc26ec57",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T02:27:32.999553+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-07-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T02:27:32.999553+00:00",
"date_last_job": "2026-07-13T02:27:32.999553+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T02:27:32.999553+00:00",
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00",
"is_mobile_installation": true
},
"job_type_id": "8be61684-1e11-46c1-92e0-29f0e18ec68d",
"job_type_code": "sample string 7",
"job_type": {
"id": "a4274b5e-dc80-4ae0-8e3d-4b6387c32275",
"name": "sample string 2",
"sales_organization_id": "94387a7f-1b7f-4b15-98b9-74003e013bee",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00",
"code": "sample string 7"
},
"job_priority_id": "aeef9dc0-828d-448f-8f7a-359ca93c752d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2c98c1de-0c2c-4398-94c9-8ad7080414c4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d840ec8-d0c4-4cc5-b1a5-ec250c157c82",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00"
},
"job_status_id": "717ca01d-2cc5-4046-8558-dbc901044837",
"job_status_code": "sample string 11",
"db_address_id": "1f4577af-4fb9-4eba-bb49-29b0c09ff510",
"contact_id": "fd3d3b39-4640-425e-b7cf-3e85e6e9afde",
"requested_by_company_id": "3be8172b-cdd2-41db-acd4-75ceb025ef05",
"requested_by_contact_id": "cda83ab1-778e-4efd-8518-b002cccb9e36",
"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-07-13T02:27:32.999553+00:00",
"due_date": "2026-07-13T02:27:32.999553+00:00",
"date_create": "2026-07-13T02:27:32.999553+00:00",
"date_update": "2026-07-13T02:27:32.999553+00:00",
"date_closed": "2026-07-13T02:27:32.999553+00:00",
"suggested_user_id": "70e5bb8d-28be-492e-9ca6-292ed9006a34",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2e4983b7-871c-4244-bc21-4833ce6cc993",
"db_language_id": "5d3e9357-6191-4ac2-8751-993589ee9f12",
"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-07-13T02:27:32.999553+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a5580abf-ad2b-4364-97bf-012a68fc1de6",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "88e9b9a9-d965-45e6-a3d4-b0cf07a40838",
"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": "8464627f-6088-4af0-ae7f-19b81ac3c7be",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T02:27:32.999553+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4a57ee92-bac8-489f-b0fe-fc326c3c5bba"
},
"suggested_date_start": "2026-07-13T02:27:32.999553+00:00",
"skill_id": "2b8df14d-876a-4083-80dc-3eea69f4158c",
"skill_code": "sample string 32",
"skill": {
"id": "055bc266-cd55-42f9-b6da-9f7ee9232a67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cdb75414-2332-44a4-80d8-23af06f8d644",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c63efedc-8fa7-4551-af52-86bb4cd89625",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "77827cb3-8f1e-4e03-b26d-3c5a26490042",
"db_currency_id": "ba94425d-7126-4703-a7a5-3e8a1f07fccb",
"db_language_id": "00f617bd-84b0-4f54-b27a-08dba0de6a7b",
"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-07-13T02:27:32.999553+00:00"
},
"modified_dateutc": "2026-07-13T02:27:33.0151743+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c6c01442-a84a-48c3-a2da-7188dce2a3a3",
"date_reported_by_company": "2026-07-13T02:27:33.0151743+00:00",
"id2": 36,
"company_id": "18b5f95b-a64e-4229-b269-9dfdc5d19e83",
"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": "e9c79d7c-d77a-4064-bd51-f9cb293d4930",
"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-07-13T02:27:33.0151743+00:00"
},
"work_instruction_details_id": "bf361040-321b-450e-abb7-f49ca30ca0fb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "54db3637-2699-4714-b9be-df018301ddd2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7632cd41-dcad-44b2-abfb-be9d796ac58b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T02:27:33.0151743+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": "e5d486a7-81e6-41ae-bcca-cf9fbae25115",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T02:27:33.0151743+00:00"
}