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": "d3462810-6fa4-427e-9809-faaf9d04da76",
"jobs_id": "dbcc4b70-0a45-4205-b865-49e6e4ae1f81",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e3b8dd32-5f91-4578-9c40-0c47a95f4dec",
"_parent_id": "f7be7c7b-88e4-4b24-be74-3aa25559e525",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a01f06d7-25cf-4859-9400-085bb907a9b0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "023d8618-c26b-4c59-a370-b8a0a09f4b1e",
"_parent_id": "6a5f11f9-ce30-4d0d-8790-11b17ccafd85",
"root_parent_id": "1b61ccbb-a3ea-49ce-92e3-af6af0f3a5b8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6adbd329-18d0-4bd1-b5a2-19f6f4c9f483",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9c242165-10ed-452e-872d-42b99ce3a428",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c3425496-dbde-478a-8fc8-60acb35e7990",
"_parent_code": "sample string 6",
"sales_organization_id": "1e287f06-1782-4b2d-8900-96f67821cf78",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+00:00"
},
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00"
},
"equipment_model_id": "e6d00c2a-fc98-4758-a9e3-6df9bfffcbcf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "71250d1b-a4f5-44b7-a836-e2b12cc2b504",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f358927d-347a-4ab7-9ea8-8226d4946389",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "34d0cd54-2cd4-44b4-bc9e-a6bbfe565fcc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5f0ccbc5-9536-4cea-9e61-0f5be4caf0ce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+00:00"
},
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00"
},
"equipment_family_id": "8e359b77-1c61-4d40-b0b6-25bda01c2ff3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9c242165-10ed-452e-872d-42b99ce3a428",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c3425496-dbde-478a-8fc8-60acb35e7990",
"_parent_code": "sample string 6",
"sales_organization_id": "1e287f06-1782-4b2d-8900-96f67821cf78",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+00:00"
},
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00"
},
"date_in_production_since": "2026-09-11T00:46:56.3192037+00:00",
"date_out_of_production_since": "2026-09-11T00:46:56.3192037+00:00",
"date_end_support": "2026-09-11T00:46:56.3192037+00:00",
"sales_organization_id": "40b0b2b5-4162-400c-8f16-c0d6129cf306",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+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-09-11T00:46:56.3192037+00:00"
},
"project_status_id": "647f745c-8e3a-4063-97da-213dcee4d1c2",
"project_status_code": "sample string 10",
"project_status": {
"id": "29d186d2-9905-446d-9d37-e93502df5e9c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fc1062c1-d025-4244-ac30-92dad0da23a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00"
},
"company_id": "3635a5c2-01c5-43cf-9aeb-2f5d196f8ea4",
"company_code": "sample string 12",
"db_address_id": "e5152013-46f0-424b-964d-a097173420d6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c60622f1-8f84-494c-a8c1-4aa7cc20a4e8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "961672e9-7c80-45b2-9ce3-8b0ef47c0fc7",
"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-09-11T00:46:56.3192037+00:00",
"date_create": "2026-09-11T00:46:56.3192037+00:00",
"date_update": "2026-09-11T00:46:56.3192037+00:00",
"updated_by_user_id": "14c4490f-8791-4a32-bf15-7d7d8b9aa024",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T00:46:56.3192037+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-09-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T00:46:56.3192037+00:00",
"date_last_job": "2026-09-11T00:46:56.3192037+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T00:46:56.3192037+00:00",
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00",
"is_mobile_installation": true
},
"job_type_id": "e5aed99c-5b78-41d2-9beb-54dfcd5b4489",
"job_type_code": "sample string 7",
"job_type": {
"id": "56abb2f7-ffd2-4e18-9be8-1b8953714fa3",
"name": "sample string 2",
"sales_organization_id": "86303661-207c-4c86-8d28-3bff0bfe8102",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00",
"code": "sample string 7"
},
"job_priority_id": "e13f8611-0f5a-4bf9-9aa1-a9314c6a7bf3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ae6dcc26-b0bd-4d7a-9efe-939973068224",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b630876b-2358-432c-bfe2-4233b528f233",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00"
},
"job_status_id": "6180bbff-0073-49a8-b49a-6d3ae1e263de",
"job_status_code": "sample string 11",
"db_address_id": "7c02dbbb-a486-4cbe-9fe0-3a52a9c37677",
"contact_id": "8a90903b-1098-4209-beab-de32338fe0d8",
"requested_by_company_id": "9d455720-4f97-4edd-9efa-1c502cf3bda5",
"requested_by_contact_id": "c72e4e80-c942-4ce5-b4c9-49c9736d47b3",
"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-09-11T00:46:56.3192037+00:00",
"due_date": "2026-09-11T00:46:56.3192037+00:00",
"date_create": "2026-09-11T00:46:56.3192037+00:00",
"date_update": "2026-09-11T00:46:56.3192037+00:00",
"date_closed": "2026-09-11T00:46:56.3192037+00:00",
"suggested_user_id": "e85a59ff-5316-4772-b466-b7f93d26cfe0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "06622baa-b2cf-4640-b388-255362f3aaa4",
"db_language_id": "dd422682-8c0d-45e9-bbcd-64f5bd6c4d8a",
"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-09-11T00:46:56.3192037+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a695b10c-cb77-454e-a291-d47e457abbca",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5c90749f-a525-41a7-a1d7-7b548cc6ec76",
"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": "63e80676-605a-4d00-be16-9f948d8a82ae",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5b30d54f-4c0e-45cd-95a3-8b902381b4cd"
},
"suggested_date_start": "2026-09-11T00:46:56.3192037+00:00",
"skill_id": "faa75036-148d-4fc8-921e-fcac5ba2251d",
"skill_code": "sample string 32",
"skill": {
"id": "ec9228da-6c82-4dca-af46-af01f831f84f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c55fa07f-26ad-41d6-9db2-da1853faf6c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a2f77fe-5574-4a8b-a69f-5e875577dec9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "575ff312-b170-4530-906c-4241d581cc33",
"db_currency_id": "addf9f78-c3b5-4d1c-bc87-6a6c7c20b620",
"db_language_id": "b5977dcb-6ce4-4be5-9125-d8c80749ba29",
"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-09-11T00:46:56.3192037+00:00"
},
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "63da828d-51f8-41d8-be71-672a3baa1cf1",
"date_reported_by_company": "2026-09-11T00:46:56.3192037+00:00",
"id2": 36,
"company_id": "48f0944e-9383-4c18-a342-ebc13c07f830",
"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": "e0faa7c2-9aee-4db0-a81e-bd46f8662cf8",
"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-09-11T00:46:56.3192037+00:00"
},
"work_instruction_details_id": "76c75828-4838-468c-b331-4c6ba906b0c3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b9e216c2-3244-464c-97dd-bbdcac210c99",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "023c404d-b313-4c53-a951-15dbda9988d2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T00:46:56.3192037+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": "11638a27-dd4e-46cf-b450-0ccb45be80a3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T00:46:56.3192037+00:00"
}