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": "11aedba2-ee74-454b-a680-c3a365b07e88",
"jobs_id": "2aba59ca-22a8-4a0e-9e80-a800a90c5e16",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "15475587-0b0c-45a3-8b62-dd28227ff1fe",
"_parent_id": "a9e9779f-d1a0-4b09-ab37-99dfe0ae5d6f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d5ac1641-bccb-4849-9e5d-7d9dbb52656a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5ceb20b9-a813-4af0-80bd-35bd8adac17c",
"_parent_id": "87346dac-cbb7-468d-a210-6b04ea0b9db0",
"root_parent_id": "ce878263-098a-4d60-b41e-f1864ad0839f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "89bef01a-cff2-4631-9946-1a1d6faa9487",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "06311fb6-3f35-4011-8b97-e993fd36d5ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a82d8bb-77b0-4a4f-ae7e-db5d2c4a4b43",
"_parent_code": "sample string 6",
"sales_organization_id": "dae57f17-1ea2-4dfc-af36-287c2e12c956",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+00:00"
},
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00"
},
"equipment_model_id": "5a185bb7-c7f6-4e74-9113-fb54d3c0787e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "23d41752-86d0-4b30-acd2-93993cbee38c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "22cd880d-7d6f-4d09-a5de-51d94d0612a2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d04f8cd3-17cd-4797-a5df-11817812f588",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c0dfcfc7-d66e-4812-ad89-2e04515dae14",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+00:00"
},
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00"
},
"equipment_family_id": "db826d25-71aa-4d5b-9496-fbf7e1d2fc13",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "06311fb6-3f35-4011-8b97-e993fd36d5ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a82d8bb-77b0-4a4f-ae7e-db5d2c4a4b43",
"_parent_code": "sample string 6",
"sales_organization_id": "dae57f17-1ea2-4dfc-af36-287c2e12c956",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+00:00"
},
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00"
},
"date_in_production_since": "2026-01-22T18:43:01.1107982+00:00",
"date_out_of_production_since": "2026-01-22T18:43:01.1107982+00:00",
"date_end_support": "2026-01-22T18:43:01.1107982+00:00",
"sales_organization_id": "b1c940eb-2f2c-458b-896d-e9fb0747b0fd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+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-01-22T18:43:01.1107982+00:00"
},
"project_status_id": "411b9763-866e-476b-8680-016471a972bb",
"project_status_code": "sample string 10",
"project_status": {
"id": "89ceaadb-76f0-49e6-9ef4-42212bbfda09",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "df621224-327e-416a-8b37-b48d627d60d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00"
},
"company_id": "529553d9-c342-4a79-88da-810587551ee1",
"company_code": "sample string 12",
"db_address_id": "31c58daf-81cc-4fe8-9b9b-d002cc69d7a5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2a85f946-917f-4f40-a720-63f6246afe79",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "47d01c37-64c8-457e-ac29-1a862a9ab46f",
"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-01-22T18:43:01.1107982+00:00",
"date_create": "2026-01-22T18:43:01.1107982+00:00",
"date_update": "2026-01-22T18:43:01.1107982+00:00",
"updated_by_user_id": "d58bd6e4-1559-4107-a8a7-16c5c9614d45",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-22T18:43:01.1107982+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-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-22T18:43:01.1107982+00:00",
"date_last_job": "2026-01-22T18:43:01.1107982+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-22T18:43:01.1107982+00:00",
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00",
"is_mobile_installation": true
},
"job_type_id": "2ae26e66-4bf0-44e8-a233-cca1aa85002e",
"job_type_code": "sample string 7",
"job_type": {
"id": "c3be6478-6a30-44b4-ad3b-c8be06861213",
"name": "sample string 2",
"sales_organization_id": "29c859d0-43f9-4b58-918a-64f1e2d5f6c6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00",
"code": "sample string 7"
},
"job_priority_id": "b76c2bc5-3160-4996-9d2b-ee41e423c9e8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "25e10186-4d8e-423f-9cc4-4e2b8ea43d7d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e4ca1227-3d47-45d2-b7e3-48a59f487966",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00"
},
"job_status_id": "007bd33c-a9eb-41f3-b154-7457e3daf132",
"job_status_code": "sample string 11",
"db_address_id": "7a5ba87f-5921-4642-bcd6-92145246d148",
"contact_id": "3ff2ec96-40a7-48dd-a007-fb3bd1525b99",
"requested_by_company_id": "22bd6230-bf77-47d0-9945-31c5a79ae6d4",
"requested_by_contact_id": "6333bfd7-13e0-4a8d-a828-23e1cee8cf6b",
"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-01-22T18:43:01.1107982+00:00",
"due_date": "2026-01-22T18:43:01.1107982+00:00",
"date_create": "2026-01-22T18:43:01.1107982+00:00",
"date_update": "2026-01-22T18:43:01.1107982+00:00",
"date_closed": "2026-01-22T18:43:01.1107982+00:00",
"suggested_user_id": "0bea3033-ce49-4064-acc2-e3a333d8127a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "313dcc0e-5510-48cd-bde0-2c26912090a4",
"db_language_id": "8321c6cd-093b-43c0-9702-c1d832838733",
"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-01-22T18:43:01.1107982+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c493e28d-8a7e-45b6-8b55-0952428afe67",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4661c9b5-de9c-41f4-b4f4-b36cd1e145d4",
"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": "91a3faec-2ea8-4ec2-bfd9-e76802531d61",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0ca37f2e-2f02-42d5-b30c-432778577cbd"
},
"suggested_date_start": "2026-01-22T18:43:01.1107982+00:00",
"skill_id": "88c0a618-e42a-450f-931e-14448c80f21a",
"skill_code": "sample string 32",
"skill": {
"id": "efd1d3fb-b5d3-465b-80fc-1400dec8b64a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "72663a45-5c07-4e0c-9321-7b3982727124",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c80f14d-b7b3-4e57-be1d-10c2e6468a86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eecf606-5881-4a8f-8c79-b9ad20ab1c66",
"db_currency_id": "0e4c707c-0a23-4080-a75b-316f6c1bc8c3",
"db_language_id": "585e3720-af02-45cd-a776-69abf4738f14",
"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-01-22T18:43:01.1107982+00:00"
},
"modified_dateutc": "2026-01-22T18:43:01.1107982+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e67a4912-1aa2-4419-b6f7-76046518d4f4",
"date_reported_by_company": "2026-01-22T18:43:01.1107982+00:00",
"id2": 36,
"company_id": "3c93f25e-5a97-45aa-9082-b1c3e468fc78",
"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": "056b3f6d-ad80-4ce6-9996-e445a8dbd537",
"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-01-22T18:43:01.1107982+00:00"
},
"work_instruction_details_id": "6e9193e8-1e69-4f9b-83ab-5aefea552528",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b3ff1ad5-a095-4fc5-8f1a-2df1a0a6d2ba",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a259532a-b235-451e-bc4f-c3ff68e43a5a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-22T18:43:01.1107982+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": "37246a8d-7506-4082-81da-add987bbd4b9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-22T18:43:01.1420436+00:00"
}