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": "cdfc60e8-be17-415a-ba2f-d81cd92e19f4",
"jobs_id": "d2a1961f-9756-4094-979f-6e18d6eef2d2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0ce31bfc-afe9-4c37-96b8-08e291abe1a1",
"_parent_id": "abbee844-f5a7-42f5-9af6-ac52adb7dd61",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "834f3a72-21be-4878-80f7-79caebec5719",
"project_reference_back_office": "sample string 5",
"project": {
"id": "133dde28-cb18-4913-95f8-7622ac9f481d",
"_parent_id": "ee502175-ab77-459b-99fe-144e1106e778",
"root_parent_id": "76b592c0-4b6d-4883-9d56-0dcdbaa615df",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "34b9c3e7-28cb-40b2-8bbc-8b9f0fda16e8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "59eb24eb-f915-4214-8159-1cf6b44d2de7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "444f2de2-d8e4-47fb-a449-5dfc14b0d839",
"_parent_code": "sample string 6",
"sales_organization_id": "4b48c9cc-f028-4505-8e85-470a7aa79833",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+00:00"
},
"modified_dateutc": "2026-11-05T17:05:25.6581902+00:00"
},
"equipment_model_id": "526c6a9e-b8a1-4be6-ae6b-46128d1428e1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "31f5e99e-9928-4c84-b732-cb729aab8a6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f5dbe960-be8b-42c7-8d62-3e1c188a2082",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b14cc9df-c6ca-480c-9c92-c68ce94a9374",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2b0faf32-3751-4b5e-9d2d-496c13b01d61",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+00:00"
},
"modified_dateutc": "2026-11-05T17:05:25.6581902+00:00"
},
"equipment_family_id": "961dbe34-dd61-4962-bed5-bbf64e80ec13",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "59eb24eb-f915-4214-8159-1cf6b44d2de7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "444f2de2-d8e4-47fb-a449-5dfc14b0d839",
"_parent_code": "sample string 6",
"sales_organization_id": "4b48c9cc-f028-4505-8e85-470a7aa79833",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+00:00"
},
"modified_dateutc": "2026-11-05T17:05:25.6581902+00:00"
},
"date_in_production_since": "2026-11-05T17:05:25.6581902+00:00",
"date_out_of_production_since": "2026-11-05T17:05:25.6581902+00:00",
"date_end_support": "2026-11-05T17:05:25.6581902+00:00",
"sales_organization_id": "d246e681-ab9e-4100-93be-b851d055c1fe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+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-11-05T17:05:25.6744738+00:00"
},
"project_status_id": "b8a83480-6355-4e66-878c-2b1b78555f9f",
"project_status_code": "sample string 10",
"project_status": {
"id": "75409711-63f4-4f65-86c9-db7b69d6e425",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "796369c8-dbc7-4ca9-8626-2280d935263c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T17:05:25.6744738+00:00"
},
"company_id": "07423653-a810-419f-b64f-c43d2847f8d1",
"company_code": "sample string 12",
"db_address_id": "0cc108af-5ad3-4ffc-9999-8ff68fbaba4b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e73359c1-0829-4391-b701-c9004f3f5210",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c314e857-969e-4119-a743-28e88a751c5b",
"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-11-05T17:05:25.6744738+00:00",
"date_create": "2026-11-05T17:05:25.6744738+00:00",
"date_update": "2026-11-05T17:05:25.6744738+00:00",
"updated_by_user_id": "f1d18cb7-9261-45ae-9ec0-5f963c25db8f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-05T17:05:25.6744738+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-11-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-05T17:05:25.6744738+00:00",
"date_last_job": "2026-11-05T17:05:25.6744738+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-05T17:05:25.6744738+00:00",
"modified_dateutc": "2026-11-05T17:05:25.6744738+00:00",
"is_mobile_installation": true
},
"job_type_id": "712fe42d-532b-43a3-bbf3-3eda38570fff",
"job_type_code": "sample string 7",
"job_type": {
"id": "4dbbd8bd-d4f3-4f01-82a5-04f6ab771960",
"name": "sample string 2",
"sales_organization_id": "7eab0590-3c74-4c1d-9dea-73a17ade9ae7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-05T17:05:25.6744738+00:00",
"code": "sample string 7"
},
"job_priority_id": "4485a8ab-584d-4d14-bf81-6281bbb54ee5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6eaff5ce-0c26-47c5-8352-67cd288eec06",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "632ed7da-d6d0-4988-859e-08ec8d25416b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-05T17:05:25.6744738+00:00"
},
"job_status_id": "cd196603-03a6-4e89-a091-0380314ac72b",
"job_status_code": "sample string 11",
"db_address_id": "a86144a7-5341-42ef-8a70-bbe20cbe9dc5",
"contact_id": "a861eff3-6dc5-4087-baae-534213678b82",
"requested_by_company_id": "115b22de-c8ac-46fe-a269-23e55b6fecd0",
"requested_by_contact_id": "4ee8dbef-3477-4853-9d0f-9500a48f278f",
"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-11-05T17:05:25.6744738+00:00",
"due_date": "2026-11-05T17:05:25.6744738+00:00",
"date_create": "2026-11-05T17:05:25.6744738+00:00",
"date_update": "2026-11-05T17:05:25.6744738+00:00",
"date_closed": "2026-11-05T17:05:25.6744738+00:00",
"suggested_user_id": "afdb193f-94a2-43fc-9d70-7fb63dfef8ff",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bc0d5774-1343-4926-9095-899629faa9dc",
"db_language_id": "b1f5e511-6298-4c76-8282-49bf47b802da",
"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-11-05T17:05:25.6744738+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fec650bf-a1e7-4599-9b2a-29dc24a9847c",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f6aabf61-5ff9-4f2a-8296-ef744b78bd42",
"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": "d0ad6151-7fe9-4ebe-8a9a-bbd9f0623f2a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-05T17:05:25.6744738+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "27d4f8f1-8cfc-4a3e-b679-8e7bc69243e8"
},
"suggested_date_start": "2026-11-05T17:05:25.6744738+00:00",
"skill_id": "f02b7383-cc06-4ebc-a324-90312083bb13",
"skill_code": "sample string 32",
"skill": {
"id": "12d27a00-d50e-4c4c-beda-c9a17dd46baa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5340000f-29ab-4fb3-9ed8-bb59056249ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edd618aa-0970-424b-bb9c-e65766391683",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e764da8b-ade9-4840-8076-86a0eb5da05b",
"db_currency_id": "f9e239f4-da9d-4fd9-b0c6-ce36402ee304",
"db_language_id": "b2db3fc0-5d35-48e4-9fa2-c49473ce19c2",
"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-11-05T17:05:25.6581902+00:00"
},
"modified_dateutc": "2026-11-05T17:05:25.6744738+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e8cb89a8-a922-4757-ab17-60295b3db950",
"date_reported_by_company": "2026-11-05T17:05:25.6744738+00:00",
"id2": 36,
"company_id": "9d5d3629-9fec-4145-9662-c4eb1f754c99",
"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": "2e4f607c-0b99-48d1-a4e8-4868bc89ff05",
"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-11-05T17:05:25.6744738+00:00"
},
"work_instruction_details_id": "62d9113e-5b44-4c33-aa7c-e784d1e82663",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b0a01fe9-c4cd-417b-a902-4ed24e2e37da",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "71f27826-02f6-4d90-abae-83210cc4fdf2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-05T17:05:25.6744738+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": "bd071df0-040c-4a60-92bf-0738bc37e5b4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-05T17:05:25.6744738+00:00"
}