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": "7ec41603-0f1b-4997-8aac-e1ab2473348a",
"jobs_id": "f2f26fa4-cdf4-4a64-a413-e0d819e157ed",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d51da5a-ce30-4da7-bfea-a6cfa1a46d78",
"_parent_id": "117775ca-da86-4953-a965-9ace8cfab197",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ded9c1e7-b54d-476e-9090-7d0cccd28ca6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "658e3b9a-cfd2-4273-a91a-5b99d3893756",
"_parent_id": "7295390b-a108-4d36-aaf1-72bc536a2df7",
"root_parent_id": "8cc1276b-3e4b-4d55-889d-53d9bb0cef24",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e4b9e8a7-b0bf-454d-90ef-79d6671b5f12",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ebc05fae-7c97-485c-9bd7-9843b8e46642",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cdefaf06-6094-49e3-ae90-ae8c0c09036c",
"_parent_code": "sample string 6",
"sales_organization_id": "9785792f-1227-475b-b87f-8e5a58b9ab46",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+00:00"
},
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00"
},
"equipment_model_id": "20cef7dc-0ca7-4b7d-9ebb-1b0108f6bfb5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ad1d6371-f650-46d0-8bb9-3b32453ad410",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f41f3821-0b74-4491-b0ea-2f37686a7662",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "34b023bb-8902-486a-af68-b21502f6c9c7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "607f174a-d8bc-4ad4-82af-69a9bdc3f2ed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+00:00"
},
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00"
},
"equipment_family_id": "f588e63a-0e51-4f9a-b4cb-9833f7495160",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ebc05fae-7c97-485c-9bd7-9843b8e46642",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cdefaf06-6094-49e3-ae90-ae8c0c09036c",
"_parent_code": "sample string 6",
"sales_organization_id": "9785792f-1227-475b-b87f-8e5a58b9ab46",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+00:00"
},
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00"
},
"date_in_production_since": "2026-07-22T00:41:18.888755+00:00",
"date_out_of_production_since": "2026-07-22T00:41:18.888755+00:00",
"date_end_support": "2026-07-22T00:41:18.888755+00:00",
"sales_organization_id": "91c95dbf-1d94-4532-a445-3567c2c3b19b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+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-07-22T00:41:18.888755+00:00"
},
"project_status_id": "cfe1a462-8c35-48f7-80c8-902547fd2ee0",
"project_status_code": "sample string 10",
"project_status": {
"id": "999caf04-0bfd-40fe-adbe-541b73205bcf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f357fbae-b646-4911-b9ca-cdd5a5e741aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00"
},
"company_id": "b3fe8018-d42c-4b7b-a294-799004461231",
"company_code": "sample string 12",
"db_address_id": "bf72b028-ee0d-4216-8e86-6ab539fdc684",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cc8cddb6-441e-4e93-bbe9-1fae97f1f055",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3b9fc7e4-98cd-4e3c-a015-be2ecff39aca",
"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-07-22T00:41:18.888755+00:00",
"date_create": "2026-07-22T00:41:18.888755+00:00",
"date_update": "2026-07-22T00:41:18.888755+00:00",
"updated_by_user_id": "037aebba-adc3-404e-8e70-006399851e81",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-22T00:41:18.888755+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-07-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-22T00:41:18.888755+00:00",
"date_last_job": "2026-07-22T00:41:18.888755+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-22T00:41:18.888755+00:00",
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00",
"is_mobile_installation": true
},
"job_type_id": "a6e4fc40-3b1a-4cd4-8a7c-96b45a3d605e",
"job_type_code": "sample string 7",
"job_type": {
"id": "691153ac-1648-41d1-bcc6-f9a39631a980",
"name": "sample string 2",
"sales_organization_id": "a879b6be-731a-4212-9072-da002ca54149",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00",
"code": "sample string 7"
},
"job_priority_id": "0500b5f0-f5f0-465e-ac87-d5360a266ed1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0fb41e9d-b6bb-4be7-b68c-32f0e39158a0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6f52be5d-062f-4947-89c2-5d1fc01bf2f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00"
},
"job_status_id": "63dd58a1-16f7-47a4-8e01-5c6612ff3b68",
"job_status_code": "sample string 11",
"db_address_id": "d220c46c-4dab-420d-82e3-e4d01bbe1f3d",
"contact_id": "6ab75530-f733-4e7e-a58b-97ba336f5faf",
"requested_by_company_id": "3a690a74-872f-4b68-979c-320d5684e327",
"requested_by_contact_id": "2c694e8e-915b-4505-991d-9d0cdf4e0cd3",
"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-07-22T00:41:18.888755+00:00",
"due_date": "2026-07-22T00:41:18.888755+00:00",
"date_create": "2026-07-22T00:41:18.888755+00:00",
"date_update": "2026-07-22T00:41:18.888755+00:00",
"date_closed": "2026-07-22T00:41:18.888755+00:00",
"suggested_user_id": "a787dbba-2655-4988-a97f-7eeb3393f65d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6ae4b3f5-1049-4425-aa25-3db36f64e4df",
"db_language_id": "9fe3bb3b-6d15-4198-b823-ed36f39ed4cb",
"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-07-22T00:41:18.888755+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "76ab25a1-e0e6-452c-88ea-cb3b0956e6d6",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4588b220-b0d4-412e-b65f-756e20ff43f6",
"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": "3c48688c-1486-4e73-b008-e7af708981a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0a60ea24-42d9-4894-aca2-e61443f96ed2"
},
"suggested_date_start": "2026-07-22T00:41:18.888755+00:00",
"skill_id": "55bc1137-9f61-47d1-93be-e421d07979f7",
"skill_code": "sample string 32",
"skill": {
"id": "b6ffb0dc-a9aa-4c3e-be0a-022ee3614d06",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "153e3c71-f829-4d75-9588-0b1394091f04",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "510967eb-84f1-423e-9c9b-b978632ccd8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71bae78f-91a4-4c0a-8fe2-8ffc637f98a8",
"db_currency_id": "9d015b56-54a9-4aba-92b9-d1af646bc7d0",
"db_language_id": "11c3ac74-0d1f-4467-8c75-f339845e1d5c",
"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-07-22T00:41:18.888755+00:00"
},
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "84893742-10e6-45d6-8bc8-efdb9ed7ac84",
"date_reported_by_company": "2026-07-22T00:41:18.888755+00:00",
"id2": 36,
"company_id": "51cba757-40b3-42ad-b6f5-ecad739ceb45",
"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": "fe0907bc-6bad-4bd0-b30c-44f7d6b28e69",
"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-07-22T00:41:18.888755+00:00"
},
"work_instruction_details_id": "b658a1b9-e57a-4469-9641-42e227dff078",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a509c1ee-e541-4f8d-b201-6e281e8925f9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4c497261-f1c1-4b20-ac60-2b6efb2239b4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-22T00:41:18.888755+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": "061cfd84-9a5a-46e9-9010-4c33b72026be",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-22T00:41:18.888755+00:00"
}