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": "42aa2b27-d722-4ee3-a7cc-3d45975d3e26",
"jobs_id": "55eed9db-343c-4d4d-9b70-5e3d49eeb930",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6321f91d-5f77-46e3-8c60-844bfb075dc6",
"_parent_id": "a486dcce-3387-4f1c-95ae-86cd2260bf56",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "89939989-cf00-418d-9767-d24413c1964f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a0934bf0-daba-4ac2-b0bc-5d66ac7059ce",
"_parent_id": "8689d919-03f4-4a19-b31d-f0dd4bd20f6b",
"root_parent_id": "bf195ebb-bd38-4012-97bb-69adb2e2a11c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dd0adbcb-b3dc-46bc-ae10-8c560570b6f8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "160ee621-b25c-42e4-b245-166977e2e1f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "239afc72-cfb4-45e7-a633-eaf84943a5d5",
"_parent_code": "sample string 6",
"sales_organization_id": "e5b67af1-8531-4814-9a59-4971a2732c02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+00:00"
},
"modified_dateutc": "2026-03-29T16:05:43.8479976+00:00"
},
"equipment_model_id": "cb336f6e-74d6-409c-9eb7-15c5f7e5379b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "62261f73-80ae-4fbc-b486-ff91a9e0a923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e8a7c88c-96fc-44fb-a94e-d6e0085e7b0c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bb983107-fb80-4e28-b7d8-66382554ca29",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f30c30ff-b7d6-4869-a74a-51f3bb36d454",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+00:00"
},
"modified_dateutc": "2026-03-29T16:05:43.8479976+00:00"
},
"equipment_family_id": "a78c71ba-fc4b-44a6-9a07-1cb0e36a07fe",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "160ee621-b25c-42e4-b245-166977e2e1f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "239afc72-cfb4-45e7-a633-eaf84943a5d5",
"_parent_code": "sample string 6",
"sales_organization_id": "e5b67af1-8531-4814-9a59-4971a2732c02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+00:00"
},
"modified_dateutc": "2026-03-29T16:05:43.8479976+00:00"
},
"date_in_production_since": "2026-03-29T16:05:43.8479976+00:00",
"date_out_of_production_since": "2026-03-29T16:05:43.8479976+00:00",
"date_end_support": "2026-03-29T16:05:43.8479976+00:00",
"sales_organization_id": "40312ea3-3ed7-4a9c-ad25-86a40479ace2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+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-03-29T16:05:43.8629703+00:00"
},
"project_status_id": "068d2e9d-2dc4-4119-afcb-eef493762b66",
"project_status_code": "sample string 10",
"project_status": {
"id": "8fb6df3d-d95d-498e-aea4-f8a8414c85d7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "aa341ae4-3f77-40f8-b444-4cef14f79c09",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-29T16:05:43.8629703+00:00"
},
"company_id": "a3c149e8-a407-44cd-aa48-098ffd6a0ceb",
"company_code": "sample string 12",
"db_address_id": "9a9a6f8e-cf8a-4d86-8add-5918b74a8556",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "70b734d3-51ba-4180-90e7-198e9a9accd4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "206171e9-d947-4518-b244-76d3912444d4",
"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-03-29T16:05:43.8629703+00:00",
"date_create": "2026-03-29T16:05:43.8629703+00:00",
"date_update": "2026-03-29T16:05:43.8629703+00:00",
"updated_by_user_id": "b8877359-83cb-4697-afc2-3aa8dddb7888",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-29T16:05:43.8629703+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-03-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-29T16:05:43.8629703+00:00",
"date_last_job": "2026-03-29T16:05:43.8629703+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-29T16:05:43.8629703+00:00",
"modified_dateutc": "2026-03-29T16:05:43.8629703+00:00",
"is_mobile_installation": true
},
"job_type_id": "4784a2b2-2eeb-4f37-be61-9ac167c02548",
"job_type_code": "sample string 7",
"job_type": {
"id": "56bb13e2-da10-44ab-a300-1989365619d6",
"name": "sample string 2",
"sales_organization_id": "77f72cec-04b9-4382-b372-55f17426e128",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-29T16:05:43.8629703+00:00",
"code": "sample string 7"
},
"job_priority_id": "cdab057e-1547-421d-98e3-fe4f36502478",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "83be695f-050f-42ce-bb93-ca86953b7b76",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e3233d76-e718-47d2-b067-beaca75380b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-29T16:05:43.8629703+00:00"
},
"job_status_id": "35275c3b-8b61-477b-af67-e567c872103c",
"job_status_code": "sample string 11",
"db_address_id": "e175a143-e49a-4fce-bb5e-d6b26c4a2ad5",
"contact_id": "32652c57-5760-41db-9788-5eb07c9e6f66",
"requested_by_company_id": "24e30ab2-f8ab-48b4-a888-d82f971bbdcc",
"requested_by_contact_id": "6286ec41-0b21-40af-a137-7468fd20d269",
"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-03-29T16:05:43.8629703+00:00",
"due_date": "2026-03-29T16:05:43.8629703+00:00",
"date_create": "2026-03-29T16:05:43.8629703+00:00",
"date_update": "2026-03-29T16:05:43.8629703+00:00",
"date_closed": "2026-03-29T16:05:43.8629703+00:00",
"suggested_user_id": "c384df80-9865-407a-bf91-2775b6204b70",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "018e9002-369c-47c8-82f5-54323dae298a",
"db_language_id": "2b5ebcb9-79cf-4bf2-a253-b487712a1ad1",
"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-03-29T16:05:43.8629703+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9262717-4b6e-404e-8465-0c9ec9ed9425",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c9fca744-787f-4391-bd89-35a5ac428cce",
"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": "c0113814-8e28-4f0e-9f40-1b79929db8a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-29T16:05:43.8629703+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d7cb31bd-1a85-4081-9bc8-77b1ab55d4dc"
},
"suggested_date_start": "2026-03-29T16:05:43.8629703+00:00",
"skill_id": "8739078f-276c-4bd2-b7f3-1125d28fec7c",
"skill_code": "sample string 32",
"skill": {
"id": "dad3340c-8149-4f8f-9885-f3c35ad2b467",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c1b10a06-8521-4545-bf22-5d188af14f28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1748432e-cf3f-4266-b5c6-721f382532c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b34e8f08-412f-4851-801b-def559791c71",
"db_currency_id": "5a0f20fe-a955-4f01-bb8a-4957569cc72b",
"db_language_id": "d13ddd86-81a6-4bd5-b8d7-9830d2228dda",
"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-03-29T16:05:43.8479976+00:00"
},
"modified_dateutc": "2026-03-29T16:05:43.8629703+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fdfc664d-f9c1-4bb9-83ee-63eef703c121",
"date_reported_by_company": "2026-03-29T16:05:43.8629703+00:00",
"id2": 36,
"company_id": "8ea9fbb2-ea0d-4213-a5f9-24f74b1d0f3c",
"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": "44c68e5e-eac0-4bc5-a266-14d427cec081",
"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-03-29T16:05:43.8629703+00:00"
},
"work_instruction_details_id": "02d9d6e4-ec47-4285-a49c-24a70dcf2a0a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d9295e47-79be-42a4-b484-4689ee093017",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c6f3d81f-3077-48d1-9405-7c5c304463a7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-29T16:05:43.8629703+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": "5b7a783f-69d5-4e38-8566-99a4d8a8b274",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-29T16:05:43.8629703+00:00"
}