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": "9178c458-76ee-41d1-a57a-1abc98697b31",
"jobs_id": "6467198f-075c-4d44-89e3-b7dd0af6f56f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "335215eb-609a-4274-8fad-2a391607f739",
"_parent_id": "125169d1-7b40-4490-a508-3002746c3b07",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "badb8976-1b97-4faa-bc5b-070877d4d449",
"project_reference_back_office": "sample string 5",
"project": {
"id": "235b246c-f0bd-47e1-a756-80b321715a72",
"_parent_id": "3a9e7b2c-e237-4049-bcc8-47c0bd5f3b95",
"root_parent_id": "438afb69-0068-49a3-a5c9-ecf0f914e8c0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "25a2585d-2478-4bba-9b39-798950f9f0d1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a44d060f-d8ca-491e-9f4c-92f2656fe13d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "099a4f3d-7051-4761-8b11-604558fc52c7",
"_parent_code": "sample string 6",
"sales_organization_id": "2f6a0efd-3943-4c94-aaa8-fb2309ba9b94",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+00:00"
},
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00"
},
"equipment_model_id": "7aa67596-2792-45c1-87c5-7e86abbbd357",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a1cf8817-a62e-4a30-b7b4-9c77e1549950",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "20dc997a-3ce9-4e43-8bba-44d532219a53",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3c3fc6bb-66b3-44a1-bb2c-e9c84bb412b9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd0126af-2451-4dc3-bc4e-983e07f4a5ca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+00:00"
},
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00"
},
"equipment_family_id": "75e91270-c116-4f87-9f3d-5661e34cccc9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a44d060f-d8ca-491e-9f4c-92f2656fe13d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "099a4f3d-7051-4761-8b11-604558fc52c7",
"_parent_code": "sample string 6",
"sales_organization_id": "2f6a0efd-3943-4c94-aaa8-fb2309ba9b94",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+00:00"
},
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00"
},
"date_in_production_since": "2026-01-19T14:46:20.0227692+00:00",
"date_out_of_production_since": "2026-01-19T14:46:20.0227692+00:00",
"date_end_support": "2026-01-19T14:46:20.0227692+00:00",
"sales_organization_id": "1a76060c-7bf1-435d-a6fc-eb3b6de434ba",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+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-01-19T14:46:20.0227692+00:00"
},
"project_status_id": "2c267539-d036-4fff-88ae-9cf47793c59d",
"project_status_code": "sample string 10",
"project_status": {
"id": "69b4b21f-a6d6-4d4b-bc31-3594a046e3ec",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c2608018-b6b2-4a19-8ba5-e5a8462494ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00"
},
"company_id": "b919d838-d5c5-464e-bddd-be34ec0c5659",
"company_code": "sample string 12",
"db_address_id": "2af9b928-765e-43eb-a5cb-894d6734286d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c72145f4-6bc7-4bd5-a3e2-473b5635e28d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "173d6bf5-8355-4f9e-a9e2-77d54234db08",
"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-01-19T14:46:20.0227692+00:00",
"date_create": "2026-01-19T14:46:20.0227692+00:00",
"date_update": "2026-01-19T14:46:20.0227692+00:00",
"updated_by_user_id": "640e70c6-91fd-4ba3-a4ee-001524af9792",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-19T14:46:20.0227692+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-01-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-19T14:46:20.0227692+00:00",
"date_last_job": "2026-01-19T14:46:20.0227692+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-19T14:46:20.0227692+00:00",
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00",
"is_mobile_installation": true
},
"job_type_id": "ec536571-de7c-4069-a5a5-c1692a46fac0",
"job_type_code": "sample string 7",
"job_type": {
"id": "7b40426a-82f9-4f1c-8440-cdfd9646b965",
"name": "sample string 2",
"sales_organization_id": "9d34f15f-21f1-4c20-96c0-ed5bb250bfd3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00",
"code": "sample string 7"
},
"job_priority_id": "651fe7bd-a6af-4961-a900-9e535bca3513",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "48f1d6f5-02e0-4759-a160-45715f182e9d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3f064e5f-0e51-4f10-a434-f25ab3fefc64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00"
},
"job_status_id": "e945e4e5-7745-4dad-b2ba-d767f0d1bfd1",
"job_status_code": "sample string 11",
"db_address_id": "e3cfbd4d-f778-44c6-8487-786c3ea8d47c",
"contact_id": "0e633b8b-497d-48d1-bfd7-426ce2b45e7e",
"requested_by_company_id": "5765c4f7-59f3-467b-8370-5c570c1f03eb",
"requested_by_contact_id": "3d9228c9-4d8e-4ec1-990a-52d77e906845",
"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-01-19T14:46:20.0227692+00:00",
"due_date": "2026-01-19T14:46:20.0227692+00:00",
"date_create": "2026-01-19T14:46:20.0227692+00:00",
"date_update": "2026-01-19T14:46:20.0227692+00:00",
"date_closed": "2026-01-19T14:46:20.0227692+00:00",
"suggested_user_id": "7fe68a30-aaa4-4d39-ab17-44074466b6c2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8fe2cfa1-c35e-4db0-8fcc-d4a4f175da10",
"db_language_id": "b26aec5a-cdca-461a-920d-18470edd138b",
"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-01-19T14:46:20.0227692+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5a4b3631-b825-4cfc-a036-9929708cc302",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d9f1eba2-f5ba-4e66-8471-19bbe25a4ca4",
"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": "66b4cfb3-49e3-4851-804b-5d75328a9443",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-19T14:46:20.0227692+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2eda2e63-f445-4bd1-af97-048ebfa57903"
},
"suggested_date_start": "2026-01-19T14:46:20.0227692+00:00",
"skill_id": "e26dfefd-fc1c-490b-8a0b-731d29b3e5c9",
"skill_code": "sample string 32",
"skill": {
"id": "97209cf3-b014-4bf4-bea3-2ebb0689580f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c68b5c49-5689-40de-89d7-7da28ea2dd11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4e8eff83-e8ef-41bd-ae14-82dc85c104d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c47663e7-22a1-4eb7-969f-7b61e7a1e6f4",
"db_currency_id": "52871173-2fa3-4e8c-8a52-1fc0834321b0",
"db_language_id": "fb81a9da-02f2-4382-92db-4c28ffaf3b31",
"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-01-19T14:46:20.0227692+00:00"
},
"modified_dateutc": "2026-01-19T14:46:20.0383957+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bd1ad04a-7f11-421a-8b4f-e18b8eed0672",
"date_reported_by_company": "2026-01-19T14:46:20.0383957+00:00",
"id2": 36,
"company_id": "8dcbe59f-692a-49ee-87f3-222ba203146e",
"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": "cb99985c-117d-480f-89e9-25cf08f0791d",
"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-01-19T14:46:20.0383957+00:00"
},
"work_instruction_details_id": "422bf317-c7e9-4674-a030-dfbc42931090",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f0a329d5-dc3d-4545-b5d6-2b173fec69b2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "64cebb49-32cf-4aa5-a189-e74cd860c362",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-19T14:46:20.0383957+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": "fa945298-6824-420c-a64b-b390427de2b2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-19T14:46:20.0383957+00:00"
}