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": "0a242e22-1bac-4c66-a291-bf93f8fe79ee",
"jobs_id": "c7dddab3-0e6c-435e-a31c-282dd169e700",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "931d4ea0-7704-41ae-a1f6-259c9b69e2b0",
"_parent_id": "70eb7140-383a-4bf1-ab6d-1bf7cff84b45",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0c1b4a65-f089-486f-b306-2545c144c9ba",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2e91129a-52e2-49ae-80ec-80c2e6fcf635",
"_parent_id": "1b8c378e-e0af-4732-b959-1c27132cc0ef",
"root_parent_id": "df5da29b-8faf-45b4-ae46-85a9a77e6f92",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "eb24d990-ada5-4571-900a-8f6d2200f0fd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "70f679b1-55ee-4449-a536-6fdb4509994c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ddd156c8-ecce-4475-a9f2-625cb827ef20",
"_parent_code": "sample string 6",
"sales_organization_id": "9142315f-1fa9-4424-85b8-b45146d4b186",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00"
},
"equipment_model_id": "433bd94e-1bc7-4086-b230-573d575ee18e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "13dccd9d-7a49-462c-a17e-c9d8dc80f373",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6165e75a-ce2b-45cb-98c0-3f698494f027",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3c809c54-8a7f-4ff8-a188-9e3d7e07e955",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "35c291fd-8eda-4d21-8778-a8f59091ccb7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00"
},
"equipment_family_id": "899cb957-f78c-417e-869d-c6966dc43911",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "70f679b1-55ee-4449-a536-6fdb4509994c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ddd156c8-ecce-4475-a9f2-625cb827ef20",
"_parent_code": "sample string 6",
"sales_organization_id": "9142315f-1fa9-4424-85b8-b45146d4b186",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00"
},
"date_in_production_since": "2026-08-06T19:59:45.5855448+00:00",
"date_out_of_production_since": "2026-08-06T19:59:45.5855448+00:00",
"date_end_support": "2026-08-06T19:59:45.5855448+00:00",
"sales_organization_id": "7827e1d0-bff7-4afa-91d7-af414dbd9e1f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+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-06T19:59:45.5855448+00:00"
},
"project_status_id": "6f9b0fd6-f010-40cd-b778-27277f33b200",
"project_status_code": "sample string 10",
"project_status": {
"id": "ffadca2d-7052-4030-9cb1-1aea2eba8598",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5fc7df92-664e-4891-8317-bd962695bec5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00"
},
"company_id": "f12dcd48-8c10-4aed-9edb-7b79e011527e",
"company_code": "sample string 12",
"db_address_id": "5403d3fb-10cd-495a-8ce0-ba1c3b63d2be",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "10916391-7a54-450f-8a91-29cc9e293012",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b3b90f8a-0cb1-44de-875d-f42aa62bf2a1",
"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-06T19:59:45.5855448+00:00",
"date_create": "2026-08-06T19:59:45.5855448+00:00",
"date_update": "2026-08-06T19:59:45.5855448+00:00",
"updated_by_user_id": "04b05e1f-ade6-4e8e-a31b-008db17db98d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-06T19:59:45.5855448+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-06T19:59:45.5855448+00:00",
"date_last_job": "2026-08-06T19:59:45.5855448+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-06T19:59:45.5855448+00:00",
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00",
"is_mobile_installation": true
},
"job_type_id": "2861bead-64e2-4de5-acfd-660013c8eac8",
"job_type_code": "sample string 7",
"job_type": {
"id": "eb16d87d-2429-40b0-bed9-cf133e3dae43",
"name": "sample string 2",
"sales_organization_id": "f7132dff-0c05-4275-8a16-ddb8e691687e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00",
"code": "sample string 7"
},
"job_priority_id": "05584b73-1f50-4536-9255-e36aab6f1551",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "40002fb0-f73e-4761-991a-9437f4b67711",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a759a872-f4b5-40cb-b548-a95cd6482a7b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00"
},
"job_status_id": "1a029be5-6a8d-4307-bb89-a0a4c55e30ea",
"job_status_code": "sample string 11",
"db_address_id": "38f147e5-eb3d-4318-9470-608fd5058e52",
"contact_id": "9c6ff9e9-bbe7-4365-878c-38ab36ec2e95",
"requested_by_company_id": "b838a9aa-a62f-424b-9d3a-f298ed1f5605",
"requested_by_contact_id": "82befa59-f9ae-4d00-bbd4-c1c8d0b5aa71",
"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-06T19:59:45.5855448+00:00",
"due_date": "2026-08-06T19:59:45.5855448+00:00",
"date_create": "2026-08-06T19:59:45.5855448+00:00",
"date_update": "2026-08-06T19:59:45.5855448+00:00",
"date_closed": "2026-08-06T19:59:45.5855448+00:00",
"suggested_user_id": "3489788f-377c-45bc-b808-8f7aa7c613f3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "34009dd6-7954-4b1a-a937-bf07b8850e8a",
"db_language_id": "eb422457-20a6-46af-afd2-1754af5ca74f",
"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-06T19:59:45.5855448+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "86080232-9ceb-4fad-aab0-fe8d1c1d17f5",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "22d13fab-bc13-4adf-ac26-b78a3c54193b",
"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": "f9b8f116-554d-4623-a730-a0c27df782ad",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ce41771f-41da-464f-ab34-4b3f23e55945"
},
"suggested_date_start": "2026-08-06T19:59:45.5855448+00:00",
"skill_id": "b0888009-612f-49d5-9940-93f77c59e583",
"skill_code": "sample string 32",
"skill": {
"id": "fd34910d-949f-47a9-ae7f-201662b4ca00",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c7a55316-9bf9-4192-b52d-2973e5e9ee52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d857622-c37a-4e9f-b6ed-272e68923a59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09840521-5b91-4cc0-96a7-429c39a25ca7",
"db_currency_id": "d9b6c1a1-1303-49b8-8817-419ca485974e",
"db_language_id": "28de906d-bcaf-4acd-986d-409651b4728e",
"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-06T19:59:45.5855448+00:00"
},
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a5a54744-4c88-421d-83d8-d8cf1fd89bff",
"date_reported_by_company": "2026-08-06T19:59:45.5855448+00:00",
"id2": 36,
"company_id": "39f7167c-aae3-41f9-9bbb-0737594a11a2",
"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": "7b6dce34-4aa0-4242-9d44-a55565e3f73d",
"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-06T19:59:45.5855448+00:00"
},
"work_instruction_details_id": "b56b26dd-7859-4ec6-9ef4-b0f0ac0808d2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "210229a8-f652-419c-9e42-4fcbf55959ae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "31e0f682-8e55-4a9e-9ff7-c9aa173bbaba",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-06T19:59:45.5855448+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": "64e93b07-edc4-4ccd-b7cb-79eecdd416ba",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-06T19:59:45.5855448+00:00"
}