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": "bc848af7-0031-4cff-9389-5cd9c3d65e6b",
"jobs_id": "264897f9-bfa0-4d12-b71c-72c77386645f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6ba9aafb-9740-4975-b52b-eddbf0249e36",
"_parent_id": "36fc24ba-2749-41e7-b299-a2575aac0f3e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a35d8470-28a1-400a-a10e-957b8d63774e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "16cd06d8-712b-4d6a-994f-ced27e5d8087",
"_parent_id": "bffbd24f-4ede-407b-9b87-ea3b80d1cbe7",
"root_parent_id": "fb9cfedb-e3c5-4551-b9b0-2ba98d2e3d1f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9ff4f9a0-1876-4432-aa53-e89bbd2a6ea8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7253fd1b-e60a-4338-89c3-aa5f064eaeac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a8945123-fdc2-48b6-b1b9-7575411b66ec",
"_parent_code": "sample string 6",
"sales_organization_id": "7215d1ed-142e-4983-97ee-169482e14371",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+00:00"
},
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00"
},
"equipment_model_id": "11d6a98b-6fbf-4477-9841-446e37046926",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e0c83b85-0287-4c77-80b7-9eda5c4a34e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "35ac8b78-2441-4531-b3ab-5aa4a52be1a4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "88f58e57-5c89-4013-8608-bddee14b760a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5921479b-1bf2-4259-a64e-218b76fbbb6b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+00:00"
},
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00"
},
"equipment_family_id": "660de9f4-394e-46b0-9481-ae1ed5927354",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7253fd1b-e60a-4338-89c3-aa5f064eaeac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a8945123-fdc2-48b6-b1b9-7575411b66ec",
"_parent_code": "sample string 6",
"sales_organization_id": "7215d1ed-142e-4983-97ee-169482e14371",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+00:00"
},
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00"
},
"date_in_production_since": "2026-06-17T20:13:18.0009359+00:00",
"date_out_of_production_since": "2026-06-17T20:13:18.0009359+00:00",
"date_end_support": "2026-06-17T20:13:18.0009359+00:00",
"sales_organization_id": "fb129f23-0cf1-4aec-b517-7dafad250993",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+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-06-17T20:13:18.0009359+00:00"
},
"project_status_id": "bd144e1d-5225-4562-8205-2556aa7023ad",
"project_status_code": "sample string 10",
"project_status": {
"id": "d7db2def-7b60-46df-9965-f6b6b05fbdf2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dd0de5fa-b00c-4be3-9e28-c8c53ff4b3d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00"
},
"company_id": "0719a348-0343-4dee-a40d-a979fc18a4ce",
"company_code": "sample string 12",
"db_address_id": "8b74af4f-9cdd-49f1-bff6-611d8bb99edc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0c652f7a-da41-4e74-b702-007e7f175ff9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "052c363d-4b6c-45f7-9478-73891588d31b",
"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-06-17T20:13:18.0009359+00:00",
"date_create": "2026-06-17T20:13:18.0009359+00:00",
"date_update": "2026-06-17T20:13:18.0009359+00:00",
"updated_by_user_id": "6902f849-00ac-4029-86f3-a668a524fda0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-17T20:13:18.0009359+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-06-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-17T20:13:18.0009359+00:00",
"date_last_job": "2026-06-17T20:13:18.0009359+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-17T20:13:18.0009359+00:00",
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00",
"is_mobile_installation": true
},
"job_type_id": "b052eb1d-0b57-4090-a399-cdc70c7178f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "f16e66de-2ea0-4408-95d0-e626b2f4fd8c",
"name": "sample string 2",
"sales_organization_id": "c5ed5571-4a42-49f0-91b1-fb18c76e12d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00",
"code": "sample string 7"
},
"job_priority_id": "66b88b2a-7232-4ddc-9f31-75fe0df23e9c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4906ffc4-102b-4617-a7ee-9382b702b214",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "32f0df62-ec83-4c9a-a99f-80a1c6521dd1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00"
},
"job_status_id": "10526522-0ffe-4bb8-8ff1-16a6066e33ab",
"job_status_code": "sample string 11",
"db_address_id": "222a9fa8-a3c7-4f92-b917-b186946be078",
"contact_id": "43fa3ac6-ff73-42c0-8784-e29d5f931c34",
"requested_by_company_id": "903b747a-aee3-4998-8251-48fea3d77dd3",
"requested_by_contact_id": "900e951d-abe1-482a-8e02-0628e817219f",
"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-06-17T20:13:18.0009359+00:00",
"due_date": "2026-06-17T20:13:18.0009359+00:00",
"date_create": "2026-06-17T20:13:18.0009359+00:00",
"date_update": "2026-06-17T20:13:18.0009359+00:00",
"date_closed": "2026-06-17T20:13:18.0009359+00:00",
"suggested_user_id": "cdf454a6-67e6-4900-9202-8a71f12b7aaf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "61455758-e7f8-406e-9223-f29cc7476657",
"db_language_id": "b33f01ff-481f-4ce7-a960-8d2b5c8f9d44",
"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-06-17T20:13:18.0009359+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ce935cce-61e1-4d8e-9374-b61650622b99",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5ab8ec78-1639-457a-95e2-9acc1c6674a7",
"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": "ab040069-f1b4-4e0b-bf60-976a8043e6f7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6436931c-29ff-4961-b9e8-bcb131fb80f4"
},
"suggested_date_start": "2026-06-17T20:13:18.0009359+00:00",
"skill_id": "ee34f686-3a23-4c2d-8251-f4a7baa4bfe9",
"skill_code": "sample string 32",
"skill": {
"id": "9a35dea3-770b-49ca-bd01-6592cbd01d57",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f580e959-1869-45a8-a24f-6d9061ad69d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fefa572a-978f-4335-b42d-b1f4a2791f56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41e6035b-39ae-4736-8443-99f02a8be93a",
"db_currency_id": "bacf1a46-24f8-4659-8033-e8c2afa30c2f",
"db_language_id": "573baf6c-6517-4ad6-8dc5-41ab17edb6ba",
"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-06-17T20:13:18.0009359+00:00"
},
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ccd384e8-79d6-4120-babc-58555b2a1d6e",
"date_reported_by_company": "2026-06-17T20:13:18.0009359+00:00",
"id2": 36,
"company_id": "482ca3d9-7950-407b-be57-7fe4f477d41e",
"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": "c5eef93a-3d30-49ff-bd57-96566ed8056b",
"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-06-17T20:13:18.0009359+00:00"
},
"work_instruction_details_id": "6c444687-71a7-44be-b326-fba955d3baae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "39d02773-2dfd-4876-a2e9-3baa283298bc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "abb7f9a9-adfb-490b-a03e-1c6dd9245fcb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-17T20:13:18.0009359+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": "14817f48-31fa-4d01-8ecd-3100586e8352",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-17T20:13:18.0009359+00:00"
}