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": "db73b8f7-7ba7-4eed-9eac-811dd960488d",
"jobs_id": "98580a2b-aa08-477e-be6e-6661e4a7c69c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "680630bb-f284-42ab-a6a8-1b4c44c63302",
"_parent_id": "942cdd3b-f92a-4250-9e6d-07135fdf1306",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d0d38f7a-1cd1-499a-9724-daa856027157",
"project_reference_back_office": "sample string 5",
"project": {
"id": "619802ba-429a-4a87-aedb-cfb939e0eca5",
"_parent_id": "49124f55-2d4d-4965-8402-c975bed41b72",
"root_parent_id": "2831835b-5a24-40d4-9879-4b9156f419b5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9e75d42a-f0f8-4193-b477-045a8ed2f47e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e3210930-2508-4764-be2a-823a0b58f8be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9325b4d-7955-406e-b7af-101aaa807e44",
"_parent_code": "sample string 6",
"sales_organization_id": "eda30156-c6a0-4e63-993d-9047352da672",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+00:00"
},
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00"
},
"equipment_model_id": "46152892-a66e-44b1-99cc-8e0647053e38",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "22abd855-c696-4807-96fa-74716d6a93e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1abcf24c-a92c-4294-963b-96e941c76539",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e2552baa-75f1-4b59-a0d2-e5afe30ad12d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "161fdc9c-5d7a-40c9-b920-c271baa8f15f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+00:00"
},
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00"
},
"equipment_family_id": "9ab6b4e2-db8e-4d48-b67c-243185461eb5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e3210930-2508-4764-be2a-823a0b58f8be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9325b4d-7955-406e-b7af-101aaa807e44",
"_parent_code": "sample string 6",
"sales_organization_id": "eda30156-c6a0-4e63-993d-9047352da672",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+00:00"
},
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00"
},
"date_in_production_since": "2026-08-11T13:27:02.7274888+00:00",
"date_out_of_production_since": "2026-08-11T13:27:02.7274888+00:00",
"date_end_support": "2026-08-11T13:27:02.7274888+00:00",
"sales_organization_id": "76c85ad2-7a9e-45bc-b5bb-f9717ce3cf12",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+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-11T13:27:02.7274888+00:00"
},
"project_status_id": "9cfd3dd1-5245-4a3a-9ec3-24db6ad3d282",
"project_status_code": "sample string 10",
"project_status": {
"id": "eb823856-c865-4940-b460-1287670a17a7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2fad7d2a-bb38-4b7b-9481-916f02960675",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00"
},
"company_id": "f83705e4-8c41-4f11-ab64-85663d4ba24d",
"company_code": "sample string 12",
"db_address_id": "9f2b3512-29b6-4287-9df2-150c2a2a25d5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1ad8dd9f-352a-4783-82f8-d20d1cea5e29",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d396b165-ef88-48a0-9507-e0d15fa5bfa0",
"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-11T13:27:02.7274888+00:00",
"date_create": "2026-08-11T13:27:02.7274888+00:00",
"date_update": "2026-08-11T13:27:02.7274888+00:00",
"updated_by_user_id": "ca8cd575-36f8-4116-9eee-7a99e3edd8cd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-11T13:27:02.7274888+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-11T13:27:02.7274888+00:00",
"date_last_job": "2026-08-11T13:27:02.7274888+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-11T13:27:02.7274888+00:00",
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00",
"is_mobile_installation": true
},
"job_type_id": "3ab1ffeb-6e70-45cd-bae4-2e501eee3cb1",
"job_type_code": "sample string 7",
"job_type": {
"id": "0275ef9f-4bc9-414f-84ca-f9d06a0e053a",
"name": "sample string 2",
"sales_organization_id": "27e3c5c0-6ec4-4afd-82e4-6fbfbafbf12a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00",
"code": "sample string 7"
},
"job_priority_id": "d78d7d52-9566-4189-9784-a3f6e0aebf48",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "368d8b09-671b-49ba-a477-e2f4e4d12fc5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3c784bea-db14-4bfb-854d-72d748a7e334",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00"
},
"job_status_id": "ac130d6d-e2ac-47fd-b9e0-05736a87572a",
"job_status_code": "sample string 11",
"db_address_id": "0c398f4c-11e5-41ae-91f7-8b402b4259f6",
"contact_id": "bdf4ffb2-7887-4ee1-8795-b86ac717b32f",
"requested_by_company_id": "0379ec69-3739-47e6-9f3a-9d4b9d19cd7a",
"requested_by_contact_id": "cbc162a2-ccaa-4ad0-b868-76fec94b575f",
"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-11T13:27:02.7274888+00:00",
"due_date": "2026-08-11T13:27:02.7274888+00:00",
"date_create": "2026-08-11T13:27:02.7274888+00:00",
"date_update": "2026-08-11T13:27:02.7274888+00:00",
"date_closed": "2026-08-11T13:27:02.7274888+00:00",
"suggested_user_id": "1fd9a3ab-d7c3-42f8-b237-41d5c8628688",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "10c9527d-9c43-40fc-ad31-d83c2a4971c3",
"db_language_id": "231eb5ba-0c4e-42c0-bc39-4d0903b6df05",
"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-11T13:27:02.7274888+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9d62f51-04a9-448c-97c8-4bf23ce4e319",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0ed2eee4-1f14-4225-a41c-1c9d5fcfce52",
"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": "8b525222-699c-4b15-b8ca-9f4c6f481980",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3c7c557d-5a3e-4bfe-83ab-7cc1bb9fd78e"
},
"suggested_date_start": "2026-08-11T13:27:02.7274888+00:00",
"skill_id": "ac68e676-2bbc-4ef7-a6a5-9a94376fd225",
"skill_code": "sample string 32",
"skill": {
"id": "cc0d67b8-56d2-4f18-9227-103e0714ffaa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "96b65f87-dd30-4dad-bf2a-f48c5355cf32",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be58169b-a06d-4486-a115-9e923ab6ec6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78828f64-451f-416c-a303-279865b78d35",
"db_currency_id": "96c020cc-3f2a-4d4d-8425-5e22acb8c123",
"db_language_id": "a53b345e-b563-457d-b516-03f196c2e474",
"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-11T13:27:02.7274888+00:00"
},
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b990b115-6470-467c-9589-cd2c467920c7",
"date_reported_by_company": "2026-08-11T13:27:02.7274888+00:00",
"id2": 36,
"company_id": "d64e1092-e050-4a0c-bd12-33599453b4a4",
"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": "70ec04c1-bc85-45f5-aa78-6ca1b48a0315",
"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-11T13:27:02.7274888+00:00"
},
"work_instruction_details_id": "acd91233-c4de-4603-ad14-c948888e6ec4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2308b82c-a1a9-466c-b300-59e89e3e4c68",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d89edf44-31ea-48aa-aa92-edfa609e77d8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-11T13:27:02.7274888+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": "86323fab-f1f5-4fd3-a981-2c017c5c6599",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-11T13:27:02.7274888+00:00"
}