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": "656abbcc-ff1f-4542-a01e-acff65c3018a",
"jobs_id": "dc794edc-25ab-49b1-bc38-5d284cbf7fd9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ff549fae-5415-4e79-9483-b27450ef3216",
"_parent_id": "d304bb29-b53b-4637-b724-4ce1b5c850e2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "215a6eb4-d8b3-455e-b369-012d07115c23",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0c57d30d-24d9-461a-a809-bad140b65f9d",
"_parent_id": "beeb73d7-c4e9-405e-9561-868b7f93609e",
"root_parent_id": "636df99e-2e3b-4d92-9ddf-ef40c402e795",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a7a89198-ec57-441e-a19f-6b6c053511c3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "08d02ba8-7942-4915-9ebc-fd6a0b13e44a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "63619dcb-f5ba-4e4b-87d7-0045baa7da7b",
"_parent_code": "sample string 6",
"sales_organization_id": "a8d69e1e-5903-47af-bb55-e071a4232a57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+00:00"
},
"modified_dateutc": "2025-12-17T06:58:02.6937464+00:00"
},
"equipment_model_id": "e4185434-2cc7-4b95-aceb-4081149a15b6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bc268022-e5a7-423f-a39c-95c94abef65e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fbf2e169-fa83-4a54-a79d-5a3d6ae13609",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bca98d37-9919-42aa-9443-e54463f2e9ad",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b83ce60d-2fdf-4c39-a566-ac99774e3f7d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+00:00"
},
"modified_dateutc": "2025-12-17T06:58:02.6937464+00:00"
},
"equipment_family_id": "68662e75-5fc3-412e-b02c-93f5a5edf4ee",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "08d02ba8-7942-4915-9ebc-fd6a0b13e44a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "63619dcb-f5ba-4e4b-87d7-0045baa7da7b",
"_parent_code": "sample string 6",
"sales_organization_id": "a8d69e1e-5903-47af-bb55-e071a4232a57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+00:00"
},
"modified_dateutc": "2025-12-17T06:58:02.6937464+00:00"
},
"date_in_production_since": "2025-12-17T06:58:02.6937464+00:00",
"date_out_of_production_since": "2025-12-17T06:58:02.6937464+00:00",
"date_end_support": "2025-12-17T06:58:02.6937464+00:00",
"sales_organization_id": "2931278d-7108-4422-ad97-2249bf9c19cf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+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": "2025-12-17T06:58:02.7093597+00:00"
},
"project_status_id": "5427ae0a-95bf-4b4e-a79a-0ad137164801",
"project_status_code": "sample string 10",
"project_status": {
"id": "d5f66eb7-071e-4612-910a-bf72771951b5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4a086638-e22c-48e9-98ac-d4c0eb01ff8b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-17T06:58:02.7093597+00:00"
},
"company_id": "6577c14f-11f7-4c10-9d72-2a397b9fd7c6",
"company_code": "sample string 12",
"db_address_id": "5514f136-e88f-45f8-89c4-9f36a7bf72fb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "998ff1f3-e642-4244-bfbd-bcf5e88a06a3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "76428a45-9e5d-4c6d-a030-ff17571e287a",
"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": "2025-12-17T06:58:02.7093597+00:00",
"date_create": "2025-12-17T06:58:02.7093597+00:00",
"date_update": "2025-12-17T06:58:02.7093597+00:00",
"updated_by_user_id": "0991f87b-465d-4629-b5e3-afa363e48640",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-17T06:58:02.7093597+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": "2025-12-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-17T06:58:02.7093597+00:00",
"date_last_job": "2025-12-17T06:58:02.7093597+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-17T06:58:02.7093597+00:00",
"modified_dateutc": "2025-12-17T06:58:02.7093597+00:00",
"is_mobile_installation": true
},
"job_type_id": "60ce20b9-e611-474e-8876-63e6e29fd577",
"job_type_code": "sample string 7",
"job_type": {
"id": "1e7fd2db-bf8b-4463-a512-d000eb298307",
"name": "sample string 2",
"sales_organization_id": "b6068f72-abc1-49b7-91a6-4b74538a57c1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-17T06:58:02.7093597+00:00",
"code": "sample string 7"
},
"job_priority_id": "c98c9ae0-ca11-4cda-baee-0f951f13395b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f478350b-6456-48ac-a36c-64f3207775f9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "19790a54-184d-4a34-a5de-7d9d44aaace2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-17T06:58:02.7093597+00:00"
},
"job_status_id": "7dd2ba0d-eae9-46a9-ab16-a43adaccf465",
"job_status_code": "sample string 11",
"db_address_id": "0c8b4d78-106c-415f-be4f-d4262f99e28e",
"contact_id": "aa69f842-f948-460f-96ff-a38a6e137fca",
"requested_by_company_id": "b05ea58a-3daa-47de-a019-67e03e681914",
"requested_by_contact_id": "ac161d59-fc65-4b90-abfd-bdcf8ae4b7e5",
"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": "2025-12-17T06:58:02.7093597+00:00",
"due_date": "2025-12-17T06:58:02.7093597+00:00",
"date_create": "2025-12-17T06:58:02.7093597+00:00",
"date_update": "2025-12-17T06:58:02.7093597+00:00",
"date_closed": "2025-12-17T06:58:02.7093597+00:00",
"suggested_user_id": "0c71d390-fe57-4848-9c5e-7877a9fce91c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5d9782d4-dafb-497d-a88e-5405b104656a",
"db_language_id": "1bb3e38c-aca7-4458-8eca-584120e9cda4",
"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": "2025-12-17T06:58:02.7093597+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "41d98743-292a-4203-b226-f1d9577f5b0b",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1c48b3e8-9251-405b-96e4-8b23e7850ad5",
"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": "dd2d54c2-af77-4b18-a944-f8580dea0e71",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-17T06:58:02.7093597+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "121c255f-7a2b-4da9-ac3f-7e109b13c2c9"
},
"suggested_date_start": "2025-12-17T06:58:02.7093597+00:00",
"skill_id": "cc9cfd07-4f44-46ad-bee1-b8a5f854cf94",
"skill_code": "sample string 32",
"skill": {
"id": "23035787-9047-4e72-bfcd-8cf2733d2d6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1f61d58b-40ea-4bbb-8445-00746e1e5697",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "765196d1-0836-4028-8f3b-c6b19fc4f16d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdb3b084-79fa-49fa-a890-8c833d54e086",
"db_currency_id": "77d849d2-0701-46da-9aea-410d55b9b326",
"db_language_id": "fd600264-2d71-4acb-b714-f3fb4957fd1f",
"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": "2025-12-17T06:58:02.6937464+00:00"
},
"modified_dateutc": "2025-12-17T06:58:02.7093597+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bb4133e2-ba28-4210-b6c4-8ffae950f851",
"date_reported_by_company": "2025-12-17T06:58:02.7093597+00:00",
"id2": 36,
"company_id": "0279e4a5-5ff1-4ba2-95c5-c881cf9af44f",
"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": "d7e9e035-fa6e-484e-97bc-ee705642dbc2",
"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": "2025-12-17T06:58:02.7093597+00:00"
},
"work_instruction_details_id": "bb58ae13-bf23-412e-9d95-e22f132efaa0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "46b370b9-8a65-4e48-a40d-9745e30104d7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f6605e77-e482-43fa-901f-6a40967ba73f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-17T06:58:02.7093597+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": "3f278b9f-ae17-4fb5-bde8-aca899d95f14",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-17T06:58:02.7093597+00:00"
}