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": "84e9fa04-ffb2-4b74-9d43-8d392135c789",
"jobs_id": "1552497a-6e3d-457d-863c-b0288e53e6e4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "238cf04c-0f5a-4817-a321-2155d6bab2cb",
"_parent_id": "8dc4096a-7dbf-4d10-88b3-ee9faa68dd1e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ab9c2d6d-7a05-4672-8f78-f254f9de35eb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8dbf2e68-bea8-4218-8233-cf00aa704e54",
"_parent_id": "db71a267-fe51-458e-8696-f02cca0a3b6c",
"root_parent_id": "58f42f6b-ea86-4ae3-96fb-cfb6cf0eab1c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9ea9d3a9-2c59-4037-868b-c8906a56f48e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "82796940-491e-4357-853f-c5705521d69b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b1bf9dc8-e226-412c-a61e-520f4c9912d4",
"_parent_code": "sample string 6",
"sales_organization_id": "13aa2373-7bd8-4797-8e19-6340e77b2d3e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+00:00"
},
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00"
},
"equipment_model_id": "34091ca5-9d56-4d58-9834-08a2243fec46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7de880f6-282c-4ace-ad02-6471ead90511",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3de2f8bc-182b-4446-b86b-1873e24871e3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "378931a7-4f2b-4db5-9765-87e36ee9fb61",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f5250d28-f0fa-4dfd-b831-bd1425b17bc7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+00:00"
},
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00"
},
"equipment_family_id": "bee03645-0f5c-46a5-a958-13b77da4d7d9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "82796940-491e-4357-853f-c5705521d69b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b1bf9dc8-e226-412c-a61e-520f4c9912d4",
"_parent_code": "sample string 6",
"sales_organization_id": "13aa2373-7bd8-4797-8e19-6340e77b2d3e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+00:00"
},
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00"
},
"date_in_production_since": "2026-07-06T19:14:10.4046818+00:00",
"date_out_of_production_since": "2026-07-06T19:14:10.4046818+00:00",
"date_end_support": "2026-07-06T19:14:10.4046818+00:00",
"sales_organization_id": "1dc2738c-4f46-484c-beb5-03035ca3b5c0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+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-07-06T19:14:10.4046818+00:00"
},
"project_status_id": "afbdfb93-0f77-4337-a5cf-da39641fe87e",
"project_status_code": "sample string 10",
"project_status": {
"id": "55b62d34-9bdf-4140-a9c3-d7f6b8d5d3aa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9d0bcdf5-d6e3-49cd-b03d-a8a686ad4ab5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00"
},
"company_id": "52d6fc72-edef-48bb-86e2-8073e5d50141",
"company_code": "sample string 12",
"db_address_id": "577e96d3-3b10-40a8-85d8-10681432ad4c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a6bd7f06-b976-486a-8853-6018ec2f4ffc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1d9ad8c2-df34-4ed7-8747-db8c1e0b1176",
"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-07-06T19:14:10.4046818+00:00",
"date_create": "2026-07-06T19:14:10.4046818+00:00",
"date_update": "2026-07-06T19:14:10.4046818+00:00",
"updated_by_user_id": "b5a1a645-e3e4-4b96-b11a-9d0151c5375b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-06T19:14:10.4046818+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-07-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-06T19:14:10.4046818+00:00",
"date_last_job": "2026-07-06T19:14:10.4046818+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-06T19:14:10.4046818+00:00",
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00",
"is_mobile_installation": true
},
"job_type_id": "e76c316c-73f0-489b-af57-52b2dc209d0d",
"job_type_code": "sample string 7",
"job_type": {
"id": "f1036ecf-0237-49cc-ba05-27608314d952",
"name": "sample string 2",
"sales_organization_id": "92a990d7-e3f4-4067-8f7f-b2a7a014aebe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00",
"code": "sample string 7"
},
"job_priority_id": "60d7f72d-6a83-426c-929c-bbbe39ab5017",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3457104b-7586-43b5-a4d1-852b42aabf6f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "be9e22ef-8d59-46ae-afce-686ca12b003f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00"
},
"job_status_id": "ec257ea4-b587-415c-9477-1dba65318f42",
"job_status_code": "sample string 11",
"db_address_id": "d781bb9b-bce7-47c5-ba05-7079d9703ed3",
"contact_id": "a987ab84-ed94-4e36-9e7a-f3a9748a3ba0",
"requested_by_company_id": "ec7a0a84-5136-4ca1-a238-6b56a7fb0f22",
"requested_by_contact_id": "6f09b52f-f2a2-404f-83e5-4d2ea821ddef",
"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-07-06T19:14:10.4046818+00:00",
"due_date": "2026-07-06T19:14:10.4046818+00:00",
"date_create": "2026-07-06T19:14:10.4046818+00:00",
"date_update": "2026-07-06T19:14:10.4046818+00:00",
"date_closed": "2026-07-06T19:14:10.4046818+00:00",
"suggested_user_id": "60a6efa1-687a-4e5e-89e8-f53ed59863ac",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f972e8a6-aa22-47ba-b96b-4c68637549fe",
"db_language_id": "a3de9468-7a8e-41e9-999a-63f3e1939c17",
"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-07-06T19:14:10.4046818+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0367ce0f-db75-42f7-965f-9e9f8bf75ae9",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8b85e50b-0b70-4a98-9bb1-1d234202619c",
"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": "00a1e990-be35-407f-862e-5a24ce9795b7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "83fe628e-baa2-4298-80c6-72f118f1a943"
},
"suggested_date_start": "2026-07-06T19:14:10.4046818+00:00",
"skill_id": "119fc6e0-6bc1-4642-be6b-f5d21940804e",
"skill_code": "sample string 32",
"skill": {
"id": "9f46789d-c78d-4bce-b81b-b4ad9ca15138",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "63efde6b-592a-4086-914c-338cec54a751",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7e4bce32-4e42-4a60-a1bf-bb41ceda6682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "148f7b65-8670-442d-8a59-b6228b93333b",
"db_currency_id": "5b350ba3-b1c0-4fcd-8c9c-767833449d98",
"db_language_id": "67fe72c5-93cf-4769-8c70-51d0b30d2103",
"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-07-06T19:14:10.4046818+00:00"
},
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c5aab15-49b2-4e17-a778-12d446040272",
"date_reported_by_company": "2026-07-06T19:14:10.4046818+00:00",
"id2": 36,
"company_id": "a7348fab-a3ce-4be8-a5a8-d3f761e94d37",
"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": "91e3ac82-3aa4-400c-9dbc-589e5c174341",
"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-07-06T19:14:10.4046818+00:00"
},
"work_instruction_details_id": "6cdc0ced-a406-47a1-bbeb-edf13a314591",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "571a964f-98a3-4cf5-8ff6-629efa7be222",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "65e5eaa5-064d-4a4c-9c62-94f5e50e9c84",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-06T19:14:10.4046818+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": "32e2ec36-1b80-43e8-ae59-6029c733fd40",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-06T19:14:10.4046818+00:00"
}