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": "c6702b4f-2aec-43ef-b95a-615d9be6158a",
"jobs_id": "2f601548-d0f8-454a-8150-f0ecb567728c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e8e1136d-5046-43b8-9dd0-d93abd738de8",
"_parent_id": "2f7fb2b2-447c-49e3-8d52-9a03c4b345c5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6da2af17-a63f-40c5-bbe2-1b0a39296d8c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "37dce814-474b-40e6-ab9e-e1b7a40006c4",
"_parent_id": "90dd2059-0433-4080-99cc-46764d71a582",
"root_parent_id": "c0cfc70a-77f3-471c-a055-58080741504d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "10b07e97-aec7-41e8-9eda-4860498f2f73",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "95fa8a31-26ed-442e-8858-00e4110ce46a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "93096a30-a1a4-493d-9304-1294bea33fd8",
"_parent_code": "sample string 6",
"sales_organization_id": "68c37338-5b80-487f-9f69-70e49fe087d6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+00:00"
},
"modified_dateutc": "2026-01-05T01:42:10.3354288+00:00"
},
"equipment_model_id": "a8b8c3f2-808a-4b82-a89d-9b38a06a4f71",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5f8f3322-aa2e-475f-b660-d1ff90a29a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "abe90f40-278b-4d79-bfeb-df00487d78d4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2f04e7fa-8e0b-4ead-b12c-4e68bd408ff4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "02bde583-cf1b-4855-8b6c-9b1ccf7eb21a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+00:00"
},
"modified_dateutc": "2026-01-05T01:42:10.3354288+00:00"
},
"equipment_family_id": "e74dd07b-f8d1-403f-af9f-5a217d72e480",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "95fa8a31-26ed-442e-8858-00e4110ce46a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "93096a30-a1a4-493d-9304-1294bea33fd8",
"_parent_code": "sample string 6",
"sales_organization_id": "68c37338-5b80-487f-9f69-70e49fe087d6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+00:00"
},
"modified_dateutc": "2026-01-05T01:42:10.3354288+00:00"
},
"date_in_production_since": "2026-01-05T01:42:10.3354288+00:00",
"date_out_of_production_since": "2026-01-05T01:42:10.3354288+00:00",
"date_end_support": "2026-01-05T01:42:10.3354288+00:00",
"sales_organization_id": "549fecf4-0a15-410e-9847-a5bfd3403b79",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+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-05T01:42:10.3354288+00:00"
},
"project_status_id": "9299e978-2138-4a4a-8c55-ce5be0e93080",
"project_status_code": "sample string 10",
"project_status": {
"id": "fa9a7d6b-ae2f-4b1b-ab15-7eea3ed01c5f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f18745d1-aad9-4254-a382-212e96985e8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T01:42:10.3354288+00:00"
},
"company_id": "cb1c291c-f1a4-48ad-8a93-6c70ed3949f7",
"company_code": "sample string 12",
"db_address_id": "eb2b2503-633c-4d93-83dd-4066274b360f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5b953900-b3d6-4663-949f-5ac4942adc15",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "479063b4-3cd3-4ec0-8456-ae5a4f1baf53",
"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-05T01:42:10.3354288+00:00",
"date_create": "2026-01-05T01:42:10.3354288+00:00",
"date_update": "2026-01-05T01:42:10.3354288+00:00",
"updated_by_user_id": "bae2f35c-1c85-41d1-a6c6-38f1506d5cca",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-05T01:42:10.3354288+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-05T01:42:10.3354288+00:00",
"date_last_job": "2026-01-05T01:42:10.3354288+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-05T01:42:10.3354288+00:00",
"modified_dateutc": "2026-01-05T01:42:10.3354288+00:00",
"is_mobile_installation": true
},
"job_type_id": "a9af6b0f-973f-405f-bfba-49e3ae22fdb8",
"job_type_code": "sample string 7",
"job_type": {
"id": "762eac23-5b09-417d-a106-44ae4cc5ec40",
"name": "sample string 2",
"sales_organization_id": "24c3adb1-350b-411b-bfbd-f395d0350c5c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-05T01:42:10.3354288+00:00",
"code": "sample string 7"
},
"job_priority_id": "b9ccfd76-0ff8-41fb-b45b-b71bb6979757",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "79046745-ee39-4636-bf66-e48b197150c2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "17574c3c-fe54-4be8-ad5c-fb0eb8673c52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T01:42:10.3510579+00:00"
},
"job_status_id": "f2107c76-4d75-4f0b-99a6-bfa910a37eec",
"job_status_code": "sample string 11",
"db_address_id": "0c4cec7c-45c3-42d8-b8b3-dbcaf4450cfc",
"contact_id": "2be6e5fd-5053-406c-8b97-dbf4d326a160",
"requested_by_company_id": "c23b695b-377d-40e0-bc10-58707edb39b8",
"requested_by_contact_id": "3a8fe020-c299-464e-abbe-d655d9535fc4",
"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-05T01:42:10.3510579+00:00",
"due_date": "2026-01-05T01:42:10.3510579+00:00",
"date_create": "2026-01-05T01:42:10.3510579+00:00",
"date_update": "2026-01-05T01:42:10.3510579+00:00",
"date_closed": "2026-01-05T01:42:10.3510579+00:00",
"suggested_user_id": "692d343b-5c62-4214-bab5-601d010b06c7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ba815df8-aaa1-4eee-ad8e-d79d5f5f298e",
"db_language_id": "b00be8d0-f630-424d-9278-fa256b342089",
"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-05T01:42:10.3510579+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "491cde54-7163-4fc2-a095-936b5163141f",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6fa7c9f4-7baf-4694-a492-4210457451d0",
"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": "53383195-18f1-4186-8da4-795ad59181c5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-05T01:42:10.3510579+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "31b74086-9bc4-420a-875f-8ac5147194ce"
},
"suggested_date_start": "2026-01-05T01:42:10.3510579+00:00",
"skill_id": "1fa72528-a6d2-4dfc-8f26-4c4d6a81254f",
"skill_code": "sample string 32",
"skill": {
"id": "c9e08fd8-dc04-4148-888a-35475c663124",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "552c028f-09e9-4568-a57f-905eca292083",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c13993ed-f864-4c83-9bea-9d23df39995b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0e5b3-4d96-4efb-9b72-669e530867f3",
"db_currency_id": "9fa479e2-705b-4c0d-8597-aa6d59c233f8",
"db_language_id": "cb3353c1-0d55-4cc6-b202-8d4b769da9fe",
"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-05T01:42:10.3354288+00:00"
},
"modified_dateutc": "2026-01-05T01:42:10.3510579+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c103dbe-ce4e-48ee-9f93-51eb3e9b128c",
"date_reported_by_company": "2026-01-05T01:42:10.3510579+00:00",
"id2": 36,
"company_id": "2e0c31b1-702b-467d-be33-292edf6d80d7",
"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": "630d5a6f-0ada-4d70-aea3-fcb5f3e1fd69",
"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-05T01:42:10.3510579+00:00"
},
"work_instruction_details_id": "8cb567ba-30e5-4233-84cd-302e4e4a150c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "40ecafba-69eb-4a16-ac98-959ea85e96b6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f0919191-bd17-4d27-bf02-95bc950198ca",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-05T01:42:10.3510579+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": "b5bc8420-5906-4206-a5fc-4ec4d54f448e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-05T01:42:10.3510579+00:00"
}