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": "a3787c14-78d6-459a-8280-ae3fa4f9f987",
"jobs_id": "54e27254-48c6-4764-90cf-5d8fbd3b0d31",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "01818078-d11d-4460-b3fb-38415435b4f2",
"_parent_id": "4869b7d7-ad82-4c4b-a9e0-5357d130e35e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "95d605e6-9ea1-4c70-abf0-58c21492ea5f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6ea8752e-538e-4526-88b0-52499e478494",
"_parent_id": "8e19e1f5-94af-42ec-a772-edf6e0b160d5",
"root_parent_id": "3cb7d164-cc04-45da-a7bd-b120536247ec",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "da928372-de1b-4ced-9aa0-3700b5355664",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "361d08aa-6d6c-4404-99de-2c9b859fa52a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff317958-00f5-4c3e-a2dc-dda6c213fb31",
"_parent_code": "sample string 6",
"sales_organization_id": "23cfa031-db32-4081-b2c8-8b78bd627c1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+00:00"
},
"modified_dateutc": "2026-01-25T08:48:40.6221508+00:00"
},
"equipment_model_id": "98ff7838-d599-49de-a4c8-cd515a7342d6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "18574725-d151-4045-b1d3-6d755d2f4911",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "205b7b7a-7f85-4b6c-b391-5c0da6e5eb89",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6e13bcf7-82bb-4de3-8224-49728896e575",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "964713ee-30d7-4ecf-9f8b-1caf0b6ecee1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+00:00"
},
"modified_dateutc": "2026-01-25T08:48:40.6221508+00:00"
},
"equipment_family_id": "cc83b5b3-98f4-4dd2-ba88-7257a56774fb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "361d08aa-6d6c-4404-99de-2c9b859fa52a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff317958-00f5-4c3e-a2dc-dda6c213fb31",
"_parent_code": "sample string 6",
"sales_organization_id": "23cfa031-db32-4081-b2c8-8b78bd627c1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+00:00"
},
"modified_dateutc": "2026-01-25T08:48:40.6221508+00:00"
},
"date_in_production_since": "2026-01-25T08:48:40.6221508+00:00",
"date_out_of_production_since": "2026-01-25T08:48:40.6221508+00:00",
"date_end_support": "2026-01-25T08:48:40.6221508+00:00",
"sales_organization_id": "4fba0b52-ec24-4459-8672-b51bc76a6fae",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+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-01-25T08:48:40.6377905+00:00"
},
"project_status_id": "bf0ca74c-77a0-4a10-a990-f788d9e65bfb",
"project_status_code": "sample string 10",
"project_status": {
"id": "1fa2fb1f-9efe-417d-a161-3afd6360a08e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "42d74d18-e4f2-495a-9359-83b8bf73e322",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T08:48:40.6377905+00:00"
},
"company_id": "78803aaa-2d2f-4d52-9739-57024bc8800e",
"company_code": "sample string 12",
"db_address_id": "9221e201-d8c3-49f6-9fa2-f2ec248abb02",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "04da3ce9-84b2-49e0-90ec-ade347ce2045",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "93b081b9-8878-4255-bf5f-aaaafff3d6b7",
"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-01-25T08:48:40.6377905+00:00",
"date_create": "2026-01-25T08:48:40.6377905+00:00",
"date_update": "2026-01-25T08:48:40.6377905+00:00",
"updated_by_user_id": "6607f8ac-d85f-4650-b507-6c37a2206d92",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-25T08:48:40.6377905+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-01-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-25T08:48:40.6377905+00:00",
"date_last_job": "2026-01-25T08:48:40.6377905+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-25T08:48:40.6377905+00:00",
"modified_dateutc": "2026-01-25T08:48:40.6377905+00:00",
"is_mobile_installation": true
},
"job_type_id": "78490ce0-4024-43b4-a3b8-bf4bb8f7651d",
"job_type_code": "sample string 7",
"job_type": {
"id": "0b738c92-b7a6-4430-97d0-fbb8fa864b48",
"name": "sample string 2",
"sales_organization_id": "aa7d1704-fb3c-432e-ad92-201540c2c6ba",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-25T08:48:40.6377905+00:00",
"code": "sample string 7"
},
"job_priority_id": "dcd35d71-3045-46a6-a535-247e8df2f7a4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2ca9c955-6766-495a-b2a6-ff2bcb3bfece",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "90810d50-ebd0-4508-baeb-6b403f6550cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T08:48:40.6377905+00:00"
},
"job_status_id": "3a7e85d5-2004-47c6-956f-853a3fca9b2a",
"job_status_code": "sample string 11",
"db_address_id": "f5eac7bb-5acd-41c0-8fa2-45c51eb274bf",
"contact_id": "e1797db3-94d8-4436-973b-92bc13d56db3",
"requested_by_company_id": "7a427c78-6eab-481f-8ad8-f08bc3b5092a",
"requested_by_contact_id": "2b1c68b7-d941-42fb-b098-1f4eece2ac08",
"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-01-25T08:48:40.6377905+00:00",
"due_date": "2026-01-25T08:48:40.6377905+00:00",
"date_create": "2026-01-25T08:48:40.6377905+00:00",
"date_update": "2026-01-25T08:48:40.6377905+00:00",
"date_closed": "2026-01-25T08:48:40.6377905+00:00",
"suggested_user_id": "109b88a0-3672-44c0-bc79-0d037a364bfc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ec6541d4-98b8-4c31-8b92-13e9d71d5724",
"db_language_id": "925a5bd3-ba27-43b0-a6da-5e181609eaaa",
"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-01-25T08:48:40.6377905+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "215e3d67-b352-4f3a-968e-9e0a1834e942",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0992f476-f632-44a3-ae39-a26d2bbc90d0",
"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": "4aa1c1be-da92-4e06-8ceb-a7cb918d699e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-25T08:48:40.6377905+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "503f19b1-5610-463a-94fd-5c01cfd49ca5"
},
"suggested_date_start": "2026-01-25T08:48:40.6377905+00:00",
"skill_id": "397beb6d-bc38-46c6-a03b-7e1099dbd95d",
"skill_code": "sample string 32",
"skill": {
"id": "639615e9-e2e9-48c2-94e7-2891b4ce5e3c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "17139dee-7ff2-4105-9937-1c6a70757186",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae74da1d-a531-428d-8653-f3070dbf01dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "362d7624-085f-4138-8728-443a4c2b90ef",
"db_currency_id": "1bc944a2-9afc-48e5-a361-b1b5fa483442",
"db_language_id": "34b44392-130d-4773-b7e8-26fdfc914c19",
"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-01-25T08:48:40.6221508+00:00"
},
"modified_dateutc": "2026-01-25T08:48:40.6377905+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cc278b56-bdcc-41cd-a3ae-8d062070da25",
"date_reported_by_company": "2026-01-25T08:48:40.6377905+00:00",
"id2": 36,
"company_id": "ac0a6aa5-06ad-42d5-98f0-a2cbf8509813",
"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": "f1fdfa64-34a3-4b37-bdd0-26e6dd26a582",
"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-01-25T08:48:40.6377905+00:00"
},
"work_instruction_details_id": "e629c3ce-051c-46c0-8314-f3c5a98f2d98",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "501875f8-3536-40a6-8eed-a708b43cf172",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8cd3a2f1-296d-46c9-83d4-2c5d3a54ee23",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-25T08:48:40.6377905+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": "20cc7cdb-34f3-4a06-a756-88f09e767db9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-25T08:48:40.6377905+00:00"
}