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": "e89165e3-dfcb-40b8-b09e-232b70f6779d",
"jobs_id": "71fe3b76-3a0d-430e-8d08-e175c23eb9ab",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c12707a-839f-4795-9e3d-bbd38c97284e",
"_parent_id": "8f1df66a-f926-4b4d-9c85-3ec1fb7d9c98",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3149024c-8238-493b-a273-97677444f99f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "83853256-6973-46ef-8050-736bed4cc243",
"_parent_id": "a69dec22-10db-4fc6-9cf6-27970e504a14",
"root_parent_id": "cb6e82fc-dae4-431d-9e3d-9aeaa5a5884d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3743dee9-9591-4e9f-bf05-a8231cb2e075",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a4bc97fa-8b73-461d-9331-4a2cf4823314",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a12b37d4-fa72-4446-9419-7e07fd7d6fd9",
"_parent_code": "sample string 6",
"sales_organization_id": "f554d3c6-64e6-4c24-95a7-309fe9625fa6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+00:00"
},
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00"
},
"equipment_model_id": "72fecd62-7eb8-4d11-b1a1-70f7b193481d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c84fa464-3113-4239-8578-e2312c2c6b68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "86f6bc2c-2eb3-44bd-b63e-bbcf414dfe63",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "00001e01-2902-4106-8a59-5a049160d487",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "338f96b0-7b62-47e1-b19c-b83866bf1594",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+00:00"
},
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00"
},
"equipment_family_id": "de30e5fb-346a-430f-8f86-285cc28e2ca3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a4bc97fa-8b73-461d-9331-4a2cf4823314",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a12b37d4-fa72-4446-9419-7e07fd7d6fd9",
"_parent_code": "sample string 6",
"sales_organization_id": "f554d3c6-64e6-4c24-95a7-309fe9625fa6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+00:00"
},
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00"
},
"date_in_production_since": "2026-01-30T06:12:28.2540251+00:00",
"date_out_of_production_since": "2026-01-30T06:12:28.2540251+00:00",
"date_end_support": "2026-01-30T06:12:28.2540251+00:00",
"sales_organization_id": "7ef1d9a2-9921-42c5-bd13-4156458b6b76",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+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-30T06:12:28.2540251+00:00"
},
"project_status_id": "c35e7374-8446-4b96-81a8-095774d349f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "a0b75e0c-f1d8-459b-ae50-023eb866e7f7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ab8945c4-85d0-4c61-ad27-507f9beb9b19",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00"
},
"company_id": "3616bef6-3211-46a7-839e-0f74fff1ee39",
"company_code": "sample string 12",
"db_address_id": "edb2a978-c9b3-4b77-88e8-17d6a9f5603d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7344758d-15df-4446-9326-0454b9ee411e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b33de976-1746-4fce-8f3e-1dfb7be56012",
"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-30T06:12:28.2540251+00:00",
"date_create": "2026-01-30T06:12:28.2540251+00:00",
"date_update": "2026-01-30T06:12:28.2540251+00:00",
"updated_by_user_id": "29c5913f-d2d6-497c-80fe-6efc01b21b50",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-30T06:12:28.2540251+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-30T06:12:28.2540251+00:00",
"date_last_job": "2026-01-30T06:12:28.2540251+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-30T06:12:28.2540251+00:00",
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00",
"is_mobile_installation": true
},
"job_type_id": "272f121c-f71d-49e2-af78-fcd9180e1f96",
"job_type_code": "sample string 7",
"job_type": {
"id": "5450d6d6-3279-4667-9d52-a39a81c599b2",
"name": "sample string 2",
"sales_organization_id": "7a2e3f2e-cb24-4295-8cbc-fcd398262252",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00",
"code": "sample string 7"
},
"job_priority_id": "b4360ec6-052d-43f7-ac02-4a083da7383e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "404889b4-f153-4234-9e4a-c067cc0e1244",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ae95d775-4b9c-45f5-9ba1-9d11c6a5b357",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00"
},
"job_status_id": "7f74ecbd-d4f7-4a8a-a498-226ffdc84741",
"job_status_code": "sample string 11",
"db_address_id": "c7aa4dfd-82db-410d-a5a1-dec214ed6706",
"contact_id": "10737e67-73c9-4187-ac49-135d804e2f34",
"requested_by_company_id": "a3bfc4df-fca5-44db-9995-59bccc4d842a",
"requested_by_contact_id": "ef9e98cb-30ad-4ff4-a382-3ccef3188a0b",
"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-30T06:12:28.2540251+00:00",
"due_date": "2026-01-30T06:12:28.2540251+00:00",
"date_create": "2026-01-30T06:12:28.2540251+00:00",
"date_update": "2026-01-30T06:12:28.2540251+00:00",
"date_closed": "2026-01-30T06:12:28.2540251+00:00",
"suggested_user_id": "0e198f96-40ab-4e35-83bf-d0fc52e08751",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6b8ddba3-6858-4c1a-9a93-e374d5947370",
"db_language_id": "bfd05e20-474d-414d-853a-4d370a003a53",
"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-30T06:12:28.2540251+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "575523ae-cf47-4ed7-83c4-aa096c86b55d",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "613de09c-419d-43ce-9f70-9772890b0c23",
"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": "5f38bbca-00c2-4320-a8e3-65f9c3664821",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "869fb6ee-e192-40fc-80ba-a3f92e265d4a"
},
"suggested_date_start": "2026-01-30T06:12:28.2540251+00:00",
"skill_id": "dcd7ca67-dc84-45bd-8325-86fdb571c6c8",
"skill_code": "sample string 32",
"skill": {
"id": "3015048d-4777-4638-8acb-e7d56520defb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f80195f3-6fb3-4409-9f30-a42db45bb377",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de4b136e-6580-41a6-b78b-b73e4f524d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3886c3c-e633-4a99-861d-8bb3a6a6569f",
"db_currency_id": "6e203577-db25-4d01-9dd2-7d96ec28c56d",
"db_language_id": "594412d1-6cca-4938-8e86-87094ce79377",
"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-30T06:12:28.2540251+00:00"
},
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "75174747-c94f-4579-8cee-791bebc15ab1",
"date_reported_by_company": "2026-01-30T06:12:28.2540251+00:00",
"id2": 36,
"company_id": "2e6bc140-e586-41ab-ae7d-192eafa541e6",
"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": "70616bf5-e6ff-4d19-b10c-38362fca9d4c",
"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-30T06:12:28.2540251+00:00"
},
"work_instruction_details_id": "72acd1f4-1788-44e3-824b-3f52d4c11587",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e572f970-1276-40f6-a038-914db8962a2c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8000bf47-54ff-4b83-ac19-f5b7d44d275d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-30T06:12:28.2540251+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": "f038b144-6120-4315-9b8a-aca7048bf2c4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-30T06:12:28.2540251+00:00"
}