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": "ea813809-65cb-4adc-8599-c49ed805b65e",
"jobs_id": "348e4d3a-27e6-4417-a5ac-a83e4c67fcd4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a8a7d5cb-8414-4e9c-b47c-51c7994e596f",
"_parent_id": "ae05a658-d71a-432f-b1e7-63669fe66b69",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4f6906a0-7e54-4fc0-8e3e-4b6bc046cf8b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2568f8cc-c60a-40d4-b95c-0c1aaf69f7ef",
"_parent_id": "6a948dc1-1b59-4156-a91b-60386c3ff918",
"root_parent_id": "88100df8-c99a-468c-a77b-c97879e55dc8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0c25858f-6f38-4cde-aabc-06152657a7f3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "96575c13-3214-4f9c-9b4d-686c5575ec79",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12dfe049-4c10-413a-87ac-eb7ef1160b46",
"_parent_code": "sample string 6",
"sales_organization_id": "5fffaa8e-0e86-4084-9691-a5f4ce54ca97",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+00:00"
},
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00"
},
"equipment_model_id": "6adf60ab-660b-4027-85e2-dad6d9849239",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "518bb829-5edb-43ac-99d0-5840b9b3cf21",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fc76e6a4-b9b2-4e3b-a230-17c9089b2692",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "985675d1-7b07-44b4-82e5-19a773e6d08a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "760658c8-f13d-416c-bf84-2b41310ad327",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+00:00"
},
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00"
},
"equipment_family_id": "4af9c09f-a0c9-456b-96b9-08bd75f2db37",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "96575c13-3214-4f9c-9b4d-686c5575ec79",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12dfe049-4c10-413a-87ac-eb7ef1160b46",
"_parent_code": "sample string 6",
"sales_organization_id": "5fffaa8e-0e86-4084-9691-a5f4ce54ca97",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+00:00"
},
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00"
},
"date_in_production_since": "2026-09-05T17:22:58.8832556+00:00",
"date_out_of_production_since": "2026-09-05T17:22:58.8832556+00:00",
"date_end_support": "2026-09-05T17:22:58.8832556+00:00",
"sales_organization_id": "47a4386b-3bc7-4cfb-be35-65763cb9cec1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+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-09-05T17:22:58.8832556+00:00"
},
"project_status_id": "43f639cf-db48-4bef-9615-ad535b061a7d",
"project_status_code": "sample string 10",
"project_status": {
"id": "7f953216-0b41-4fbc-a13b-138c049475fc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5e7ed041-30fe-4adf-b6f8-20c205eeef6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00"
},
"company_id": "d03a834a-9f2f-47be-a8f9-05111d220e4e",
"company_code": "sample string 12",
"db_address_id": "04195062-0cbd-4795-9ba4-092fc64b6da7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d37aa381-de27-4374-8d24-278be2a49263",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "74e96aa9-2e0e-4022-a23d-4d3562c3e1ba",
"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-09-05T17:22:58.8832556+00:00",
"date_create": "2026-09-05T17:22:58.8832556+00:00",
"date_update": "2026-09-05T17:22:58.8832556+00:00",
"updated_by_user_id": "86d832ea-5da9-434b-8573-23146fc7424f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-05T17:22:58.8832556+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-09-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-05T17:22:58.8832556+00:00",
"date_last_job": "2026-09-05T17:22:58.8832556+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-05T17:22:58.8832556+00:00",
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00",
"is_mobile_installation": true
},
"job_type_id": "8215e642-18c3-43ff-8e43-5eb309655c70",
"job_type_code": "sample string 7",
"job_type": {
"id": "be183948-768f-4f37-aa88-f869e382dc13",
"name": "sample string 2",
"sales_organization_id": "6bcd0645-2ec0-4607-aeb6-97a7284e4222",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00",
"code": "sample string 7"
},
"job_priority_id": "ea8f68dd-4fab-45eb-99ab-3ece0bcdbb3c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6462b810-ef1f-4fad-a88d-2c7dcc05e83e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5f2096f7-f880-4a91-9351-867ce25e966a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00"
},
"job_status_id": "aea02026-7fe6-499e-9857-27b5241bc470",
"job_status_code": "sample string 11",
"db_address_id": "292e3751-c9fc-444e-8ed2-25eb3c66e34b",
"contact_id": "c761a9b5-db78-4095-aef0-cd404ab2eb92",
"requested_by_company_id": "aa498918-7b36-42a6-8cac-c753fdbf5380",
"requested_by_contact_id": "01d7ce5a-d17b-4774-a9d2-2753992ed83c",
"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-09-05T17:22:58.8832556+00:00",
"due_date": "2026-09-05T17:22:58.8832556+00:00",
"date_create": "2026-09-05T17:22:58.8832556+00:00",
"date_update": "2026-09-05T17:22:58.8832556+00:00",
"date_closed": "2026-09-05T17:22:58.8832556+00:00",
"suggested_user_id": "1028c887-9959-45e6-b808-1e8bff59b974",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c9e259e5-4b2f-4752-bd81-3684efca0031",
"db_language_id": "b76694c3-9436-48a9-8ecc-d419ea2e07e0",
"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-09-05T17:22:58.8832556+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "79fa8d2d-0821-45ad-92bc-9c0762deafff",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e6c83fc4-9e08-4021-a1b8-a657ffcc0e5e",
"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": "c9ce2960-c857-4595-9878-ac6752d054e8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "88bda98b-1d77-489c-971d-95ea67598e2b"
},
"suggested_date_start": "2026-09-05T17:22:58.8832556+00:00",
"skill_id": "8d408829-eadc-494a-989d-04e9176fd2e0",
"skill_code": "sample string 32",
"skill": {
"id": "75e0ae3b-eefe-43be-904a-c43d4a8245aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f1e4f436-1573-4193-beb2-68797f2adbe0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8dd08fff-3d9d-4e3b-8637-b37454a2d05e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f8dc250-0e67-49c9-9075-42efb72d85a3",
"db_currency_id": "09877692-9cb2-44f2-921a-80894dd3560d",
"db_language_id": "243a7743-73c1-41e2-9d79-cfd6d916b755",
"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-09-05T17:22:58.8832556+00:00"
},
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "41c1b5a8-eba4-4422-92dd-04e1a5b402e6",
"date_reported_by_company": "2026-09-05T17:22:58.8832556+00:00",
"id2": 36,
"company_id": "d90e6224-8ea1-4207-a091-59c1499f54bd",
"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": "5ff63993-1ad5-49a1-8a6b-0af7baeebdd6",
"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-09-05T17:22:58.8832556+00:00"
},
"work_instruction_details_id": "69254bdd-ab0e-423f-aad9-0d4f198f0abe",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5a83f5f2-d6d2-4ec4-a71f-6143abd0796a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "18cb47d3-5732-4ca0-a743-5fef01f6025b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-05T17:22:58.8832556+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": "b4cfac84-c215-46dd-ba78-053489915855",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-05T17:22:58.8832556+00:00"
}