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": "148e8d3c-2207-471d-abe4-ee183c7ddd1b",
"jobs_id": "fd567570-0bbd-4bcf-b00f-48b68ad1d59a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "db1cdf56-2599-4514-aa61-73558325e723",
"_parent_id": "88020a39-4814-4a34-899b-82e21a14fc1c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d4c6b37c-6e6b-4cde-afa9-45d55c3b13e0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "88f6a8e0-a94d-4ac6-8d20-b27953ea13b5",
"_parent_id": "96d5af0f-b2b9-40c2-8830-43395df1d322",
"root_parent_id": "ee7ebc77-79e3-4180-b20b-b2c3fbd451d4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "84fbed75-2db9-43a2-979d-cbc67bc1005e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b5a388f3-a910-43fe-a36d-095819e6ea69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "170116e8-fb06-4e71-8092-bd7997b902c5",
"_parent_code": "sample string 6",
"sales_organization_id": "752bb24f-6c75-499f-9d06-17e3e94cb5b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+00:00"
},
"modified_dateutc": "2025-09-18T12:41:32.1608652+00:00"
},
"equipment_model_id": "33855cbc-9a5a-4372-b0b5-2f920e534135",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b4eb77b8-7f71-4c9b-b150-2af98131ab63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e446d092-21bf-4be3-8c90-ab5a69a89411",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f502bcbd-9f24-4b10-8092-1019fcb2ee78",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c04d6ce8-630d-4bd6-8f27-046474185ac5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+00:00"
},
"modified_dateutc": "2025-09-18T12:41:32.1608652+00:00"
},
"equipment_family_id": "e456c4ae-3420-4036-9bb9-97787768c622",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b5a388f3-a910-43fe-a36d-095819e6ea69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "170116e8-fb06-4e71-8092-bd7997b902c5",
"_parent_code": "sample string 6",
"sales_organization_id": "752bb24f-6c75-499f-9d06-17e3e94cb5b2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+00:00"
},
"modified_dateutc": "2025-09-18T12:41:32.1608652+00:00"
},
"date_in_production_since": "2025-09-18T12:41:32.1608652+00:00",
"date_out_of_production_since": "2025-09-18T12:41:32.1608652+00:00",
"date_end_support": "2025-09-18T12:41:32.1608652+00:00",
"sales_organization_id": "2fe506eb-23a0-4297-87b5-b0350c7c4ed2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+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": "2025-09-18T12:41:32.1608652+00:00"
},
"project_status_id": "9430ef48-3696-4266-b638-be125b3498e9",
"project_status_code": "sample string 10",
"project_status": {
"id": "7b0973c0-3322-4062-a2e6-6ef4f59319bc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2bb2c383-3e02-4ff0-bac0-e2f1d6c91685",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-18T12:41:32.1608652+00:00"
},
"company_id": "4f7607d1-35b1-45bf-894c-88e3c18cf3a0",
"company_code": "sample string 12",
"db_address_id": "67414e0c-5654-4fbd-bcdd-42dd28079923",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "20183b8d-0c6d-4077-93be-cd8023e129da",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1a4c985f-df0b-4935-860c-fad5ba621bbe",
"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": "2025-09-18T12:41:32.1608652+00:00",
"date_create": "2025-09-18T12:41:32.1608652+00:00",
"date_update": "2025-09-18T12:41:32.1608652+00:00",
"updated_by_user_id": "93d1a33a-24c4-4cf7-94b6-d2066c7393ec",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-18T12:41:32.1608652+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": "2025-09-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-18T12:41:32.1608652+00:00",
"date_last_job": "2025-09-18T12:41:32.1608652+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-18T12:41:32.1608652+00:00",
"modified_dateutc": "2025-09-18T12:41:32.1608652+00:00",
"is_mobile_installation": true
},
"job_type_id": "d01e0468-73d7-43b7-a8e8-47dacf7ce777",
"job_type_code": "sample string 7",
"job_type": {
"id": "ee19bb28-8a95-4705-b6bf-ea80b4cb04fc",
"name": "sample string 2",
"sales_organization_id": "26b08b51-8d83-4873-b6e6-8ccd394c9064",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-18T12:41:32.1608652+00:00",
"code": "sample string 7"
},
"job_priority_id": "9adc55ec-8eab-4bd1-b43b-e9ebd8dadc89",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d8b95898-3b5b-4483-9549-58ae647b2fb5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fa7b88e1-8ab9-4281-9206-ac78bca25f37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-18T12:41:32.1608652+00:00"
},
"job_status_id": "8a7a5844-970b-4b10-a979-8b944a724886",
"job_status_code": "sample string 11",
"db_address_id": "eb1dd0dd-b0df-4610-ab5e-583d88b5a6a9",
"contact_id": "3c130141-582a-4b85-96ae-5e9be258ac74",
"requested_by_company_id": "972ae108-75b1-4a19-8d8a-592d557d5c6b",
"requested_by_contact_id": "cfa97ff1-14f2-4bc2-9c03-efd057900b14",
"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": "2025-09-18T12:41:32.1608652+00:00",
"due_date": "2025-09-18T12:41:32.1608652+00:00",
"date_create": "2025-09-18T12:41:32.1608652+00:00",
"date_update": "2025-09-18T12:41:32.1608652+00:00",
"date_closed": "2025-09-18T12:41:32.1608652+00:00",
"suggested_user_id": "2455475f-2ce7-446b-981e-6749222dee7b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "635eacbd-3439-4683-8740-80cbb0ea3fa5",
"db_language_id": "2a3b9b4a-1682-4f54-877a-065f72a144b1",
"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": "2025-09-18T12:41:32.1764943+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1e8599ef-6879-49bf-bca1-8c40dbc4ca06",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9fea4213-0235-4fb1-86fe-563188de3147",
"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": "81cbc568-c60f-418e-bc2b-d645f34ee80c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-18T12:41:32.1764943+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ae85b674-feab-412f-b46c-aa2a1da5b5d5"
},
"suggested_date_start": "2025-09-18T12:41:32.1764943+00:00",
"skill_id": "ab6b9d33-4477-4250-853e-de90f916c22d",
"skill_code": "sample string 32",
"skill": {
"id": "3861ca0f-91a9-45c8-84d4-6bb5e9c41b3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "718c8571-a83e-4c7f-90ec-b22b443df462",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b817c75-ca64-400c-961b-aab7e405708a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3af8604-21d3-4fc2-a071-8f6d28e0d4d2",
"db_currency_id": "677d72c1-04cf-4307-b388-b0dc0e7cb962",
"db_language_id": "128c75a1-05f9-4cba-ab79-c6bec14741b8",
"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": "2025-09-18T12:41:32.1608652+00:00"
},
"modified_dateutc": "2025-09-18T12:41:32.1764943+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "920227e7-5393-4e0b-9bf5-635fab1e0c2f",
"date_reported_by_company": "2025-09-18T12:41:32.1764943+00:00",
"id2": 36,
"company_id": "9dc586a5-b805-4a6f-8216-f726b4a2d6a4",
"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": "de502b2c-0efa-4e36-ac30-72dd3dbec6cf",
"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": "2025-09-18T12:41:32.1764943+00:00"
},
"work_instruction_details_id": "cc562d6a-b5b8-4758-b70c-90c78e01ed55",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b058b84d-47af-4b0b-9cdc-2b52478a8fab",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3e988f46-f2c5-4dfb-96e0-8d3b7d245aaf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-18T12:41:32.1764943+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": "c7a83c3d-8eeb-4f75-abdd-9a6eb91bc897",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-18T12:41:32.1764943+00:00"
}