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": "3d455f33-7ac2-4522-a341-ff0f2db45090",
"jobs_id": "765f1b64-825b-4235-9958-d63be61687e5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c3750c9c-2cc0-4fc2-9046-ccecb36d0f5a",
"_parent_id": "40d38e9f-5c13-4416-9377-0e7c388b47e3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7bfc3a11-56c4-4ea4-ba50-4b0cda60552c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5d572631-e53b-4e1e-be0d-c29b35803785",
"_parent_id": "46612a6a-a909-498d-8524-763d498a07e4",
"root_parent_id": "50281d51-3419-497b-8e7c-8d108eedfe57",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6067521e-c133-4671-bbc3-3a7fab57b6e4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3c95c82f-9111-46d0-9683-a19e4c678254",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "98a6cc9a-c460-44d1-a146-7b1c3c947437",
"_parent_code": "sample string 6",
"sales_organization_id": "d2f965f7-79b0-430d-946f-f33247da6e76",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+00:00"
},
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00"
},
"equipment_model_id": "9ee455fd-f4c0-452d-b539-80de74a5495f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1c4f0681-b1e1-4017-92c9-6f7d05a665d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "53653ffb-3f27-4e14-8b48-063bb27ea773",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4ba4e72d-262d-4f28-a950-0568b1e7aea9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "46cd3e65-98e5-471f-b348-fe83ce9ed3fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+00:00"
},
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00"
},
"equipment_family_id": "4e694c95-d6a8-4646-94ad-6229b49b5625",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3c95c82f-9111-46d0-9683-a19e4c678254",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "98a6cc9a-c460-44d1-a146-7b1c3c947437",
"_parent_code": "sample string 6",
"sales_organization_id": "d2f965f7-79b0-430d-946f-f33247da6e76",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+00:00"
},
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00"
},
"date_in_production_since": "2026-04-03T05:51:44.3624113+00:00",
"date_out_of_production_since": "2026-04-03T05:51:44.3624113+00:00",
"date_end_support": "2026-04-03T05:51:44.3624113+00:00",
"sales_organization_id": "9444fd74-4037-4337-a66e-a10f022f8fe9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+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-04-03T05:51:44.3624113+00:00"
},
"project_status_id": "9a581061-927b-4cf9-b894-5b6244abac15",
"project_status_code": "sample string 10",
"project_status": {
"id": "e2365f77-4aca-4e32-9671-5ff9dc4b7390",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "425d687a-6c7a-4f7b-bd4c-0ff511175705",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00"
},
"company_id": "5f7ee071-ef02-463a-b13f-a5a82bdf83d0",
"company_code": "sample string 12",
"db_address_id": "96c2c9de-b8f2-464d-a6b5-c2a4c548da8b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "527fba52-dc7b-4522-b1a3-518f2e6b69a4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eadd97a4-8945-49bf-9c5e-ae364fe91496",
"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-04-03T05:51:44.3624113+00:00",
"date_create": "2026-04-03T05:51:44.3624113+00:00",
"date_update": "2026-04-03T05:51:44.3624113+00:00",
"updated_by_user_id": "68bd14b9-a10d-4746-a392-ba7f675ff547",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-03T05:51:44.3624113+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-04-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-03T05:51:44.3624113+00:00",
"date_last_job": "2026-04-03T05:51:44.3624113+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-03T05:51:44.3624113+00:00",
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00",
"is_mobile_installation": true
},
"job_type_id": "7be61720-acda-4387-aa82-f95477247a23",
"job_type_code": "sample string 7",
"job_type": {
"id": "534730d1-abb9-4159-938d-9677b0ca6bef",
"name": "sample string 2",
"sales_organization_id": "b7bf7ee3-aa98-4255-a597-a4f77c866fce",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00",
"code": "sample string 7"
},
"job_priority_id": "0a8273f7-817c-42a1-913d-634333ce4525",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "92c7cbb3-004e-462d-b2d6-6cae7839c6f4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4744a8ec-d4b9-44c0-8265-cd501d7ae672",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00"
},
"job_status_id": "e7ceb6e5-c3d9-4c9a-8eb0-15fb8fff83e7",
"job_status_code": "sample string 11",
"db_address_id": "5cdebb89-2804-4f50-b12d-0c9ae4f2ca0b",
"contact_id": "f8da3777-726c-436c-8f3f-570dff0b7692",
"requested_by_company_id": "23d67608-5e67-4cb4-b45e-09632a57bd55",
"requested_by_contact_id": "c69d2df9-2b34-46e7-8cd4-4c014928fc7b",
"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-04-03T05:51:44.3624113+00:00",
"due_date": "2026-04-03T05:51:44.3624113+00:00",
"date_create": "2026-04-03T05:51:44.3624113+00:00",
"date_update": "2026-04-03T05:51:44.3624113+00:00",
"date_closed": "2026-04-03T05:51:44.3624113+00:00",
"suggested_user_id": "6af983e8-20a8-4729-a102-457058aa2d7a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3a3bbea2-5b62-4620-a787-714c78d59e49",
"db_language_id": "0352e608-757e-4204-8993-22783b2b57e3",
"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-04-03T05:51:44.3624113+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f43b25b0-b780-4eba-84c9-946414c695d6",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3b77827a-1240-4ebb-8b26-c2db128a55b7",
"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": "2fc266b3-d496-409a-9edb-f530182b2097",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4c39f9e1-606a-4898-a37a-4238e8e3e641"
},
"suggested_date_start": "2026-04-03T05:51:44.3624113+00:00",
"skill_id": "34159327-4b0c-45c4-8fb9-b74384464aee",
"skill_code": "sample string 32",
"skill": {
"id": "d0042d4b-4ede-4f06-9665-bb3f9d308940",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5983de42-13d9-4bd4-92cf-2bd330839366",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63751fca-6dc1-4b15-8ca3-b516814a8278",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a2d06a7-7d3e-4a05-9e70-de4e0a70b746",
"db_currency_id": "99d606ed-ae0c-4a6d-b6c8-8680da2457a8",
"db_language_id": "c707e431-ddc6-4d5a-947f-5054d9325597",
"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-04-03T05:51:44.3624113+00:00"
},
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d7bc7fce-c86d-4552-b967-a515907ecd21",
"date_reported_by_company": "2026-04-03T05:51:44.3624113+00:00",
"id2": 36,
"company_id": "26de4ce6-0489-4abf-a15a-78e2275b5f81",
"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": "9665ef2b-8b41-49ac-abb9-eca46bbf0d49",
"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-04-03T05:51:44.3624113+00:00"
},
"work_instruction_details_id": "cb9f4db6-fb4a-41db-8a5b-ec7fc1802c67",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "36e7660b-a8c7-4555-bce4-76b917c25c70",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cd5ba756-b4bd-4359-b6da-2223da016229",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-03T05:51:44.3624113+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": "43b302f7-b81d-40e7-afec-30e63595ebe3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-03T05:51:44.3624113+00:00"
}