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": "15713d8c-01e1-4a90-9e46-fbba1f806b9f",
"jobs_id": "568fae72-f01c-4148-b141-25e2956554b0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5fc30e3a-f510-4719-a9da-b6e6556af846",
"_parent_id": "f0103732-764e-4d6d-ad4d-e7eb9abffab8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3be7b591-5f90-40cb-ba2e-627106a84620",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c9c911f5-be56-435a-acb7-0baaeb8d5e7a",
"_parent_id": "c3d3977e-ff86-4fab-ae99-6128bb69fa2b",
"root_parent_id": "0d2c243f-dd34-431d-b97d-f925e94703cf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4f759a3d-89b7-49fa-9745-6a45eded0fde",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1983a214-919c-426a-a38b-a39da5791f74",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c31e2ef-a325-453f-b898-cf664262c0f7",
"_parent_code": "sample string 6",
"sales_organization_id": "c1c34bdc-6369-41ac-a0d0-84ba41019ef2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+00:00"
},
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00"
},
"equipment_model_id": "101a97bd-e1c7-4ce9-a98f-8dd9af525052",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db582de2-0814-4fe8-8678-56ffeba1dc39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "51b80d1c-e934-40b4-a2b7-7de012dd4ec9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9296cd94-b413-4186-b10e-5a23606241c8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fc829e80-4e35-4bfe-9342-0c4c2df6d2be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+00:00"
},
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00"
},
"equipment_family_id": "d1b8c6b1-a67f-4b1c-adab-e5fe975bd0c2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1983a214-919c-426a-a38b-a39da5791f74",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c31e2ef-a325-453f-b898-cf664262c0f7",
"_parent_code": "sample string 6",
"sales_organization_id": "c1c34bdc-6369-41ac-a0d0-84ba41019ef2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+00:00"
},
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00"
},
"date_in_production_since": "2026-09-04T19:11:31.4637362+00:00",
"date_out_of_production_since": "2026-09-04T19:11:31.4637362+00:00",
"date_end_support": "2026-09-04T19:11:31.4637362+00:00",
"sales_organization_id": "0489ce6d-ca98-40b4-a699-8cfc205bd80b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+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-04T19:11:31.4637362+00:00"
},
"project_status_id": "d8f43a79-96f0-4436-b37b-3033f3031db9",
"project_status_code": "sample string 10",
"project_status": {
"id": "761c2c5a-c5f1-4c47-bab8-a15cb5df2818",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "179ef1bf-bb33-4d47-ac3f-6bbba71bb4e6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00"
},
"company_id": "9834c8f7-a1bf-4a24-8352-59d72d117838",
"company_code": "sample string 12",
"db_address_id": "a8995b33-9ed4-4c9f-a776-8eb6859b6197",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b84fd337-0b75-4260-8ece-0d0e650167d2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "05e93af0-23e6-494b-8a8a-556b72be6455",
"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-04T19:11:31.4637362+00:00",
"date_create": "2026-09-04T19:11:31.4637362+00:00",
"date_update": "2026-09-04T19:11:31.4637362+00:00",
"updated_by_user_id": "0e81a653-890d-406d-ae36-e36df7112db8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-04T19:11:31.4637362+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-04T19:11:31.4637362+00:00",
"date_last_job": "2026-09-04T19:11:31.4637362+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-04T19:11:31.4637362+00:00",
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00",
"is_mobile_installation": true
},
"job_type_id": "4f224388-95e3-4fa4-8fc7-c0d0eddb2e99",
"job_type_code": "sample string 7",
"job_type": {
"id": "e0ad82b1-c7f0-48da-a8ba-55a96f0013ef",
"name": "sample string 2",
"sales_organization_id": "771fa9c1-aefc-4913-8f05-c23fd4a8ec47",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00",
"code": "sample string 7"
},
"job_priority_id": "44ec10c5-04c3-4a82-82a7-4be321b9b32e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c18cb41b-fc6c-46b5-bbe3-08043003f2ae",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "81d56e3b-dfe5-4f82-832a-6a081a9b96d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00"
},
"job_status_id": "ce2677fe-3901-48eb-a227-2bcc9d84f992",
"job_status_code": "sample string 11",
"db_address_id": "464b4144-2276-4552-8f27-6a66798494e1",
"contact_id": "68a50b7f-838d-4b30-bc1c-d062974b1b31",
"requested_by_company_id": "13ccebe9-d09b-4b09-bf9e-e614893d77fa",
"requested_by_contact_id": "3ad163db-8500-4740-9289-6540141fbb5c",
"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-04T19:11:31.4637362+00:00",
"due_date": "2026-09-04T19:11:31.4637362+00:00",
"date_create": "2026-09-04T19:11:31.4637362+00:00",
"date_update": "2026-09-04T19:11:31.4637362+00:00",
"date_closed": "2026-09-04T19:11:31.4637362+00:00",
"suggested_user_id": "274a4f9a-fe4b-4e28-92f5-38ca77d9c980",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "69c5f8b9-af63-431c-b9b2-7a1816bed74a",
"db_language_id": "3b6fa2ec-3781-439d-a31c-02b7d05f717e",
"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-04T19:11:31.4637362+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b9343055-664f-4a36-9da5-67064d6b668d",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "77d18e65-f2b1-44e5-84c9-e5082dea1111",
"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": "521913c1-9657-4318-8885-c289df5c86a8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2cf4302a-087f-4923-8394-2563ad262af5"
},
"suggested_date_start": "2026-09-04T19:11:31.4637362+00:00",
"skill_id": "1fbe2b32-4de3-4091-92b7-24741947e5b6",
"skill_code": "sample string 32",
"skill": {
"id": "5f41a7f4-7ea7-4d26-95f3-a916a7e6d4f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "103898cd-db77-4124-81ee-eb9df4249373",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1218938-5bdc-4c5a-a444-52af856055c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed494065-f2bd-482a-aa57-950b76d59adc",
"db_currency_id": "23b345b7-c4cd-42db-9b33-71c53c0b161e",
"db_language_id": "fc66216d-2ce3-434f-8b04-bb3e6c1a89dc",
"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-04T19:11:31.4637362+00:00"
},
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5ffcb0fb-bd7c-4db6-8b5e-e61c8ece25ab",
"date_reported_by_company": "2026-09-04T19:11:31.4637362+00:00",
"id2": 36,
"company_id": "519fbdfb-e19a-4606-99ac-adb8dd3e4daf",
"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": "042175e5-aac5-4d07-b0a3-6e1ca5db388e",
"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-04T19:11:31.4637362+00:00"
},
"work_instruction_details_id": "168f6ed2-d274-4582-81af-f21742e52ea4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5eee330b-f593-4ad8-bde4-05c43ec7da0b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3c2b6fba-26f8-4c44-ad57-5feba000edf7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-04T19:11:31.4637362+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": "4273a270-4698-4a51-aa34-782a7b7dea8a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-04T19:11:31.4637362+00:00"
}