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": "ac4d6891-9773-405b-a940-71a1a93d740d",
"jobs_id": "fe7dd89e-1736-46a7-9885-03b01aa1650f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "389d5d04-1e4a-482c-9f7f-2fcc04541feb",
"_parent_id": "44d85a8c-ec78-4216-876f-3908e0cf854f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "796530c2-7e18-4319-81cb-ab1e296048ca",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ce9fb635-cef0-4519-aa85-82e0f0f42b46",
"_parent_id": "2ed61d7f-2736-4bc8-89db-4c9741f95232",
"root_parent_id": "97ff8940-a8b1-4b49-a953-b6b263a19d6a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "91e45993-8426-499f-a468-c0591940c35f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1f8fdab7-a66a-4991-b13e-0ace26acda48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e2e9f8dc-27f4-45f0-a415-36b7d5cf8804",
"_parent_code": "sample string 6",
"sales_organization_id": "1351f22d-dfb7-4e0b-a4fb-a8caa087115d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+00:00"
},
"modified_dateutc": "2026-01-25T09:12:51.1158623+00:00"
},
"equipment_model_id": "7ef08d88-f59c-400b-881e-52d3249df99d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "10be89b9-2479-4b4b-9152-a536e617cd24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c24bcdc0-8b0d-4125-904e-c0323c775a9c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c705358b-d07c-4e55-a3ef-6f0ad5094491",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e9bc0516-6d2e-4340-827a-7cbd84bd8218",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+00:00"
},
"modified_dateutc": "2026-01-25T09:12:51.1158623+00:00"
},
"equipment_family_id": "3a76e756-6604-453b-b3c5-721f886ea8e9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1f8fdab7-a66a-4991-b13e-0ace26acda48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e2e9f8dc-27f4-45f0-a415-36b7d5cf8804",
"_parent_code": "sample string 6",
"sales_organization_id": "1351f22d-dfb7-4e0b-a4fb-a8caa087115d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+00:00"
},
"modified_dateutc": "2026-01-25T09:12:51.1158623+00:00"
},
"date_in_production_since": "2026-01-25T09:12:51.1158623+00:00",
"date_out_of_production_since": "2026-01-25T09:12:51.1158623+00:00",
"date_end_support": "2026-01-25T09:12:51.1158623+00:00",
"sales_organization_id": "cb50d05f-a868-4b5f-9fc4-fb840a30789b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+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-25T09:12:51.1158623+00:00"
},
"project_status_id": "d1129820-2798-4512-8911-a3c3586344d9",
"project_status_code": "sample string 10",
"project_status": {
"id": "9bd0dd38-348c-4ff0-83ec-cb9952790ec8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "45ed6096-3d16-4098-9ffd-df5005ff187f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T09:12:51.1158623+00:00"
},
"company_id": "ab5a59ab-2f25-45da-b743-33b346c0122b",
"company_code": "sample string 12",
"db_address_id": "97eb0ae3-1a4d-4829-b1a7-aec9fec47363",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "06349eaf-57f2-4afa-a502-79bb3dd7af2f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f45059eb-7b15-48e7-98a3-98df7ab06155",
"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-25T09:12:51.1158623+00:00",
"date_create": "2026-01-25T09:12:51.1158623+00:00",
"date_update": "2026-01-25T09:12:51.1158623+00:00",
"updated_by_user_id": "6b699af9-a86a-42d0-ba43-42a4d50d63fe",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-25T09:12:51.1158623+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-25T09:12:51.1158623+00:00",
"date_last_job": "2026-01-25T09:12:51.1158623+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-25T09:12:51.1158623+00:00",
"modified_dateutc": "2026-01-25T09:12:51.1158623+00:00",
"is_mobile_installation": true
},
"job_type_id": "9512bdf1-168a-4bc7-ae8c-5186ebd2934f",
"job_type_code": "sample string 7",
"job_type": {
"id": "add76346-e4fb-4240-aa5a-191b83260cfc",
"name": "sample string 2",
"sales_organization_id": "8dc9265c-6151-426b-9298-4f615270e251",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-25T09:12:51.1158623+00:00",
"code": "sample string 7"
},
"job_priority_id": "71e005b0-0093-4029-ac15-2f00ef31ede8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5955d30a-f1f0-4926-bc50-c86dba31648e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "db3b1c15-93ef-4497-9f24-35cfe9957719",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T09:12:51.1158623+00:00"
},
"job_status_id": "2c95c9c9-09ff-4053-95c7-b549ffcdaeaa",
"job_status_code": "sample string 11",
"db_address_id": "f76e8ccb-62b0-4273-8d42-5ea9f96b7063",
"contact_id": "eb8ebe42-6286-4adc-bc44-94ee98e34ae9",
"requested_by_company_id": "3a21fb64-5efd-4ecd-9ec8-13480325345d",
"requested_by_contact_id": "5649d242-3715-45e7-90de-1fcf2080755b",
"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-25T09:12:51.1158623+00:00",
"due_date": "2026-01-25T09:12:51.1158623+00:00",
"date_create": "2026-01-25T09:12:51.1158623+00:00",
"date_update": "2026-01-25T09:12:51.1158623+00:00",
"date_closed": "2026-01-25T09:12:51.1158623+00:00",
"suggested_user_id": "01fbf813-5e08-490c-85b9-f4c5919eb9b5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5b4edc2a-de3b-4345-b12d-0f1706c34e4f",
"db_language_id": "06590bed-7cd7-4e99-9098-11d5e60054ea",
"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-25T09:12:51.1158623+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "28bfdbc8-a4be-449a-b85d-f0b9939639eb",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "69bc8c61-b7b2-4c9e-bfbc-87bb5497eb63",
"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": "7fddb16f-062c-46cf-81b9-37a6e258784b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-25T09:12:51.1314699+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "18b9fcbd-06f2-460d-911c-cc8f8c4d4994"
},
"suggested_date_start": "2026-01-25T09:12:51.1314699+00:00",
"skill_id": "e7448b97-1947-44ef-b248-178809ae2917",
"skill_code": "sample string 32",
"skill": {
"id": "e59409b2-7b5e-40f7-968e-5ad5f334654f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eba1c8fc-042f-49de-8b71-da11f0917375",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f3697545-47c8-4e5f-8b84-f01b71d9560f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "132aec71-3458-4867-a9ae-1fd6fd2922b1",
"db_currency_id": "6ba4a5b5-536e-45f1-aa3a-de79ed29cad6",
"db_language_id": "ba249a9f-49e5-4030-a25d-6aec059249a9",
"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-25T09:12:51.1158623+00:00"
},
"modified_dateutc": "2026-01-25T09:12:51.1314699+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "602c3710-4260-4414-9648-6148a3420338",
"date_reported_by_company": "2026-01-25T09:12:51.1314699+00:00",
"id2": 36,
"company_id": "f1686622-5c3a-4350-9846-3344e5bde044",
"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": "4200a1e1-ee76-4e77-b1fe-cc4b5a0df050",
"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-25T09:12:51.1314699+00:00"
},
"work_instruction_details_id": "181fe3fe-2ccc-4862-bea0-6c2fc2baa25e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "618b8fdf-a7b8-4e74-b73c-3697df6a3a71",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ce0c8a62-14eb-4fec-b264-d84ecb13393b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-25T09:12:51.1314699+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": "e7738a5f-bf02-4a88-8c9f-fd94906dcd24",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-25T09:12:51.1314699+00:00"
}