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": "c84816ca-c909-4f40-9bbc-c5d8fcb7168a",
"jobs_id": "8438d7ab-3418-4074-a130-10911e5185ea",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c985071e-7032-4086-b90b-cb9c505677a6",
"_parent_id": "11941d05-8a24-403f-b2d4-f6e898d4a43f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d31b135c-5257-4bf4-839f-1f0bc4833a39",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5c8b9c0d-129e-46b4-912c-18cd854ab91b",
"_parent_id": "0af49790-be60-4826-89f1-f0bc1d942db6",
"root_parent_id": "dbccc2e7-2643-4863-82a0-9d9a633cfb70",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c68057ab-6fd2-4447-bdd4-5769139ecddc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ba317e4f-a715-4a12-bb10-3d03d8f4cd72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7448579f-b42c-486d-b391-7b68da2f7062",
"_parent_code": "sample string 6",
"sales_organization_id": "ff608459-b1a8-4555-aec6-8a6a33767c75",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+00:00"
},
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00"
},
"equipment_model_id": "12d95fdd-06ed-4228-815b-0122fabde1a0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1b4973fd-7e3f-4fdf-8e5d-c747fcc56db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5d0afa62-ead9-4b59-8f9a-2185fd8a4bd9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "44c4909b-4d47-4c62-8f81-8a2c7b680b7e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e4f470db-887f-4638-bb66-ed4b77ae8fe9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+00:00"
},
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00"
},
"equipment_family_id": "b92399e8-d212-4b69-9de8-2c1773f7e2bd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ba317e4f-a715-4a12-bb10-3d03d8f4cd72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7448579f-b42c-486d-b391-7b68da2f7062",
"_parent_code": "sample string 6",
"sales_organization_id": "ff608459-b1a8-4555-aec6-8a6a33767c75",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+00:00"
},
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00"
},
"date_in_production_since": "2026-04-09T03:12:17.4855544+00:00",
"date_out_of_production_since": "2026-04-09T03:12:17.4855544+00:00",
"date_end_support": "2026-04-09T03:12:17.4855544+00:00",
"sales_organization_id": "f6d2f0e2-02b9-4803-b68a-393dc6786bfc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+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-09T03:12:17.4855544+00:00"
},
"project_status_id": "74c545b3-fe16-4bd9-b0b4-d86db20183fa",
"project_status_code": "sample string 10",
"project_status": {
"id": "63279eb2-a1b3-4ccc-8ebd-9e504c414479",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b3ca9584-3834-44a6-8712-a915c14dd8fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00"
},
"company_id": "2c679827-7554-488e-9c2f-33169563d491",
"company_code": "sample string 12",
"db_address_id": "8ebda3ea-aa4c-447d-b438-1350b233c9a4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4341508d-5b7b-4c59-8a88-6d4b832d21aa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e356578d-d254-4248-ab85-9756d8077010",
"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-09T03:12:17.4855544+00:00",
"date_create": "2026-04-09T03:12:17.4855544+00:00",
"date_update": "2026-04-09T03:12:17.4855544+00:00",
"updated_by_user_id": "7c8303b5-c254-42dc-bafc-a561ed8eec5f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-09T03:12:17.4855544+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-09T03:12:17.4855544+00:00",
"date_last_job": "2026-04-09T03:12:17.4855544+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-09T03:12:17.4855544+00:00",
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00",
"is_mobile_installation": true
},
"job_type_id": "99b9f62a-4723-4a33-bbfa-5d13c0f8e04b",
"job_type_code": "sample string 7",
"job_type": {
"id": "a0c1420b-10ba-449f-aa28-9262878d9a1f",
"name": "sample string 2",
"sales_organization_id": "12725493-2a26-4b82-a27d-1cdcd6401ad2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00",
"code": "sample string 7"
},
"job_priority_id": "978599cc-829e-4777-838f-5603a83790ce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b286110a-1505-43cb-9580-280010d1183e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d3a629f7-136a-44e8-a353-8f16cd9bb781",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00"
},
"job_status_id": "c3b05b8e-9dc6-40ae-95e2-51a687fce568",
"job_status_code": "sample string 11",
"db_address_id": "0bba0b3e-e074-4322-971d-524edc35dafb",
"contact_id": "11ffe719-f31a-4b90-9356-acc831e1b27c",
"requested_by_company_id": "1d2a23c3-f9b2-4d9c-9490-49d903af9760",
"requested_by_contact_id": "199bf527-b7a5-4fad-9e12-b40f17c1bd12",
"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-09T03:12:17.4855544+00:00",
"due_date": "2026-04-09T03:12:17.4855544+00:00",
"date_create": "2026-04-09T03:12:17.4855544+00:00",
"date_update": "2026-04-09T03:12:17.4855544+00:00",
"date_closed": "2026-04-09T03:12:17.4855544+00:00",
"suggested_user_id": "e6cc93be-cc87-4282-98b2-79cab7e987e4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6410f6cf-2742-46f3-96d4-527345c66e58",
"db_language_id": "70f6b45b-c768-41c6-bb2b-4d632e58db70",
"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-09T03:12:17.4855544+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2ebc3eb9-b354-4d39-ab3d-9942e062a561",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cd3a8748-fe8a-4e93-9dd2-f5b6e26863b6",
"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": "4e0a78aa-fccf-492b-bb51-92c31a3aa6c7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2f639fa3-35a3-4607-923e-09d3a0e788e1"
},
"suggested_date_start": "2026-04-09T03:12:17.4855544+00:00",
"skill_id": "4e041652-6fdf-498d-9972-b5c9fd6628e2",
"skill_code": "sample string 32",
"skill": {
"id": "1d972727-faea-4ac6-a95b-af665d34c43d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0bba15c6-10a1-4339-b012-15016fddd592",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d316f5d3-487d-40d5-9cf9-f95a5db8ce15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78e14eec-b8b7-460b-821a-590273ae2dc2",
"db_currency_id": "d062c892-2491-483e-9144-720bf68dbc3d",
"db_language_id": "6a3637e3-c8a5-47ed-bd8e-1cdc00387574",
"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-09T03:12:17.4855544+00:00"
},
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0a0a79e4-ef1c-46e6-bb24-92b89f8b1573",
"date_reported_by_company": "2026-04-09T03:12:17.4855544+00:00",
"id2": 36,
"company_id": "44ec7bf7-f36f-48e0-865c-52d5b0c3b83f",
"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": "12c17a68-7d03-4b3e-ae22-483fd069e108",
"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-09T03:12:17.4855544+00:00"
},
"work_instruction_details_id": "344ac3e4-e3d2-4251-abd5-cd5a47d21620",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "59e1af71-79ce-4128-b51d-18652fafc2b2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b629d916-2b6e-4ed9-806c-45b6f3cb5c50",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-09T03:12:17.4855544+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": "6f79087c-bcec-48b2-90b5-c5969a0b345b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-09T03:12:17.4855544+00:00"
}