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": "0665549c-1243-472c-a45e-ff50bafbe239",
"jobs_id": "3055c7fa-8022-4bdc-b998-feb50bb38ab0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c48346c6-c59a-42fd-825f-cad9644b02e4",
"_parent_id": "091ec137-de15-4fa3-911b-193e5f636a29",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8a303165-7d16-4031-84c6-ead380900dad",
"project_reference_back_office": "sample string 5",
"project": {
"id": "446b70ec-3fa9-464d-a32a-6a537d1718c3",
"_parent_id": "ce61077e-25df-49c6-8f1a-d0bd7878d239",
"root_parent_id": "8e8ef487-1d22-41ee-9eab-69b92c8f1b75",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "87215d89-8775-4f13-b6bd-40c34c7f398f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e0113dd1-fc24-45c5-8e24-5b9a02ea4fd2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff211e1d-495a-445b-9777-d0518134a5bc",
"_parent_code": "sample string 6",
"sales_organization_id": "f53c75d9-2648-45dd-b246-50e7b2b02309",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+00:00"
},
"modified_dateutc": "2026-02-02T06:15:58.848772+00:00"
},
"equipment_model_id": "f4021e14-483a-4fb8-8dbf-1e62bce7a484",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8ce3d333-18cb-468c-b1c2-fae8e9ca1615",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f2d53d80-9b0f-4047-b057-ccc688f906d0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0d415828-b145-4f05-94ba-1e39e60d91d0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8d24d810-b0a5-46f0-8764-f7e4c4637379",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+00:00"
},
"modified_dateutc": "2026-02-02T06:15:58.8643966+00:00"
},
"equipment_family_id": "e2d4fdc1-0b83-4ff2-b30b-b2a079e49c49",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e0113dd1-fc24-45c5-8e24-5b9a02ea4fd2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff211e1d-495a-445b-9777-d0518134a5bc",
"_parent_code": "sample string 6",
"sales_organization_id": "f53c75d9-2648-45dd-b246-50e7b2b02309",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+00:00"
},
"modified_dateutc": "2026-02-02T06:15:58.848772+00:00"
},
"date_in_production_since": "2026-02-02T06:15:58.8643966+00:00",
"date_out_of_production_since": "2026-02-02T06:15:58.8643966+00:00",
"date_end_support": "2026-02-02T06:15:58.8643966+00:00",
"sales_organization_id": "447fc0f3-29c2-4998-8d19-99464c6b1459",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+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-02-02T06:15:58.8643966+00:00"
},
"project_status_id": "003070db-bbf3-456d-a934-c75bf485a1a1",
"project_status_code": "sample string 10",
"project_status": {
"id": "86c2d19d-6dbd-4625-aaff-df5b07c7c45b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6153ad7a-b660-4f76-adac-72a90628f48c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-02T06:15:58.8643966+00:00"
},
"company_id": "646f71fd-0ae7-48d9-8162-8e2977837de3",
"company_code": "sample string 12",
"db_address_id": "bf6f1171-fd5e-4655-8fcc-f57b4ccc0715",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1d93351b-be06-4bcf-938f-90bf4150fff9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d08edcbb-c5c4-4dd6-881d-26880d20f613",
"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-02-02T06:15:58.8643966+00:00",
"date_create": "2026-02-02T06:15:58.8643966+00:00",
"date_update": "2026-02-02T06:15:58.8643966+00:00",
"updated_by_user_id": "6bf29e6f-3226-4a1a-bbee-9c657a1250b9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-02T06:15:58.8643966+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-02-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-02T06:15:58.8643966+00:00",
"date_last_job": "2026-02-02T06:15:58.8643966+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-02T06:15:58.8643966+00:00",
"modified_dateutc": "2026-02-02T06:15:58.8643966+00:00",
"is_mobile_installation": true
},
"job_type_id": "967f5299-8070-41b7-8b3d-081525fa2e16",
"job_type_code": "sample string 7",
"job_type": {
"id": "2d45f5df-d608-49fb-bbf4-cf26b62f72ba",
"name": "sample string 2",
"sales_organization_id": "128f441f-3979-4f80-a33b-7793594e33d4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-02T06:15:58.8643966+00:00",
"code": "sample string 7"
},
"job_priority_id": "d30b3504-33f4-4348-9dab-81b1aeaf8e38",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8389dd24-8d34-45fe-ad07-81f18bb8c89b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1c9a8daf-6756-4b31-a326-e0ba3f4b3a18",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-02T06:15:58.8643966+00:00"
},
"job_status_id": "e1038e2b-9858-4486-a7fb-efa59a0839ba",
"job_status_code": "sample string 11",
"db_address_id": "75c8791a-3215-4420-86ec-44ea32f5eabf",
"contact_id": "10c03d63-3636-4e47-ba92-89ccd6ad034c",
"requested_by_company_id": "1b529aec-e2ec-4fe1-a82a-03cbe0ffc3cd",
"requested_by_contact_id": "ac2221bf-2d63-4a4e-83e2-7180b80ac028",
"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-02-02T06:15:58.8643966+00:00",
"due_date": "2026-02-02T06:15:58.8643966+00:00",
"date_create": "2026-02-02T06:15:58.8643966+00:00",
"date_update": "2026-02-02T06:15:58.8643966+00:00",
"date_closed": "2026-02-02T06:15:58.8643966+00:00",
"suggested_user_id": "b7611715-ecac-431f-9bb3-e414b793725b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f5bdb657-89b7-4080-8221-98c83e914188",
"db_language_id": "a5ac0df6-81c2-4366-a152-0edae58ed08a",
"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-02-02T06:15:58.8643966+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cd75dad1-cb20-46ea-9c1d-2bd7bcb07919",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6c4e5391-ff05-4fc9-9b81-2af628fa8acd",
"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": "fc1369dc-9778-4fd1-906f-61f1e4728ed6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-02T06:15:58.8643966+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b4a73e04-edbc-4f4a-a2dc-dfb9a6062556"
},
"suggested_date_start": "2026-02-02T06:15:58.8643966+00:00",
"skill_id": "ebe44ec4-7b27-41d9-87d3-01b3e34f3216",
"skill_code": "sample string 32",
"skill": {
"id": "2cfa23b5-a551-49fc-9ed2-952c22b424bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2f41a243-bb77-4869-95e1-f9d7e59d0212",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3746a9bf-667c-49e5-96d9-eff9678977ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a93a037d-f27d-4fc8-a5d6-53115d5bc40e",
"db_currency_id": "6f78aa34-2696-4d4f-a6f2-783f06c3e10c",
"db_language_id": "5a71c24e-b0cc-4138-a5c1-b83edeafee90",
"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-02-02T06:15:58.848772+00:00"
},
"modified_dateutc": "2026-02-02T06:15:58.8643966+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3900bea3-b538-4dde-9577-5dff2766887b",
"date_reported_by_company": "2026-02-02T06:15:58.8643966+00:00",
"id2": 36,
"company_id": "a3101468-3213-49a3-b5a4-09622ac427c6",
"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": "af3a0251-5c76-4f44-9b7b-4d73a4a55ea0",
"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-02-02T06:15:58.8643966+00:00"
},
"work_instruction_details_id": "09b0463a-c8bc-424b-a0e3-5f10700e3e68",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "920ba98e-8ce7-4d0f-8055-fed7ff1a66a0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "27cdde52-3f64-4bc3-8c5f-23ac1ad3ab24",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-02T06:15:58.8800205+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": "05fe49ca-0ed2-4020-b266-802503e05929",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-02T06:15:58.8800205+00:00"
}