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": "ed207a56-fd5d-48d1-92a3-ea687e2368c2",
"jobs_id": "d2148372-fbe8-4517-b74d-abedec4caa9f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "20a50637-fe15-4d92-8a8f-a8a8cd5bc949",
"_parent_id": "444c06c6-963d-4dcf-83bb-0585e8945028",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "75809245-f7f7-43af-8edb-af0f4a271af7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "165c07c1-864c-41d0-8a6c-bd62eb0ec00f",
"_parent_id": "83a1e33a-cd48-4958-b053-2037dac8417c",
"root_parent_id": "171298b3-3c41-4df2-817d-c81617e8854d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ca92bb52-b451-47d7-82ae-0c7478c81690",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "63adafb9-00bb-4d48-b6cd-15a0c1a5a596",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "92fb6ffe-87f7-4a5b-9103-27948100bd5c",
"_parent_code": "sample string 6",
"sales_organization_id": "a30e25af-5007-44ce-8044-efc956c95480",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+00:00"
},
"modified_dateutc": "2026-03-27T21:49:09.8166888+00:00"
},
"equipment_model_id": "4bf3b9f9-296e-4adc-8a42-da032983d04a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "beb5c7f1-8cbb-4e53-a720-1a353f95b6e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c1fcc036-de30-4c80-a592-84f4d368de8d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c056bd94-ef64-4e3d-bce4-ba703a94d181",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ac932b13-8589-4e97-be23-9840c1e6ae60",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+00:00"
},
"modified_dateutc": "2026-03-27T21:49:09.8166888+00:00"
},
"equipment_family_id": "a42513a7-0e1c-4ae8-adad-537e0eda58b0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "63adafb9-00bb-4d48-b6cd-15a0c1a5a596",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "92fb6ffe-87f7-4a5b-9103-27948100bd5c",
"_parent_code": "sample string 6",
"sales_organization_id": "a30e25af-5007-44ce-8044-efc956c95480",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+00:00"
},
"modified_dateutc": "2026-03-27T21:49:09.8166888+00:00"
},
"date_in_production_since": "2026-03-27T21:49:09.8166888+00:00",
"date_out_of_production_since": "2026-03-27T21:49:09.8166888+00:00",
"date_end_support": "2026-03-27T21:49:09.8166888+00:00",
"sales_organization_id": "1722d4e0-ca43-448b-9c12-b92c6a66e041",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+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-03-27T21:49:09.8323192+00:00"
},
"project_status_id": "9457ca7b-5a32-48a5-bc35-cba3e78a6312",
"project_status_code": "sample string 10",
"project_status": {
"id": "24aa2441-a225-4b79-9c0e-35a1b7495c34",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d81a8fda-e2a3-456e-a487-361c0f0c78c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-27T21:49:09.8323192+00:00"
},
"company_id": "f8713f69-a357-4185-8b11-812d1f95fa22",
"company_code": "sample string 12",
"db_address_id": "50d36cc5-4747-4b50-ae4f-86aa27e457de",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bd6526fa-5bb0-4e3a-adf6-bf346fcb89cb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5470b819-29ca-4092-aafd-ec4b26fcdca7",
"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-03-27T21:49:09.8323192+00:00",
"date_create": "2026-03-27T21:49:09.8323192+00:00",
"date_update": "2026-03-27T21:49:09.8323192+00:00",
"updated_by_user_id": "908ffff5-5696-4c25-830a-9f5026f1f7e6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-27T21:49:09.8323192+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-03-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-27T21:49:09.8323192+00:00",
"date_last_job": "2026-03-27T21:49:09.8323192+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-27T21:49:09.8323192+00:00",
"modified_dateutc": "2026-03-27T21:49:09.8323192+00:00",
"is_mobile_installation": true
},
"job_type_id": "df3ae9ae-53b4-4cdc-bfe3-f2ae50d929d6",
"job_type_code": "sample string 7",
"job_type": {
"id": "7508b0e5-8f54-46aa-bc4e-009f84094b18",
"name": "sample string 2",
"sales_organization_id": "afaf987d-fc41-4039-bec4-e97477ba00cc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-27T21:49:09.8323192+00:00",
"code": "sample string 7"
},
"job_priority_id": "a7b1bfc4-2fdb-4da6-ae75-de0dfad4c534",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5e72404e-8ad0-4ff8-a9b5-56dc64f35638",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9e79fcb7-3a15-4e19-9883-23648f042281",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-27T21:49:09.8323192+00:00"
},
"job_status_id": "843259f8-43c7-4380-9436-5a7ea430b0af",
"job_status_code": "sample string 11",
"db_address_id": "3885e81c-7056-44e0-a615-fa59e0b632e2",
"contact_id": "85b9cd5a-badd-4092-a481-8c75e98eab28",
"requested_by_company_id": "7cfb34f9-2685-42d9-88df-95e5a4cab6db",
"requested_by_contact_id": "20740c12-061c-4494-aa53-4bb7453ae52d",
"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-03-27T21:49:09.8323192+00:00",
"due_date": "2026-03-27T21:49:09.8323192+00:00",
"date_create": "2026-03-27T21:49:09.8323192+00:00",
"date_update": "2026-03-27T21:49:09.8323192+00:00",
"date_closed": "2026-03-27T21:49:09.8323192+00:00",
"suggested_user_id": "414fe4ab-7410-4887-bd92-eae4033449fe",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8c9e9332-f082-4e53-ae07-a04a58df9ce3",
"db_language_id": "d52b249a-a6c5-4ef8-abcf-67d90ea89a5d",
"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-03-27T21:49:09.8323192+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ea2b1477-8cba-4998-84cf-f355f93ba7d4",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a9e6ebc5-db2d-4cd4-90ef-0dca0c2c107d",
"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": "8bd7cec4-8a35-4691-9a9b-df68e59591e6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-27T21:49:09.8323192+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8c32b2ff-ab77-4588-9cb4-93b81e44ed37"
},
"suggested_date_start": "2026-03-27T21:49:09.8323192+00:00",
"skill_id": "12dd7d73-2602-4aa3-9357-662d4ea4516b",
"skill_code": "sample string 32",
"skill": {
"id": "7f2eb252-18f7-42b5-9d9b-dab8f39ece44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d12567ec-9a9b-4856-b600-ebe54fbc59d6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb604ede-f8f5-4e30-a370-13aff3b8fcae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "334c5962-9b8e-4a8b-81e0-e8259415ce5b",
"db_currency_id": "fd14575e-6801-4ef8-900c-97f52f81706a",
"db_language_id": "f50e2c6c-e38f-49b0-94f0-ec40aa3e159d",
"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-03-27T21:49:09.8166888+00:00"
},
"modified_dateutc": "2026-03-27T21:49:09.8323192+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d5f865ac-642a-4fd3-8b6f-138ea32d4065",
"date_reported_by_company": "2026-03-27T21:49:09.8323192+00:00",
"id2": 36,
"company_id": "814d3e83-f7e4-4465-adc9-62595c1c8468",
"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": "beb79578-805d-4160-ac11-dd4c6e9f980d",
"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-03-27T21:49:09.8323192+00:00"
},
"work_instruction_details_id": "70c9a7fc-0909-4fa3-82d5-1e3dde4cca2b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "edfbf1c1-7686-420d-8bef-f61f8cad57aa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5449b4b5-66a4-4cbe-89c9-2df7396e4b77",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-27T21:49:09.8323192+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": "d5b33a75-d340-48dd-9374-45b41fd075db",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-27T21:49:09.8323192+00:00"
}