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": "37065b9f-775d-4419-9ddd-476fafda1300",
"jobs_id": "9318cdf1-6f73-4547-948d-70fd72afd64c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d4e16436-bb50-4c4e-822f-c88f3da03322",
"_parent_id": "dd892d98-a545-4d45-adc3-89dada252760",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e2185e7d-eaf5-4f85-a8e9-d37482e631d1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8a24c148-e93c-4920-862a-b28c1357cca3",
"_parent_id": "85c26d22-fbe6-4f7d-ad85-7788e48fbf17",
"root_parent_id": "968b16ae-a059-4475-b602-cfc1356f9d1c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a14622a4-00f8-4e33-afc5-b5b27b35b61b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4ce90b9c-76fe-4697-81a9-721c491dac35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7dc1af12-4efb-4323-b505-ff8de6a03138",
"_parent_code": "sample string 6",
"sales_organization_id": "4b515c72-70b6-457f-b3c6-75726a8b15c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+00:00"
},
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00"
},
"equipment_model_id": "d37885fa-644b-4872-884c-7189cbe7a4dc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "068fbb02-801f-455f-85a1-9a2a27034a33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9d90179f-f566-4eb0-ab25-a7dd89b6650a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ea4e4a0d-61af-42c8-972e-a4d18c15f85a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "85052cc8-d13a-4664-82a5-eb125984f796",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+00:00"
},
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00"
},
"equipment_family_id": "b72430da-e77b-4b8d-82b5-3bb0e76852a1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4ce90b9c-76fe-4697-81a9-721c491dac35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7dc1af12-4efb-4323-b505-ff8de6a03138",
"_parent_code": "sample string 6",
"sales_organization_id": "4b515c72-70b6-457f-b3c6-75726a8b15c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+00:00"
},
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00"
},
"date_in_production_since": "2026-09-05T17:21:41.0474937+00:00",
"date_out_of_production_since": "2026-09-05T17:21:41.0474937+00:00",
"date_end_support": "2026-09-05T17:21:41.0474937+00:00",
"sales_organization_id": "47240eec-cce7-430a-af28-b64e727232f3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+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-05T17:21:41.0474937+00:00"
},
"project_status_id": "d0bfa5ef-5b5e-44ce-b46f-f5b96a559e5b",
"project_status_code": "sample string 10",
"project_status": {
"id": "8f2b25dd-a5c6-4410-ac1a-1d7412695a17",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7a0ee0b2-c885-4446-a5c7-982b304266b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00"
},
"company_id": "32db6fb3-ef9d-4622-b903-c8a337d32a30",
"company_code": "sample string 12",
"db_address_id": "cf12d221-26fd-4c8b-948a-c43690a1eddb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ea918737-830d-4dbc-96ff-f37c71f4b7bd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ff37edb6-69ed-4b2d-9ec5-793b0888484c",
"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-05T17:21:41.0474937+00:00",
"date_create": "2026-09-05T17:21:41.0474937+00:00",
"date_update": "2026-09-05T17:21:41.0474937+00:00",
"updated_by_user_id": "31fa4434-68e8-45b0-affa-e6a9a594789b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-05T17:21:41.0474937+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-05T17:21:41.0474937+00:00",
"date_last_job": "2026-09-05T17:21:41.0474937+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-05T17:21:41.0474937+00:00",
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00",
"is_mobile_installation": true
},
"job_type_id": "f633d9b8-718c-440e-94ef-f21d8ef756b3",
"job_type_code": "sample string 7",
"job_type": {
"id": "48f299b0-b0ed-4ceb-bf0f-ddffacd45a6d",
"name": "sample string 2",
"sales_organization_id": "19300ba7-f938-402e-8cf0-fed1d0bedc54",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00",
"code": "sample string 7"
},
"job_priority_id": "0fa1386a-107f-473d-993e-73f3469d573f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "15d4ff13-754e-42cd-a1d1-edc84e79c2ac",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4617f5d6-c182-45b3-a990-2af9e682a286",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00"
},
"job_status_id": "c5854984-ecbb-4100-9354-921048fee707",
"job_status_code": "sample string 11",
"db_address_id": "7782953a-e19e-43a4-88d4-6d824af43a67",
"contact_id": "b6736b99-8b09-4e06-b98c-cbee57f7d8c6",
"requested_by_company_id": "037a8aad-c0bf-40e9-b393-75c23176ec87",
"requested_by_contact_id": "d7c9c4a7-2e53-4916-8e93-e8d596460ba8",
"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-05T17:21:41.0474937+00:00",
"due_date": "2026-09-05T17:21:41.0474937+00:00",
"date_create": "2026-09-05T17:21:41.0474937+00:00",
"date_update": "2026-09-05T17:21:41.0474937+00:00",
"date_closed": "2026-09-05T17:21:41.0474937+00:00",
"suggested_user_id": "e88dd886-832b-4ecb-8cbe-6fc69a375373",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "98bc8e44-4e7a-4842-afc8-81135d50abde",
"db_language_id": "7fa0d11d-8eef-4d13-a1e8-671a6d5b9f5d",
"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-05T17:21:41.0474937+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "45331796-b21b-4fec-8efb-4f1ece142679",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9f556c1a-0606-4a62-81a0-e31191b25fad",
"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": "5c9222ea-47ff-428c-b5e7-ba3cf36abbbd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "90ac36bc-2e17-4fbd-a256-e7609116db42"
},
"suggested_date_start": "2026-09-05T17:21:41.0474937+00:00",
"skill_id": "0f872523-469d-4247-8900-84c1e13d812a",
"skill_code": "sample string 32",
"skill": {
"id": "152b5b83-9ce3-4229-aa47-d8b4526cd874",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0beae3ee-6c65-49fd-bdab-86199fdd7ee2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2ba8ca4-94b1-408d-9783-9e84b5252ed4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ae75912-81f4-46e6-beaa-9a24ea5abdf9",
"db_currency_id": "e3935908-56c1-44d7-8f1f-e02b3378a49e",
"db_language_id": "d52f892c-c7c8-45a5-aa0e-9ff90ce6696f",
"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-05T17:21:41.0474937+00:00"
},
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "44a9886b-fd52-4536-b110-208321b959cd",
"date_reported_by_company": "2026-09-05T17:21:41.0474937+00:00",
"id2": 36,
"company_id": "6bcb0eab-d99f-4398-8fbb-7329e0febdf4",
"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": "73b74c65-8869-4f43-ae24-3a9826a6c36c",
"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-05T17:21:41.0474937+00:00"
},
"work_instruction_details_id": "8950bf64-6b00-4405-ad93-4d187a65b1b3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d0d5ad85-25de-49e6-8600-45208861325d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6512dc7c-358b-4222-9f44-7255751d3191",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-05T17:21:41.0474937+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": "992f7dc5-dfbd-4302-aa7e-e4aa986bee16",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-05T17:21:41.0474937+00:00"
}