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": "6e25048d-53c7-49e7-abd9-7dfd843334fb",
"jobs_id": "d183af2e-44e9-4765-9ef7-8325aaa91d86",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e6b4be8f-6998-464c-9138-c5f668b20cea",
"_parent_id": "92017484-3eaf-4df0-977e-b830739dc37e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c23303ff-bbfb-4192-bf7d-463c67fd82cf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "63e83dc0-2e53-4233-966c-7dbf361fbc36",
"_parent_id": "f195b191-797c-4698-81f5-98a2d36eb703",
"root_parent_id": "4833488d-09f1-4d26-ae3e-aeb6097e49a7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c74fa0ff-adc5-4cf4-afe3-ca68abda3df4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9bf3b926-5f51-49dc-a4b5-8c8f835f5c26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d58c02d1-2dd7-46b0-9846-5b399873ad10",
"_parent_code": "sample string 6",
"sales_organization_id": "e269f45a-d620-4d08-966f-73222420f45b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+00:00"
},
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00"
},
"equipment_model_id": "7c305a05-df45-4319-b6fd-06fe410252f9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "137db5bb-d73a-48d4-8b2e-8cb6400852cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b72b38fa-1d89-4c5c-8a04-368f1c936f20",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e2d924bb-7e0d-4103-9859-c60c008855cb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6f496b68-64bd-4978-bf0f-8892f25dcee9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+00:00"
},
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00"
},
"equipment_family_id": "463a0c6a-bccf-4049-bffc-0f1b136019e0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9bf3b926-5f51-49dc-a4b5-8c8f835f5c26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d58c02d1-2dd7-46b0-9846-5b399873ad10",
"_parent_code": "sample string 6",
"sales_organization_id": "e269f45a-d620-4d08-966f-73222420f45b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+00:00"
},
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00"
},
"date_in_production_since": "2026-07-11T14:15:24.3722956+00:00",
"date_out_of_production_since": "2026-07-11T14:15:24.3722956+00:00",
"date_end_support": "2026-07-11T14:15:24.3722956+00:00",
"sales_organization_id": "af25f850-9a05-477e-8af6-ce69fcee24d2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+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-11T14:15:24.3722956+00:00"
},
"project_status_id": "ed94331e-a2af-429d-af91-5c29f99da29a",
"project_status_code": "sample string 10",
"project_status": {
"id": "9979df4f-8926-44fe-8520-1e2bd627aad5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9147a189-3a06-422b-ae47-db88e5fae8b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00"
},
"company_id": "b8626484-f58e-4d1f-86b3-91794d444602",
"company_code": "sample string 12",
"db_address_id": "eaa013bf-b41f-41ab-93a5-1a2c358aaa82",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3a183a1b-6fc3-4f78-b517-da4036549bf9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "770db1dc-69ea-4bbc-9819-af18cf9501ff",
"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-11T14:15:24.3722956+00:00",
"date_create": "2026-07-11T14:15:24.3722956+00:00",
"date_update": "2026-07-11T14:15:24.3722956+00:00",
"updated_by_user_id": "a392fc77-0827-4b47-9a92-f2107cdb9fc2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T14:15:24.3722956+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T14:15:24.3722956+00:00",
"date_last_job": "2026-07-11T14:15:24.3722956+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T14:15:24.3722956+00:00",
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00",
"is_mobile_installation": true
},
"job_type_id": "c3675f64-7951-493b-bceb-70d7ac140b87",
"job_type_code": "sample string 7",
"job_type": {
"id": "7ddc309a-be45-47af-ab8b-c82ec5a06a3d",
"name": "sample string 2",
"sales_organization_id": "f5f4552e-fe8f-4785-b83c-33d7650c1c55",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00",
"code": "sample string 7"
},
"job_priority_id": "8c09f098-94b0-489e-83d0-eff3ba168911",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8bb65a6c-0d55-4f3f-be15-537b712357a4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e7189e66-583f-473c-9991-6e2574c5ae18",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00"
},
"job_status_id": "e70db385-4c2a-4638-80bb-1a9258b9e996",
"job_status_code": "sample string 11",
"db_address_id": "2b3e06e9-4be7-463c-92d3-b1d5b4cf28fd",
"contact_id": "2a6e7208-c5bc-4ede-ab80-9a0c2f5e50b3",
"requested_by_company_id": "954e3bf6-fac6-4ffa-8389-bc7bd38f836e",
"requested_by_contact_id": "e3d9281a-1ed0-4ddc-9221-358760781041",
"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-11T14:15:24.3722956+00:00",
"due_date": "2026-07-11T14:15:24.3722956+00:00",
"date_create": "2026-07-11T14:15:24.3722956+00:00",
"date_update": "2026-07-11T14:15:24.3722956+00:00",
"date_closed": "2026-07-11T14:15:24.3722956+00:00",
"suggested_user_id": "1c52d648-c752-4abe-be6f-e9bae5b54623",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "85577e8a-4380-4f58-8ff4-2eadcf115978",
"db_language_id": "ed4e5020-64b9-421f-8bb1-420af3945d47",
"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-11T14:15:24.3722956+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c877426f-f9e2-46a9-b171-b5b961363b02",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "19c2a3f7-32a3-489c-878e-cbbc4a595905",
"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": "62e6642b-5fcc-4463-b67b-81b38a3a8fd8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ffa696fa-7a8b-4bb3-9c0f-e53726fe3c73"
},
"suggested_date_start": "2026-07-11T14:15:24.3722956+00:00",
"skill_id": "2cab863b-0abe-4ff1-a07d-51a6b6796f4c",
"skill_code": "sample string 32",
"skill": {
"id": "03b5f33c-af60-43d4-b116-66241b270f08",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c99721a2-964b-4ac9-8047-39e128bbd460",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "584d18e5-4af2-44ea-894f-4de53f3e6fe5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93c6d445-c74a-4b3b-9512-4a53dd45e2fd",
"db_currency_id": "164e50f3-2d7c-477c-ac27-61f6761dd4e7",
"db_language_id": "65348859-f50c-4876-bf61-11bd81705386",
"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-11T14:15:24.3722956+00:00"
},
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aba662fe-1d64-4b47-97c0-17e6cea99975",
"date_reported_by_company": "2026-07-11T14:15:24.3722956+00:00",
"id2": 36,
"company_id": "0f50e9ed-f7f5-4359-b3a4-d3c093e9007c",
"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": "00124dc3-ce0a-420e-ac8d-d6ed20b89be2",
"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-11T14:15:24.3722956+00:00"
},
"work_instruction_details_id": "44edd054-3377-43fd-876e-84919caadc3c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "53a4385a-759f-4aa6-b8ac-9f3e658a8e50",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ae903d93-fb21-4d92-9e51-2ea08b547a78",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T14:15:24.3722956+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": "34b5cd87-2884-4f2b-a962-f0e65d951862",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T14:15:24.3722956+00:00"
}