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": "52e970ca-47dd-4f5e-a89c-c82962726e37",
"jobs_id": "e4e65271-f5c5-4c11-957b-7128cd009d09",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "65573ec7-eb49-441c-9247-2a86aa9279c2",
"_parent_id": "ff563ac1-b1aa-4f26-922a-5d38ebefb5d3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c4716eae-b5cf-453b-bd77-859e4a5fce49",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c4ec74ef-8aa0-4aff-aa47-b66c721e4954",
"_parent_id": "7cc90c62-ce0b-4d9f-9177-aaaeb3b5ab5b",
"root_parent_id": "6d3eb72c-e57b-42d9-a787-93a7819de5cc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9d92302c-3c1d-4a0a-8a3b-09c8701a68f0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e27b32fe-1748-4716-a204-78ce2dbcd216",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "888ccebb-eaf8-490b-99f8-d6b696cab27b",
"_parent_code": "sample string 6",
"sales_organization_id": "daed93d0-8ef9-48b0-89b5-4b67c823b424",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+00:00"
},
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00"
},
"equipment_model_id": "63072069-a8b3-47d6-bbf5-4325ef12b11c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5d437d8a-e9d0-4934-9f58-ea9f28d74699",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7730e032-3fde-4b8e-8ecb-6bf2716de2f5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1e0e167b-e7b5-4561-bc51-c473a1ac3f99",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0394cd5b-f011-4206-a480-4d740cf6110c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+00:00"
},
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00"
},
"equipment_family_id": "941c8ac0-1a0c-4651-99f3-2725731ac8e4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e27b32fe-1748-4716-a204-78ce2dbcd216",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "888ccebb-eaf8-490b-99f8-d6b696cab27b",
"_parent_code": "sample string 6",
"sales_organization_id": "daed93d0-8ef9-48b0-89b5-4b67c823b424",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+00:00"
},
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00"
},
"date_in_production_since": "2026-08-30T16:22:49.3648992+00:00",
"date_out_of_production_since": "2026-08-30T16:22:49.3648992+00:00",
"date_end_support": "2026-08-30T16:22:49.3648992+00:00",
"sales_organization_id": "c7634476-7e9b-4d2f-bde0-7b47d10c03fb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+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-08-30T16:22:49.3648992+00:00"
},
"project_status_id": "29983d15-103e-429d-b20b-a41ceab39e9d",
"project_status_code": "sample string 10",
"project_status": {
"id": "63003cdf-6f27-4818-ab76-53c06dfc6b8f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "66bff85e-de5d-46cd-954b-84e14299b98e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00"
},
"company_id": "101b6df4-d9ad-49d1-b27d-cca024180f2b",
"company_code": "sample string 12",
"db_address_id": "f75ca862-2325-4463-8d42-009df7e03eeb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11693858-7ea3-4706-b84d-647b4bf5dca4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8598b6d1-6984-4c27-8c95-692f7c470e79",
"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-08-30T16:22:49.3648992+00:00",
"date_create": "2026-08-30T16:22:49.3648992+00:00",
"date_update": "2026-08-30T16:22:49.3648992+00:00",
"updated_by_user_id": "7a8ea349-60d9-4144-862d-a0d4cf45ef10",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-30T16:22:49.3648992+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-08-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-30T16:22:49.3648992+00:00",
"date_last_job": "2026-08-30T16:22:49.3648992+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-30T16:22:49.3648992+00:00",
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00",
"is_mobile_installation": true
},
"job_type_id": "d5b712a8-69a8-4a5d-9baa-d458e409f2be",
"job_type_code": "sample string 7",
"job_type": {
"id": "84d7b6db-e7d8-4cd5-aa8b-b4d88beed48e",
"name": "sample string 2",
"sales_organization_id": "5440dd63-7e62-432d-be3e-ecc4740ca9b9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00",
"code": "sample string 7"
},
"job_priority_id": "53856424-6b56-46d8-8ea4-df6c6b2a7fc9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "99848ce6-6e23-40f6-a022-d312ec08ebd9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25d9f74c-db29-47c2-8939-d5e2540ee636",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00"
},
"job_status_id": "212a40fa-6c9b-481a-bc4d-b2de6f7c00f1",
"job_status_code": "sample string 11",
"db_address_id": "e861768f-686e-4d4e-a3ec-f84012f14066",
"contact_id": "62359d1e-f18e-47d2-b7eb-5f4be9f3c774",
"requested_by_company_id": "2081354f-76b1-4b00-9948-d3e51dd760f4",
"requested_by_contact_id": "75d08b20-1ad6-4690-b13d-e82f49d5993c",
"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-08-30T16:22:49.3648992+00:00",
"due_date": "2026-08-30T16:22:49.3648992+00:00",
"date_create": "2026-08-30T16:22:49.3648992+00:00",
"date_update": "2026-08-30T16:22:49.3648992+00:00",
"date_closed": "2026-08-30T16:22:49.3648992+00:00",
"suggested_user_id": "f3bc34ec-d062-4a26-807c-42a4a76c7ca4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "86eb5df9-c07f-4af4-84d5-6532a95d0b54",
"db_language_id": "9267a1e7-c92d-43b6-9e6c-adc676f8995d",
"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-08-30T16:22:49.3648992+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "561ca561-4654-4f36-b465-eacf86fc1f02",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1a25849d-5247-4ddb-90c3-540a255688f9",
"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": "a70cc1d3-8857-4a35-80f4-7b29077dc5b0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "13cf8825-fb85-4045-94f5-600c402fe654"
},
"suggested_date_start": "2026-08-30T16:22:49.3648992+00:00",
"skill_id": "ee437990-cf5e-44b7-a494-66a3db8d431f",
"skill_code": "sample string 32",
"skill": {
"id": "1e6ff49f-3d4c-4325-ad48-34efd7649f11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f5b58be0-b194-48b9-88ba-586d05b8eff8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63a1ce88-cc20-4fd9-9686-db870e3a958a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d42977d-d76c-407e-b9a4-22646b638291",
"db_currency_id": "a3fdcc11-f745-466c-a9b1-4e12310c8be9",
"db_language_id": "f20bd31e-b3a0-4869-ba1c-639c176e60af",
"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-08-30T16:22:49.3648992+00:00"
},
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6a7f22b8-4024-49cb-86df-b7f87d245e5f",
"date_reported_by_company": "2026-08-30T16:22:49.3648992+00:00",
"id2": 36,
"company_id": "bcbb7b60-e286-49ad-a147-1d06df6dc824",
"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": "71735fc7-db32-4975-97e1-a9f46b8e2426",
"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-08-30T16:22:49.3648992+00:00"
},
"work_instruction_details_id": "fcf82096-ec61-4872-9202-1572b728ed8f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "898e360a-589e-4554-919b-a144e959eaed",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dbb209d2-0ba4-4c6c-94e5-bb738f782592",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-30T16:22:49.3648992+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": "ca5d0198-64fa-478c-b970-7f2c489cbc58",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-30T16:22:49.3648992+00:00"
}