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": "ff32bb6d-9019-4f85-a5f4-b557d6c1c5e3",
"jobs_id": "b6dec3ab-d353-4079-8043-f8d308af4d85",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e901f8c4-0052-49cf-a76d-e9ecd9148184",
"_parent_id": "c598c057-d11d-41ca-8a45-e4a5b8315d85",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fea456d8-1a08-4cbe-a03f-e16a43265060",
"project_reference_back_office": "sample string 5",
"project": {
"id": "01841fc2-148c-45da-9751-35edf11a157b",
"_parent_id": "74fe299e-a605-4db4-b821-acc88592aaa7",
"root_parent_id": "33c674c2-682b-409a-ad9d-cff501e1d33c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9db6f8f8-cf54-4153-b021-f69a218cfeb2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "30030fd9-d33c-4b14-9ebd-825ff0e6b9aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "251cc0a8-f672-42e2-9cc4-076640a952a6",
"_parent_code": "sample string 6",
"sales_organization_id": "21ae16b7-dd1f-4d98-8ff1-c164a5a0f682",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+00:00"
},
"modified_dateutc": "2026-09-24T04:06:48.1738462+00:00"
},
"equipment_model_id": "9cd91c4c-1670-4015-9e42-ae70e6a2ce8d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c9be053-c70c-4e3e-baa1-2a3ad68fe3ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9638646c-24ad-4af1-8864-f384c005e119",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9cfdb88a-607b-4d50-923d-2d1de13c6a5e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ee1307c3-bea2-476f-9655-17ae8fa473f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+00:00"
},
"modified_dateutc": "2026-09-24T04:06:48.1738462+00:00"
},
"equipment_family_id": "c221a511-ba5b-41e4-b6f5-da2669ccb08c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "30030fd9-d33c-4b14-9ebd-825ff0e6b9aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "251cc0a8-f672-42e2-9cc4-076640a952a6",
"_parent_code": "sample string 6",
"sales_organization_id": "21ae16b7-dd1f-4d98-8ff1-c164a5a0f682",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+00:00"
},
"modified_dateutc": "2026-09-24T04:06:48.1738462+00:00"
},
"date_in_production_since": "2026-09-24T04:06:48.1738462+00:00",
"date_out_of_production_since": "2026-09-24T04:06:48.1738462+00:00",
"date_end_support": "2026-09-24T04:06:48.1738462+00:00",
"sales_organization_id": "27d4bb1c-c0f9-4f02-a7f7-cf89b7ebc16f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+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-09-24T04:06:48.1738462+00:00"
},
"project_status_id": "249cc750-1302-42eb-a586-5fd4bf0a8222",
"project_status_code": "sample string 10",
"project_status": {
"id": "3ce24143-870f-4e5e-9752-ef94b77b6126",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ffd47a16-21aa-48b8-8aec-d72ad9a89d15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-24T04:06:48.1738462+00:00"
},
"company_id": "76d8317e-2aec-4d92-96bc-3f245f99f982",
"company_code": "sample string 12",
"db_address_id": "613ef1ce-9c32-47d9-b79a-c9762f8faff1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9f167651-b1c2-49c1-9300-9f6ee22448ce",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "09e7d23d-a3be-4af5-a8dc-3c4c058a853f",
"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-09-24T04:06:48.1738462+00:00",
"date_create": "2026-09-24T04:06:48.1894686+00:00",
"date_update": "2026-09-24T04:06:48.1894686+00:00",
"updated_by_user_id": "9a0f9d0f-d855-4d4c-8b57-b4316bed3d76",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-24T04:06:48.1894686+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-09-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-24T04:06:48.1894686+00:00",
"date_last_job": "2026-09-24T04:06:48.1894686+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-24T04:06:48.1894686+00:00",
"modified_dateutc": "2026-09-24T04:06:48.1894686+00:00",
"is_mobile_installation": true
},
"job_type_id": "a0fbccf8-cf55-44d5-a674-5a64c39646c9",
"job_type_code": "sample string 7",
"job_type": {
"id": "14430420-ee12-4d61-a630-cf62546f99c5",
"name": "sample string 2",
"sales_organization_id": "d9e1c30a-6b7f-4471-86af-f718ca0ee953",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-24T04:06:48.1894686+00:00",
"code": "sample string 7"
},
"job_priority_id": "e2ab43a1-a861-4881-a2f0-97695afa4485",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6848b3ae-1006-4b37-82a1-b6f966e3f4f6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c08f632e-6e28-4328-b762-c0a22e7a561a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-24T04:06:48.1894686+00:00"
},
"job_status_id": "905fc08a-e481-49ff-97df-620547e50083",
"job_status_code": "sample string 11",
"db_address_id": "2c673b54-d2a9-4194-aa63-89a34ee66b07",
"contact_id": "a6487ae1-d399-4e0e-96ea-5df49fb2288a",
"requested_by_company_id": "98f1da30-6152-4a11-98ce-e86dc44078ca",
"requested_by_contact_id": "e7adf878-f30c-4ce6-889f-623ff97201be",
"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-09-24T04:06:48.1894686+00:00",
"due_date": "2026-09-24T04:06:48.1894686+00:00",
"date_create": "2026-09-24T04:06:48.1894686+00:00",
"date_update": "2026-09-24T04:06:48.1894686+00:00",
"date_closed": "2026-09-24T04:06:48.1894686+00:00",
"suggested_user_id": "c2de6be3-0fe1-428e-ba4a-76ffde8fbe13",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d4afa247-4758-4dd8-a10c-a45dd0b9da1b",
"db_language_id": "53bcc5a3-3887-4d70-ba0e-826d559896a3",
"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-09-24T04:06:48.1894686+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7c2d1df2-eebf-45c4-9ac6-4e6ea381c80b",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5e357e67-2503-41f6-91cf-6e3e3996fd1f",
"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": "d39f8976-657b-4c9f-8fc5-fc9507371ca5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-24T04:06:48.1894686+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "909f195c-9d35-422a-ab95-e65af78cf603"
},
"suggested_date_start": "2026-09-24T04:06:48.1894686+00:00",
"skill_id": "1f634767-9c12-429f-a807-032214874b49",
"skill_code": "sample string 32",
"skill": {
"id": "1e3d8c27-3117-4d36-b437-5dcf597f5b02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ae9fb4a5-25d0-4963-afe1-ea53bd0d09ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86f0b035-bf90-45f8-81d9-1b6cdf53e54b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7eab8aa-8d02-4f82-b276-5b1d177c4e88",
"db_currency_id": "8d28ce70-c6bd-4437-a33a-b2e1ebeba7a6",
"db_language_id": "0a08d178-be6e-4f80-a963-4165d7c1dc4d",
"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-09-24T04:06:48.1738462+00:00"
},
"modified_dateutc": "2026-09-24T04:06:48.1894686+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0852e377-116b-453d-a8fe-ed86b0f7013b",
"date_reported_by_company": "2026-09-24T04:06:48.1894686+00:00",
"id2": 36,
"company_id": "cb2d6632-1baf-4ed0-8b42-ff2b08dc2d2e",
"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": "33bc920c-e375-44d3-8ff8-2079aa66dd36",
"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-09-24T04:06:48.1894686+00:00"
},
"work_instruction_details_id": "c57fb944-dc5c-47b7-ab02-b5d79beb1949",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "959048ca-08c1-46c7-976a-cc772fa79e6b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1b51b4c6-dfd0-4916-8278-f0abf4f53e51",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-24T04:06:48.1894686+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": "3f0b0553-0194-478b-b48e-ab9006865d04",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-24T04:06:48.1894686+00:00"
}