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": "840c34cc-eafb-46d9-9a59-d4190c5dedbd",
"jobs_id": "54f78306-16c2-45aa-9230-44d80d1a5b8b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "477d0d6e-2cee-49a3-9911-044656958cb8",
"_parent_id": "5752f136-825e-4c9a-8fb0-d7c6765dab93",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ca1b5411-6370-4e4f-8953-9454d389f1c9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c3726412-a4c8-4aed-a33e-318a4bc7c162",
"_parent_id": "e4c1142d-ba62-4c5d-8c54-377e00e21ea7",
"root_parent_id": "44e647fc-876e-4fa0-b0fa-4b9f477168c7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "62fef5cb-b424-4d72-b190-6d3da706271d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a27f78fe-9996-45f4-b676-03520b3f01de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5a16fa84-5a3c-49fa-9207-f874db02877a",
"_parent_code": "sample string 6",
"sales_organization_id": "6e5cf3d5-d9c8-4517-b7fd-7ffaf73e1077",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+00:00"
},
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00"
},
"equipment_model_id": "a0fd8385-a60d-4e5c-b0b6-b5939ebb6da1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3afa2af9-05e9-4517-a659-7770557ea0dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2bb395c1-af0c-4031-9601-7fa1c97c840b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d52cf317-6b98-4ed6-a7ee-46205a5a1205",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "47f33ac9-3716-4d1c-b867-92751d26271e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+00:00"
},
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00"
},
"equipment_family_id": "cac70c1a-4726-4280-91d9-cfd50bf7cdff",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a27f78fe-9996-45f4-b676-03520b3f01de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5a16fa84-5a3c-49fa-9207-f874db02877a",
"_parent_code": "sample string 6",
"sales_organization_id": "6e5cf3d5-d9c8-4517-b7fd-7ffaf73e1077",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+00:00"
},
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00"
},
"date_in_production_since": "2026-04-20T01:30:07.0329271+00:00",
"date_out_of_production_since": "2026-04-20T01:30:07.0329271+00:00",
"date_end_support": "2026-04-20T01:30:07.0329271+00:00",
"sales_organization_id": "8aa1fe93-adde-4242-a7c1-4c0a7cd574a0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+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-04-20T01:30:07.0329271+00:00"
},
"project_status_id": "89e4f6ac-a4eb-4c0c-ad72-ccfa24bc4d02",
"project_status_code": "sample string 10",
"project_status": {
"id": "245913a8-7d47-43ab-92f7-2510fbfe11f1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5e3c5a8f-64a8-4aa1-995f-744611f4d11f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00"
},
"company_id": "efce8461-9c88-43f2-ac0c-aebfd1b580e6",
"company_code": "sample string 12",
"db_address_id": "5d9d6122-a79e-4875-be02-2232da18e1bd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1b4482f6-2ba0-4cea-969c-b7b976f6bb64",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9ec93445-81d6-48b0-b284-7e91d7c1efe2",
"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-04-20T01:30:07.0329271+00:00",
"date_create": "2026-04-20T01:30:07.0329271+00:00",
"date_update": "2026-04-20T01:30:07.0329271+00:00",
"updated_by_user_id": "1e100e2a-76a7-4dd5-b665-34bc57e29389",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-20T01:30:07.0329271+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-04-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-20T01:30:07.0329271+00:00",
"date_last_job": "2026-04-20T01:30:07.0329271+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-20T01:30:07.0329271+00:00",
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00",
"is_mobile_installation": true
},
"job_type_id": "09a4ec09-95f8-4ef2-83bf-6b7b92ec9196",
"job_type_code": "sample string 7",
"job_type": {
"id": "dc34515f-1dbb-4dbd-b03e-1bf6a73b1fe9",
"name": "sample string 2",
"sales_organization_id": "396e2308-449f-40d5-bf95-133ec1bf7209",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00",
"code": "sample string 7"
},
"job_priority_id": "621841fb-a3a6-4e70-bd46-9c81adf5a625",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fa41692f-337c-4b9a-8acf-7720a97d337c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9b522a56-fa9f-4010-9c5f-6d23715185cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00"
},
"job_status_id": "5bc23950-b5f3-407c-af41-82f3fef2ca5a",
"job_status_code": "sample string 11",
"db_address_id": "a1869a28-8817-4064-810d-b8ba0f32d360",
"contact_id": "33cb8392-b6af-4417-9435-5702219f2529",
"requested_by_company_id": "d927575f-d97d-4373-a570-f24c826eb5cd",
"requested_by_contact_id": "b5c3da4b-4e1d-4704-ad3a-e4908c421a89",
"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-04-20T01:30:07.0329271+00:00",
"due_date": "2026-04-20T01:30:07.0329271+00:00",
"date_create": "2026-04-20T01:30:07.0329271+00:00",
"date_update": "2026-04-20T01:30:07.0329271+00:00",
"date_closed": "2026-04-20T01:30:07.0329271+00:00",
"suggested_user_id": "74497762-79b6-4798-8919-839a02c578ef",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c2b23705-4674-4a48-b6eb-cc42868fe88c",
"db_language_id": "5d59f7b8-4230-40ef-b64e-2e67bd0d135f",
"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-04-20T01:30:07.0329271+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a8abd4d8-5325-4701-b010-88854e58bd84",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "09a3faf3-e47c-4087-80a9-50081d5e5137",
"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": "be64acd8-408a-4e67-956c-29f948f655e3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6a9f11ae-7adc-46f5-8c04-31d00eb38c38"
},
"suggested_date_start": "2026-04-20T01:30:07.0329271+00:00",
"skill_id": "3d994d48-0e5c-4629-8ffc-968aa32d80f9",
"skill_code": "sample string 32",
"skill": {
"id": "ca0787cf-45ba-462f-80a8-923389c56b07",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "af783aa4-2fc2-44d9-9c94-ebfce02fa278",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f95fb504-956f-40c9-8ae8-8d08a858860b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1b8bb6-b029-49e6-9136-2f543a0c957f",
"db_currency_id": "7814bb10-5fee-47c6-b564-9d2769a1f156",
"db_language_id": "ef5f09b7-b3da-4542-8e41-bd0d6dcb7421",
"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-04-20T01:30:07.0173003+00:00"
},
"modified_dateutc": "2026-04-20T01:30:07.0329271+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "612ecf74-fb7a-4a25-b028-0b2b4068f333",
"date_reported_by_company": "2026-04-20T01:30:07.0329271+00:00",
"id2": 36,
"company_id": "415fcbee-1671-47c0-b77b-bf1c113bc76c",
"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": "c4c40b08-0efb-42f2-aa8f-d278031a8124",
"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-04-20T01:30:07.0329271+00:00"
},
"work_instruction_details_id": "28afbadd-ffa8-4211-aee7-5f893f86a685",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1da7c32b-72b6-4be2-9c7c-fde3e22be5ab",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e5fbc387-d7da-4250-bf5e-e9ce57944333",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-20T01:30:07.0485527+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": "55a8a706-67f6-4361-9383-ad72233e8378",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-20T01:30:07.0485527+00:00"
}