Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "0aa05e0e-ee68-4627-9078-81d573fbe997",
"jobs_id": "1b7aef5d-6d16-4f56-a5c4-d530c22619a1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "518c909a-1339-4252-a3bc-f7a77932b800",
"_parent_id": "2df2a641-62ec-4b8b-81dc-dd34a336e698",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "54a83bf8-ad6c-491b-88df-b11dc7656dba",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2401325f-439a-4b75-aa5a-b4c06205c368",
"_parent_id": "57b9c30b-ef86-44ee-a939-6b02406beeb3",
"root_parent_id": "472156a0-9591-4f97-9d1d-6389fcf9dfd9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "74f93982-56ab-4ca9-a6c1-69c69611e195",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "834925c4-631a-4ee1-a728-87e7445942fb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52f7dabb-d65d-4468-8937-acd921f87d0e",
"_parent_code": "sample string 6",
"sales_organization_id": "7f7e68e3-21dd-49f0-a013-efb05ba75f86",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+00:00"
},
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00"
},
"equipment_model_id": "f2003b1b-64a5-4305-8458-fc2eccc6cfc7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "07ebb624-e7de-4f3d-b0bc-5ca4be94f98c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7bf0cdea-3f66-48b1-afbd-8a61247591c4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "be351dfc-4e2c-4e7b-b3aa-8146940173af",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8d5cd407-edcb-4457-ba63-cb7bc0856c89",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+00:00"
},
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00"
},
"equipment_family_id": "574e4509-39b1-4ffa-b5c6-9efa44a07c22",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "834925c4-631a-4ee1-a728-87e7445942fb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "52f7dabb-d65d-4468-8937-acd921f87d0e",
"_parent_code": "sample string 6",
"sales_organization_id": "7f7e68e3-21dd-49f0-a013-efb05ba75f86",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+00:00"
},
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00"
},
"date_in_production_since": "2025-12-29T03:49:04.6221317+00:00",
"date_out_of_production_since": "2025-12-29T03:49:04.6221317+00:00",
"date_end_support": "2025-12-29T03:49:04.6221317+00:00",
"sales_organization_id": "b99005f6-74eb-4704-8724-d7b55c5b717e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+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-29T03:49:04.6221317+00:00"
},
"project_status_id": "a7035864-7752-4f1c-8e5b-78da76ab497d",
"project_status_code": "sample string 10",
"project_status": {
"id": "4fd6ed5d-8d25-4739-822f-edf7d41f544a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fd080b16-2360-4875-b989-f9ced00471cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00"
},
"company_id": "a71efc11-b9ba-4f37-9f13-5503b1ae219f",
"company_code": "sample string 12",
"db_address_id": "5118d1cf-d28a-4360-8dec-b986ea463ce9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a0235074-cca6-4a5c-809c-f73edff969fa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f2824c28-a08b-4f73-8999-6fb93f9dd4d6",
"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-29T03:49:04.6221317+00:00",
"date_create": "2025-12-29T03:49:04.6221317+00:00",
"date_update": "2025-12-29T03:49:04.6221317+00:00",
"updated_by_user_id": "6acecc8f-71c9-4722-a53d-39b1420ab303",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-29T03:49:04.6221317+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-29T03:49:04.6221317+00:00",
"date_last_job": "2025-12-29T03:49:04.6221317+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-29T03:49:04.6221317+00:00",
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00",
"is_mobile_installation": true
},
"job_type_id": "199906fe-76f0-4570-9f0e-7e47b75e0e4f",
"job_type_code": "sample string 7",
"job_type": {
"id": "fd61d18d-cad2-4dca-9e55-1f86c891e56f",
"name": "sample string 2",
"sales_organization_id": "58a93c1d-d354-4357-912a-863258702319",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00",
"code": "sample string 7"
},
"job_priority_id": "52c6e725-e5a9-442c-8bac-226c0a885eda",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c4c1bd9f-5747-4bd4-81f7-e78d7cfda0e1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "22c7e8d0-ce11-4c0c-8c93-e0fe786fe295",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00"
},
"job_status_id": "4b6c36fb-2fb7-4ea7-8974-4113105b284d",
"job_status_code": "sample string 11",
"db_address_id": "37755267-f162-442a-899c-8e2833c1f28c",
"contact_id": "69115d72-5541-4d17-a650-396a6e8dc208",
"requested_by_company_id": "48e8b8b0-fa12-432f-98d3-4d19e43314ea",
"requested_by_contact_id": "dd5cb349-2e3f-4e8d-aaa9-da361a7e7c14",
"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-29T03:49:04.6221317+00:00",
"due_date": "2025-12-29T03:49:04.6221317+00:00",
"date_create": "2025-12-29T03:49:04.6221317+00:00",
"date_update": "2025-12-29T03:49:04.6221317+00:00",
"date_closed": "2025-12-29T03:49:04.6221317+00:00",
"suggested_user_id": "516fd991-50ea-4071-a5ad-43f509b536bb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "869b2638-625c-4608-9baa-4685a429dbae",
"db_language_id": "b3a12bdf-8695-4ade-bc85-adf452010cbf",
"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-29T03:49:04.6221317+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "948da8b1-3136-49f7-9158-4e33f33de473",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d927fce1-1d69-4068-8604-cd28aae6b42a",
"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": "aee8da0e-4077-47ec-b9bb-4f40e77bab8e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e291d17c-7232-49da-9ea8-366ba38ecd5a"
},
"suggested_date_start": "2025-12-29T03:49:04.6221317+00:00",
"skill_id": "00a52b4d-916d-4d06-9b11-245f7757e1e8",
"skill_code": "sample string 32",
"skill": {
"id": "44937373-6fa2-4eb8-8b7c-e5933924c48e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "08882142-b841-4c5d-8180-343480d3a1de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ebe1cb75-a7e5-45c6-ac3b-0add1d3cd28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "11667b63-2a47-4506-aabe-6bc10527593a",
"db_currency_id": "64a8c4f0-efd6-408f-a98d-64cdc43c23c1",
"db_language_id": "6d668857-0505-4064-a6a3-9f4c2ad34889",
"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-29T03:49:04.6221317+00:00"
},
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "477a058e-812f-4b2d-9442-623da2a17ff0",
"date_reported_by_company": "2025-12-29T03:49:04.6221317+00:00",
"id2": 36,
"company_id": "f5811ad3-e12c-408b-9376-c50468b8dbc6",
"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": "9ef1d2ac-fb66-4439-ab15-d02484e6e88d",
"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-29T03:49:04.6221317+00:00"
},
"work_instruction_details_id": "eb40e944-1253-4c6e-888b-bf1538c437b5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "86119d5b-7292-4b60-b268-0422654c8b5c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c44ae310-a586-4232-9c86-c0451b59fffc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-29T03:49:04.6221317+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": "b68920f5-c0ee-4627-a20b-834618d9fa8a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-29T03:49:04.6221317+00:00"
}