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": "0d67d127-31c7-4b11-acf3-265725c908b5",
"jobs_id": "e879204e-3704-45ae-aa78-7226157552c7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2980b200-896a-4d3f-aa56-165d713f7392",
"_parent_id": "9bfbef27-8e01-4f69-b82f-3d7b56b2216b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c48ac285-a2b5-4695-9a1e-98ad488ca8ed",
"project_reference_back_office": "sample string 5",
"project": {
"id": "74a05e87-ea20-45d0-b9fe-803415fac5ac",
"_parent_id": "d8e3436c-f4a6-4e54-a1dd-714b82a6103f",
"root_parent_id": "a95f23ea-e185-49dd-99c7-a513db9d8bb4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "21bae119-f15b-4d0a-82ab-8f3d5c30a691",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "af20a6b3-fc63-42de-814c-fa24314bac44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dd397074-5170-48af-a71e-9a1ae1b3c70f",
"_parent_code": "sample string 6",
"sales_organization_id": "170f6b3d-9019-497c-a41a-79d1e0862a4d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+00:00"
},
"modified_dateutc": "2026-01-27T08:17:34.1780773+00:00"
},
"equipment_model_id": "a075385e-e9f4-4525-b31c-3e6d4bf71349",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "89e95c28-59d4-400a-a0b1-5a74205b889c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8ddb6f44-f5a0-4b41-93e5-d2fd0c83fecb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "74855416-7379-4c0e-8260-3140f8f04f64",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4c5c98fc-d93a-4783-a0d3-01bda6b93a1e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+00:00"
},
"modified_dateutc": "2026-01-27T08:17:34.1780773+00:00"
},
"equipment_family_id": "17efb29f-9eb9-4beb-9963-a01d3fac78dd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "af20a6b3-fc63-42de-814c-fa24314bac44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dd397074-5170-48af-a71e-9a1ae1b3c70f",
"_parent_code": "sample string 6",
"sales_organization_id": "170f6b3d-9019-497c-a41a-79d1e0862a4d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+00:00"
},
"modified_dateutc": "2026-01-27T08:17:34.1780773+00:00"
},
"date_in_production_since": "2026-01-27T08:17:34.1780773+00:00",
"date_out_of_production_since": "2026-01-27T08:17:34.1780773+00:00",
"date_end_support": "2026-01-27T08:17:34.1780773+00:00",
"sales_organization_id": "272ec0e8-c24e-4471-9b8b-c60007aa0f0c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+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-27T08:17:34.1780773+00:00"
},
"project_status_id": "d42c07e0-c94b-4ff4-b440-a68d790247bd",
"project_status_code": "sample string 10",
"project_status": {
"id": "2de263d2-e541-4071-8d7a-4c0bbbdff457",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e873855c-1b67-4dac-b8e9-c1937735f60f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-27T08:17:34.1936929+00:00"
},
"company_id": "36abddb1-1b9c-47b9-912e-e12caaf29aba",
"company_code": "sample string 12",
"db_address_id": "ade27dde-49f8-47f3-b7d3-6a465b03fe0b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3e5cd97e-06fa-4f1a-bf42-69f677cdd29b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "65daa43d-e6c6-4e7d-84cc-f7458e3c3ccd",
"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-27T08:17:34.1936929+00:00",
"date_create": "2026-01-27T08:17:34.1936929+00:00",
"date_update": "2026-01-27T08:17:34.1936929+00:00",
"updated_by_user_id": "02b925cf-6e21-4141-aaf0-cbcffa8ed718",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-27T08:17:34.1936929+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-27T08:17:34.1936929+00:00",
"date_last_job": "2026-01-27T08:17:34.1936929+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-27T08:17:34.1936929+00:00",
"modified_dateutc": "2026-01-27T08:17:34.1936929+00:00",
"is_mobile_installation": true
},
"job_type_id": "46c3c51e-7396-4d39-bd6f-5c7a85448660",
"job_type_code": "sample string 7",
"job_type": {
"id": "0159e911-7f44-4fe9-82c8-d4b29241ab1c",
"name": "sample string 2",
"sales_organization_id": "4106dfe3-d4c1-480b-875b-c1bc676b7831",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-27T08:17:34.1936929+00:00",
"code": "sample string 7"
},
"job_priority_id": "c55b89b7-723b-40c1-a3fc-315720d3d6ab",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6b21ca21-5424-4387-be88-b3077e4d5157",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1eff357c-f78f-481a-afe7-d81cd2c5228e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-27T08:17:34.1936929+00:00"
},
"job_status_id": "fd889e4e-f133-4ef7-85a3-c74a3fa8c566",
"job_status_code": "sample string 11",
"db_address_id": "c368c584-2302-418d-b2c8-877dff9c0fd6",
"contact_id": "0d798f31-c063-43ee-a776-35006f49638b",
"requested_by_company_id": "37d498d9-4b99-4308-b634-094815b47cce",
"requested_by_contact_id": "f0293de2-c5e5-49aa-9ea4-78a543ef1cc7",
"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-27T08:17:34.1936929+00:00",
"due_date": "2026-01-27T08:17:34.1936929+00:00",
"date_create": "2026-01-27T08:17:34.1936929+00:00",
"date_update": "2026-01-27T08:17:34.1936929+00:00",
"date_closed": "2026-01-27T08:17:34.1936929+00:00",
"suggested_user_id": "60910aa0-30fc-40b5-8db9-4c58b36ca5a5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5aa8f5d7-3377-4226-b4ba-ff0585851443",
"db_language_id": "bba41d0c-805d-4ceb-9314-c5ffef6b5e8a",
"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-27T08:17:34.1936929+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04965974-ec57-4794-9f90-4b84ebb40d6e",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f11a348c-71dd-4bb6-afa9-f8ed3e4f894d",
"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": "045198a0-7208-41ee-8e32-8e14ba85be5f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-27T08:17:34.1936929+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aab57e5c-1263-4105-aed8-75079e9c9dbc"
},
"suggested_date_start": "2026-01-27T08:17:34.1936929+00:00",
"skill_id": "bf2127af-40cb-443d-b279-4174edb36def",
"skill_code": "sample string 32",
"skill": {
"id": "d840e359-47b8-426e-be24-b63f49e1bd9e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5c6b599d-98d7-4c71-8b79-fee804e87d12",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "80c6cbf1-bc66-4246-91d1-884581b25873",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0d4a81a-ffff-4679-82c6-b6305300e9f3",
"db_currency_id": "cb6116e7-f3e9-4c64-bf0d-c719c78998f8",
"db_language_id": "b155eaf5-8ed5-49f1-a662-ca1db4a6827c",
"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-27T08:17:34.1780773+00:00"
},
"modified_dateutc": "2026-01-27T08:17:34.1936929+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cad9f627-b0bc-4908-8396-c16dbf241c0a",
"date_reported_by_company": "2026-01-27T08:17:34.1936929+00:00",
"id2": 36,
"company_id": "8fc7ff7f-ad3c-434c-8d71-4adc9fa92dc5",
"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": "42837b60-0c62-42dc-be2c-ec641bf05402",
"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-27T08:17:34.1936929+00:00"
},
"work_instruction_details_id": "d3c1d8f8-4b87-43b5-a952-fad5b0552f4c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5d13678d-8bee-47aa-8e3c-94f3ced40f00",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8df8f19a-4cc8-4e65-b72b-6fab51a7b8bd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-27T08:17:34.1936929+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": "03c5b155-164b-4640-9df3-22b4301340bd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-27T08:17:34.1936929+00:00"
}