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": "dfe25024-0d61-423c-b25a-0bccc56de1cd",
"jobs_id": "5152d7d1-f187-4ff9-9596-cbf683e71923",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8a503386-c056-42ef-baef-5a510442142d",
"_parent_id": "623f2019-b5ff-4448-a1c6-3e82f228b891",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6bcbfc63-af6b-4c69-9946-779022298b4b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "52624cfe-f292-4e89-b44b-e5b7963bfbc0",
"_parent_id": "44ac8539-4a5a-408a-b48a-6e0d38d86687",
"root_parent_id": "59b87c22-49a9-4388-ab4e-e54081c7c6f8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fe290617-293a-4bec-91ea-6d6309bbb53c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3aa175dc-15aa-441d-88b0-f041a5b410f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3878e378-6126-4c03-b7f8-d47ec613cc98",
"_parent_code": "sample string 6",
"sales_organization_id": "612e7f0a-5493-4159-9f03-d6a5008dd7fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+00:00"
},
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00"
},
"equipment_model_id": "96ad166d-5237-4700-b4d1-701a62b0b43d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8f64255f-4264-4f73-bdce-12be06881fbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e070cfbd-c471-4647-b470-d980b4342c19",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d4bd6621-bfbc-42c3-be23-c50fe9c82894",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "950506f2-1cb0-471a-b016-d2b68c4abd60",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+00:00"
},
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00"
},
"equipment_family_id": "cd7c160e-7813-48be-8aa2-8cd20c3db2cd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3aa175dc-15aa-441d-88b0-f041a5b410f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3878e378-6126-4c03-b7f8-d47ec613cc98",
"_parent_code": "sample string 6",
"sales_organization_id": "612e7f0a-5493-4159-9f03-d6a5008dd7fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+00:00"
},
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00"
},
"date_in_production_since": "2025-12-28T21:31:00.2049727+00:00",
"date_out_of_production_since": "2025-12-28T21:31:00.2049727+00:00",
"date_end_support": "2025-12-28T21:31:00.2049727+00:00",
"sales_organization_id": "38a24475-841b-4cbb-92fd-a3e61607548c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+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-28T21:31:00.2049727+00:00"
},
"project_status_id": "0adff5e8-8f31-4106-aae8-11830476ff39",
"project_status_code": "sample string 10",
"project_status": {
"id": "3733be89-4c50-495e-8175-efde29c9b0cf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "306ffe42-b4bf-4ef8-b62b-43e61e43a199",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00"
},
"company_id": "42a14253-e0a4-42b9-93cb-403fbc962cf5",
"company_code": "sample string 12",
"db_address_id": "8e2f7118-f002-429f-b13e-3aec8f5e4f07",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "331cf02e-2fb4-4330-a604-71d4208f059e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a9dcf3ef-8c1e-4e98-b383-8589ddc5cd95",
"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-28T21:31:00.2049727+00:00",
"date_create": "2025-12-28T21:31:00.2049727+00:00",
"date_update": "2025-12-28T21:31:00.2049727+00:00",
"updated_by_user_id": "2bc4f0c6-589e-4b06-8199-5546639f8144",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-28T21:31:00.2049727+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-28T21:31:00.2049727+00:00",
"date_last_job": "2025-12-28T21:31:00.2049727+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-28T21:31:00.2049727+00:00",
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00",
"is_mobile_installation": true
},
"job_type_id": "cecf2165-d8ba-4e9d-a1b5-bc8ae8160710",
"job_type_code": "sample string 7",
"job_type": {
"id": "ae7dd550-bb05-4550-ad24-7cbb6f3edff5",
"name": "sample string 2",
"sales_organization_id": "3d683323-6a6f-423c-a6ef-3797fbf462e3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00",
"code": "sample string 7"
},
"job_priority_id": "64d2363e-9512-4ce0-a8d3-659219561c82",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4eee84e0-306a-4fcc-a9c7-357d74381a25",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "02281710-9819-4f0a-af0b-659a4f13c4dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00"
},
"job_status_id": "9ea3ed5d-5259-4f09-87b5-d1840796f1aa",
"job_status_code": "sample string 11",
"db_address_id": "3f027c43-95ad-4aa4-aee6-81881187e1e4",
"contact_id": "fb1d05d5-64a0-454d-ae49-5d73ca31e9d8",
"requested_by_company_id": "c5380604-e696-4fe7-921a-d25cc5258e8b",
"requested_by_contact_id": "bce7e8a8-905e-4905-973b-f92586c3d15c",
"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-28T21:31:00.2049727+00:00",
"due_date": "2025-12-28T21:31:00.2049727+00:00",
"date_create": "2025-12-28T21:31:00.2049727+00:00",
"date_update": "2025-12-28T21:31:00.2049727+00:00",
"date_closed": "2025-12-28T21:31:00.2049727+00:00",
"suggested_user_id": "6760ba49-9b81-409b-b1a1-27d03b531c62",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "070a9072-67ed-4c35-802c-f8706dbcb534",
"db_language_id": "f6ac35e9-0a87-4260-8f2c-66db5cbbc666",
"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-28T21:31:00.2049727+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bfcf08b9-3e04-4edd-ba04-0daa4d93f68b",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "75d34eae-4809-4765-a982-6c844813e74e",
"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": "5ce8721a-c3e7-47c3-8f78-c02a6be386d8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d0eb2cc5-7d92-48b4-bd38-23d641c813c2"
},
"suggested_date_start": "2025-12-28T21:31:00.2049727+00:00",
"skill_id": "3508f0ef-0a88-460f-82ef-3e3f62c9b39b",
"skill_code": "sample string 32",
"skill": {
"id": "b4e6aed4-6f57-464c-8d55-65ef80dbdc97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a02f57a2-84a1-46d0-ab9b-2c4f3485845c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34efcd42-cd91-48f4-a289-9ab00646d8b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0456d0bd-e604-4ac6-b77d-bbc61b156b04",
"db_currency_id": "50e5813b-a36b-4599-b556-5f31d23beefd",
"db_language_id": "92183b1b-f89c-4ed1-b0e0-80b2af5e54eb",
"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-28T21:31:00.2049727+00:00"
},
"modified_dateutc": "2025-12-28T21:31:00.2049727+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "061c9f11-9401-4c80-a538-1cd2e3433ab9",
"date_reported_by_company": "2025-12-28T21:31:00.2049727+00:00",
"id2": 36,
"company_id": "14e3e930-4fe0-4fe6-8812-3fc6b6591aa9",
"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": "0545fba5-205e-4d73-b175-0095fe2fbfce",
"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-28T21:31:00.2049727+00:00"
},
"work_instruction_details_id": "322bfd5b-1267-4f35-abb2-d20ad4265aae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "291f2ab4-6061-4594-b26c-ed1d672c326f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8c012120-3cd1-4479-a740-e5c729b9f00e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-28T21:31:00.2205849+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": "459643c9-0b6d-4ea1-a7b3-de8433b0d4bc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-28T21:31:00.2205849+00:00"
}