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": "77a14ab3-40ca-4534-814c-8856c7c1be30",
"jobs_id": "73410063-a7e9-497a-832e-717a21444c85",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c317913c-70ba-4e2b-8568-ff176e12228c",
"_parent_id": "02c9e9e2-47b8-4ff8-bea3-b8c7ce7ea72f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf35ebcd-7d88-4a13-8a6f-4d599faa9ce1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "05c0b763-b6ac-427c-b603-69fe56a5e1de",
"_parent_id": "1ab05f11-c031-42d9-b88c-d84d2b14d097",
"root_parent_id": "774f49ae-bdb0-4d32-abd6-a1b6a13f223c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dd6d4f74-d618-4aa7-aa8e-005d5cc8c9d5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "915198cb-39c9-4a31-b452-8f795bf63e82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "15ce4e81-cf9d-4429-805e-de6f0a0db6c6",
"_parent_code": "sample string 6",
"sales_organization_id": "33ab742b-7d37-4d3c-b40b-9785c2e58bf3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+00:00"
},
"modified_dateutc": "2026-09-30T07:04:44.1763591+00:00"
},
"equipment_model_id": "04275e4d-6df3-44b6-b97c-9bda19f37797",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "18e052f7-97eb-44da-82e3-b27c5a127859",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "98e24ddf-6818-4bd2-8c5c-e9268bdabed4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eadda371-cb25-469e-8deb-ee2b127ee5e0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aadd3bf8-4738-4f85-b01e-f0fef9f3455e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+00:00"
},
"modified_dateutc": "2026-09-30T07:04:44.1763591+00:00"
},
"equipment_family_id": "46f72b0b-8c1f-4ecc-bab5-74a698e352b2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "915198cb-39c9-4a31-b452-8f795bf63e82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "15ce4e81-cf9d-4429-805e-de6f0a0db6c6",
"_parent_code": "sample string 6",
"sales_organization_id": "33ab742b-7d37-4d3c-b40b-9785c2e58bf3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+00:00"
},
"modified_dateutc": "2026-09-30T07:04:44.1763591+00:00"
},
"date_in_production_since": "2026-09-30T07:04:44.1763591+00:00",
"date_out_of_production_since": "2026-09-30T07:04:44.1763591+00:00",
"date_end_support": "2026-09-30T07:04:44.1763591+00:00",
"sales_organization_id": "f8858f7b-054a-41ea-a13e-454aca9d9d5c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+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-30T07:04:44.1763591+00:00"
},
"project_status_id": "f2caa74d-7379-4b57-b57e-6419336e01d8",
"project_status_code": "sample string 10",
"project_status": {
"id": "8bfb7fc5-7769-420a-adba-56efa39c9e84",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "712e86c8-aef6-4354-a069-90ba53ee7ce0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T07:04:44.1763591+00:00"
},
"company_id": "765d63bb-c584-4fc3-8da5-86738ddabd6d",
"company_code": "sample string 12",
"db_address_id": "f32a3e31-b259-49ec-aa2b-d19fa049a6d2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1c245874-7e29-4c56-a803-177c949e27e8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "887a4e56-552a-4279-acd3-fce93f076f59",
"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-30T07:04:44.1919839+00:00",
"date_create": "2026-09-30T07:04:44.1919839+00:00",
"date_update": "2026-09-30T07:04:44.1919839+00:00",
"updated_by_user_id": "79779852-b2b5-4bcf-91ad-730903dfdbe0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T07:04:44.1919839+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T07:04:44.1919839+00:00",
"date_last_job": "2026-09-30T07:04:44.1919839+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T07:04:44.1919839+00:00",
"modified_dateutc": "2026-09-30T07:04:44.1919839+00:00",
"is_mobile_installation": true
},
"job_type_id": "7382784f-1ebf-43c5-9796-279b3e1afe58",
"job_type_code": "sample string 7",
"job_type": {
"id": "665406d4-17f9-4cca-bb0d-7453dc70568f",
"name": "sample string 2",
"sales_organization_id": "2f248f99-b00c-4bab-9d65-ca8e98458bf9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T07:04:44.1919839+00:00",
"code": "sample string 7"
},
"job_priority_id": "dc7fe0a6-dbad-40ff-9fda-66c279179f35",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ae2b1709-1202-4bc0-bb5f-f19cb9b36948",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "45f5e22e-3040-46c5-bf9e-0d48a61f7d94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T07:04:44.1919839+00:00"
},
"job_status_id": "56f5fb02-ef2d-448c-9e39-a0f1228d83d5",
"job_status_code": "sample string 11",
"db_address_id": "c5aa496c-460f-4700-bea2-a082d0aa351f",
"contact_id": "f8cf689f-d493-4321-a5a6-0d2a74cc5da4",
"requested_by_company_id": "726a2207-c625-491c-85bb-c7f58d3b473b",
"requested_by_contact_id": "e491f1b1-4d29-4ba3-b44e-cdd700a0d992",
"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-30T07:04:44.1919839+00:00",
"due_date": "2026-09-30T07:04:44.1919839+00:00",
"date_create": "2026-09-30T07:04:44.1919839+00:00",
"date_update": "2026-09-30T07:04:44.1919839+00:00",
"date_closed": "2026-09-30T07:04:44.1919839+00:00",
"suggested_user_id": "275ba498-d91e-4e07-9abc-b15b9e75551e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4add5251-d71a-47c2-918f-d13a67e44560",
"db_language_id": "44f2c9c6-9f76-4f12-a6e7-2991d5f0c0f3",
"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-30T07:04:44.1919839+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5407a447-d8ed-4732-910a-5a5197132539",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "175447b8-d9a0-4236-a8b9-924e5d4f47d1",
"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": "01642b77-e86b-498d-a9d8-c8d1f6d2b591",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T07:04:44.1919839+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "472d41bc-cf0a-4a06-b166-932a1f640baa"
},
"suggested_date_start": "2026-09-30T07:04:44.1919839+00:00",
"skill_id": "eb875286-d8e3-4328-8f7c-b02d19d0c005",
"skill_code": "sample string 32",
"skill": {
"id": "7699e682-c199-484b-bd20-c6fc5dbd6135",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ed87e21e-d2b5-4e07-b2d2-bd422ae0ce27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b736eada-742e-4eeb-8d71-4984205cee71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "915e581f-8eba-47b9-a96c-1cb62047d6d5",
"db_currency_id": "4d335665-66f7-4dab-aff5-1cd182b9969a",
"db_language_id": "5a0dc987-c61f-4e4a-9261-31643de2db5e",
"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-30T07:04:44.1763591+00:00"
},
"modified_dateutc": "2026-09-30T07:04:44.1919839+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "25c55661-57f7-411d-b98a-0d796a5cbadc",
"date_reported_by_company": "2026-09-30T07:04:44.1919839+00:00",
"id2": 36,
"company_id": "0b6bd3bf-4cbb-4cc1-a15c-2f1cafff3314",
"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": "8b1882d1-f175-4472-b80f-e944f3af3423",
"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-30T07:04:44.1919839+00:00"
},
"work_instruction_details_id": "a8865762-64b8-4170-b710-d4b01cd0f577",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "172e8e47-ab35-45df-b4a1-d9a9f0b541ec",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dcdcb03f-41ff-403c-bd58-e666a8c28c9a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T07:04:44.1919839+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": "fdc338b7-3902-4e48-a26a-cb487aea4b37",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T07:04:44.1919839+00:00"
}