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": "15cc0392-5c16-4ea8-98bb-717dd3f9e970",
"jobs_id": "539ffadb-9561-43bc-a0c9-0ceef15e2d8d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "814b2b5f-5ab9-4c4d-a5b6-5836a3cb2d79",
"_parent_id": "37ec6782-1a4c-4ad7-883c-1f2ff52e8386",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7c9b6e71-dee9-48cf-98e3-423662d47d64",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e8583672-d514-4681-b9a8-a952fd434d36",
"_parent_id": "ec48ed90-200c-4907-b71e-4484c7005e1d",
"root_parent_id": "766067f1-dc52-40e7-aa81-143dfb9f142d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a3a9f8e4-77e4-4f99-b8d3-46e1557a795f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5033117b-ef16-4429-b1e3-6fc423163717",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "96e1cb84-d0a1-43c0-bef0-a2da2ff9554a",
"_parent_code": "sample string 6",
"sales_organization_id": "6245fbcf-9d2a-43ac-9ed2-eb6538fe7515",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+00:00"
},
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00"
},
"equipment_model_id": "d2a37c3d-b200-48b5-97b5-0d2376778c6e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7e84e05d-2401-487a-a60c-13d702f9ed36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c43e772d-2ef4-443e-b9e7-a2766d805a26",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b9c9082a-2f6e-4677-9f7b-d110e5cc4b6f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f74ff8cf-1c3b-4d8a-82d4-c47452a597de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+00:00"
},
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00"
},
"equipment_family_id": "c6831f9c-9a17-44ce-a4e9-682da1f3f631",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5033117b-ef16-4429-b1e3-6fc423163717",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "96e1cb84-d0a1-43c0-bef0-a2da2ff9554a",
"_parent_code": "sample string 6",
"sales_organization_id": "6245fbcf-9d2a-43ac-9ed2-eb6538fe7515",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+00:00"
},
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00"
},
"date_in_production_since": "2026-08-08T16:04:33.0698712+00:00",
"date_out_of_production_since": "2026-08-08T16:04:33.0698712+00:00",
"date_end_support": "2026-08-08T16:04:33.0698712+00:00",
"sales_organization_id": "06061d6d-f103-41f5-a350-2ee0d6970f6d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+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-08-08T16:04:33.0698712+00:00"
},
"project_status_id": "97f31b9a-0e31-47cd-b9a5-4c92cc30851f",
"project_status_code": "sample string 10",
"project_status": {
"id": "f2cad43f-1440-4f02-ac20-477f97a3422f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fbe55d79-eff2-4468-9e99-effdf86613c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00"
},
"company_id": "1393cd13-edd8-4a8a-8c94-3628fc5eb1bb",
"company_code": "sample string 12",
"db_address_id": "5e8f28bb-88d3-4a75-a91a-343c971b6ebe",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "75bdcf0d-116c-403b-8208-0241db9e70c0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "35e70f8d-5829-4383-bcc1-4bb92404c118",
"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-08-08T16:04:33.0698712+00:00",
"date_create": "2026-08-08T16:04:33.0698712+00:00",
"date_update": "2026-08-08T16:04:33.0698712+00:00",
"updated_by_user_id": "a3055808-cb12-4fc2-8299-511ed3292ede",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-08T16:04:33.0698712+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-08-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-08T16:04:33.0698712+00:00",
"date_last_job": "2026-08-08T16:04:33.0698712+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-08T16:04:33.0698712+00:00",
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00",
"is_mobile_installation": true
},
"job_type_id": "299816ae-97ad-4147-b47d-1afdc32f07cd",
"job_type_code": "sample string 7",
"job_type": {
"id": "3a42b7e0-1003-4b00-b0fa-b5d8d209e4ed",
"name": "sample string 2",
"sales_organization_id": "2b663696-dab9-446a-a3b9-b661cd8f33ad",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00",
"code": "sample string 7"
},
"job_priority_id": "d7442d32-56ad-4184-a261-54ee32b1d402",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "77a70f82-c34c-4b6f-b726-eed151d01ad0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "eb50a0c7-3aa6-4022-bc29-1e99be28c7cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00"
},
"job_status_id": "e7bfb954-4759-4784-a0fa-fed3835d69f2",
"job_status_code": "sample string 11",
"db_address_id": "06965fb4-b50b-4568-aee4-e3ccb3842fac",
"contact_id": "a977b6a4-9acd-4c71-9c13-66a91f13c10b",
"requested_by_company_id": "495d8a4a-4427-4663-83af-df9cd4b58ae5",
"requested_by_contact_id": "54dd6575-1600-4615-873e-42ee19bcf28f",
"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-08-08T16:04:33.0698712+00:00",
"due_date": "2026-08-08T16:04:33.0698712+00:00",
"date_create": "2026-08-08T16:04:33.0698712+00:00",
"date_update": "2026-08-08T16:04:33.0698712+00:00",
"date_closed": "2026-08-08T16:04:33.0698712+00:00",
"suggested_user_id": "ead5986b-bf49-4b47-8c9c-b203982823a2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f2203e36-5454-4be5-acb2-37ca4d08a710",
"db_language_id": "e60a3eb4-4122-4e65-9ebd-309bf52313cd",
"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-08-08T16:04:33.0698712+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "44416bb8-e166-4b69-8378-d41640829ee5",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8269bea4-39cd-46f9-afaf-311da6c82544",
"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": "8dbb62b4-fbc2-412e-adf4-a2f0d9974307",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "84bda3e1-b8ca-427f-af09-594314a482a3"
},
"suggested_date_start": "2026-08-08T16:04:33.0698712+00:00",
"skill_id": "b1a21e7c-6d76-44c5-9ef6-a31fc72b5531",
"skill_code": "sample string 32",
"skill": {
"id": "d5467a5c-23d3-48fd-a363-8bf689f86537",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2e8c34e7-5fe1-44a5-9099-b31bce62109f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be60ae07-5264-4f85-9a66-41af81845037",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1c2ec6-93f2-4d04-97ed-15e4898eb131",
"db_currency_id": "a9faeb8f-d6f7-4f39-866e-0d50256aeace",
"db_language_id": "c4633570-d3c0-4705-bacf-32a3a6b4a00e",
"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-08-08T16:04:33.0698712+00:00"
},
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0a148e3b-044c-4ab4-b417-d98d95265364",
"date_reported_by_company": "2026-08-08T16:04:33.0698712+00:00",
"id2": 36,
"company_id": "a2fef989-6a1b-4118-ac96-94a1bc4d3669",
"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": "9b590a06-d708-425d-bd57-ddbdc9879d3c",
"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-08-08T16:04:33.0698712+00:00"
},
"work_instruction_details_id": "c8a8afc7-3e6c-4e3b-91ad-0725506c2554",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c6406d3e-c81f-45d9-bef4-15cdd4991970",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9ae8d179-b143-49b9-a370-76aef1539c63",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-08T16:04:33.0698712+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": "2e4d515c-3efa-4a6a-8899-fd76b1ba84d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-08T16:04:33.0698712+00:00"
}