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": "1b10568c-08e5-4232-a62b-cbbd38de1ffb",
"jobs_id": "280a051d-f6d9-4e68-b7ed-571a39832398",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "386dfa89-56dc-4dfc-bb3d-1dec546adf67",
"_parent_id": "9e0daeb5-a20d-4d37-b44c-2fc89be54432",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "671364f2-431e-42b3-93d0-fe15c6609f1b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "da7b3ff6-58cd-4d4e-8b65-cf9f3ef84742",
"_parent_id": "dcbe4b10-c509-4daa-b2f4-94ada4c14ccb",
"root_parent_id": "09b78328-35f3-4893-83d0-903127d46ddf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cb417414-f881-4a4b-9171-658cd526ec73",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "92c241a9-7e68-402c-89d8-f05816050ba9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad8daeac-9ab5-425b-bdf9-f1ac1e082fd5",
"_parent_code": "sample string 6",
"sales_organization_id": "2912a140-e9c8-440c-8dc5-ee629c789822",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+00:00"
},
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00"
},
"equipment_model_id": "f67d01a8-22ac-4717-9e57-992110acd490",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b3ceae4b-4336-43b4-af25-730e6648ed3e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bafad9c7-9b6a-4128-954a-5726aa991841",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "869361ab-c137-4366-967b-be37f3b12c9a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "31eefd92-fe27-455c-9023-22ebcdef011f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+00:00"
},
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00"
},
"equipment_family_id": "2b57bdd7-94af-49b0-92d2-a3ed5f2210a9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "92c241a9-7e68-402c-89d8-f05816050ba9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad8daeac-9ab5-425b-bdf9-f1ac1e082fd5",
"_parent_code": "sample string 6",
"sales_organization_id": "2912a140-e9c8-440c-8dc5-ee629c789822",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+00:00"
},
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00"
},
"date_in_production_since": "2026-06-04T18:48:45.6710687+00:00",
"date_out_of_production_since": "2026-06-04T18:48:45.6710687+00:00",
"date_end_support": "2026-06-04T18:48:45.6710687+00:00",
"sales_organization_id": "c59d102f-9f8c-411d-9193-e6ecc762d039",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+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-06-04T18:48:45.6710687+00:00"
},
"project_status_id": "22f02ed7-5730-48fb-bd0f-42dc663feca0",
"project_status_code": "sample string 10",
"project_status": {
"id": "a6139acc-19ff-48cf-9277-a0b13701ec16",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4e02a31c-1e34-4258-9689-e511553e8be3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00"
},
"company_id": "0431d201-354c-4154-a5d1-d225d3240c9b",
"company_code": "sample string 12",
"db_address_id": "9bbc3339-b04f-45a5-aef0-86bfcf07e149",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00baf858-6e5d-464b-aa23-10a341a20ea1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9c38ec03-149b-498b-b6bb-6b9d04122f6a",
"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-06-04T18:48:45.6710687+00:00",
"date_create": "2026-06-04T18:48:45.6710687+00:00",
"date_update": "2026-06-04T18:48:45.6710687+00:00",
"updated_by_user_id": "865ea88f-2bd7-46fc-af56-cd24c8d58604",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-04T18:48:45.6710687+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-06-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-04T18:48:45.6710687+00:00",
"date_last_job": "2026-06-04T18:48:45.6710687+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-04T18:48:45.6710687+00:00",
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00",
"is_mobile_installation": true
},
"job_type_id": "38c155b7-391e-4b6a-9330-47a1c6c8efb4",
"job_type_code": "sample string 7",
"job_type": {
"id": "87ca6098-59ad-451f-b83a-bb8d0f82c866",
"name": "sample string 2",
"sales_organization_id": "410c0dde-e972-4f98-8e31-33857e62cd61",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00",
"code": "sample string 7"
},
"job_priority_id": "9ab7b398-f33a-4681-893e-ee7fb92808f2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "908ad0b2-5432-45d2-b50d-34e9471d7028",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c4ba085c-4291-4ed8-b5ff-ce86aaea7749",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00"
},
"job_status_id": "83166bc1-74a1-43c8-9c70-e46f9b4dd76c",
"job_status_code": "sample string 11",
"db_address_id": "34edbc1f-c412-46bf-a494-c2f62e4602a0",
"contact_id": "0a1496ea-a5d3-4e86-b86f-833744a2ed4c",
"requested_by_company_id": "e1908344-f52b-4cab-8e93-881d87c8e096",
"requested_by_contact_id": "5912a319-6694-4425-a58f-f11c4e5ffb87",
"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-06-04T18:48:45.6710687+00:00",
"due_date": "2026-06-04T18:48:45.6710687+00:00",
"date_create": "2026-06-04T18:48:45.6710687+00:00",
"date_update": "2026-06-04T18:48:45.6710687+00:00",
"date_closed": "2026-06-04T18:48:45.6710687+00:00",
"suggested_user_id": "9d3c1eb1-7256-49f6-8c99-4071b90e0101",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9c327c00-2c9b-4955-9208-c90d605d9ea5",
"db_language_id": "876508ad-8853-4753-9c61-b0d3919d78e1",
"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-06-04T18:48:45.6710687+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e6f11762-7644-416c-bdff-9c337de27cf2",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d248dac3-5e77-4233-b670-1664ec45e99a",
"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": "76a60768-784a-4908-8ea1-d7d090f0a0d7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f53fe647-7af6-4d96-b8ac-ac70872688a6"
},
"suggested_date_start": "2026-06-04T18:48:45.6710687+00:00",
"skill_id": "42b41864-9c3f-4b8d-aedc-f52b267da94b",
"skill_code": "sample string 32",
"skill": {
"id": "c8c7720b-1b30-4ad0-9244-54b66fd9ac93",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aa715cd1-b9ff-43aa-8df2-2a2cd32258b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6faba14-950e-4219-900a-bca165dfc069",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc50d85-aec7-43b4-83b0-5c0cfce7535b",
"db_currency_id": "32966ff3-75e5-46c7-831c-27eba9a2626a",
"db_language_id": "154e2ef9-3575-42ff-9308-a9be51f346e5",
"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-06-04T18:48:45.6710687+00:00"
},
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6d526ff2-52a2-45e4-b7d0-a468b2e88621",
"date_reported_by_company": "2026-06-04T18:48:45.6710687+00:00",
"id2": 36,
"company_id": "1f4f3429-750c-4c13-a4d7-18faf851e518",
"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": "62aebb8f-a397-4575-9265-9d36f3bdf31c",
"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-06-04T18:48:45.6710687+00:00"
},
"work_instruction_details_id": "467c3097-b344-45fc-9533-06af22019b6f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d0201f88-418c-437e-be30-bd0093dd8ee7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5a6da79c-1495-4d62-a6f7-b8e2bf19de44",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-04T18:48:45.6710687+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": "c1602724-dc6f-4202-8f3c-9a103c7d7d12",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-04T18:48:45.6710687+00:00"
}