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": "bf612991-21e1-4c38-a21b-03f102cc1c87",
"jobs_id": "b238dfba-4163-4800-a2fe-d61893f3f1bc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "65975834-efba-48d4-a034-568b303bd0f2",
"_parent_id": "52ba6b3b-3f81-474c-a0c1-8a732dc6be6d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a9803398-1fab-458c-a6a0-2f450d1ffdec",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b68c4a06-289b-45db-8507-de1daea346d4",
"_parent_id": "c2debadb-ad1e-4dc7-a7bd-076604c67a38",
"root_parent_id": "9f2f7130-2315-42c7-8f50-b60df26183a2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8dacfe5a-b675-4014-888c-974bda1c386c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a39ee049-8d75-4dfc-a2b5-181017bd65df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9e6ff231-98e6-4a98-a92e-a47dcb6a8d0b",
"_parent_code": "sample string 6",
"sales_organization_id": "8f558aa3-6528-41dd-a7a0-90678c54e945",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00"
},
"equipment_model_id": "46177952-7d0c-4cb4-bef5-8fad1d984e78",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7c09ec78-ae07-432b-80bd-bfc5ed3eedc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fcc87998-5246-487c-a762-550d4dd8e4b7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b430cd91-54a7-4839-84c9-7fc255633b89",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5197e324-6e3c-4017-b7a6-0f08f30964d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00"
},
"equipment_family_id": "142fd698-cff4-48ac-a61f-76211ba86e20",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a39ee049-8d75-4dfc-a2b5-181017bd65df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9e6ff231-98e6-4a98-a92e-a47dcb6a8d0b",
"_parent_code": "sample string 6",
"sales_organization_id": "8f558aa3-6528-41dd-a7a0-90678c54e945",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00"
},
"date_in_production_since": "2025-11-29T02:39:28.9425708+00:00",
"date_out_of_production_since": "2025-11-29T02:39:28.9425708+00:00",
"date_end_support": "2025-11-29T02:39:28.9425708+00:00",
"sales_organization_id": "390f77dd-72fc-43dc-a762-4842b297c113",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+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": "2025-11-29T02:39:28.9425708+00:00"
},
"project_status_id": "4268b172-c0f4-4bf8-9ff5-1e910201994c",
"project_status_code": "sample string 10",
"project_status": {
"id": "8f853db2-585b-4833-bbcc-5d6b973b0c61",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d7ae7307-0e0e-4265-af33-eee43068ee06",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00"
},
"company_id": "731a3956-0f21-4167-94a3-9f1f221e5702",
"company_code": "sample string 12",
"db_address_id": "14cc00db-e31d-4b7b-95a2-ff7830d331b7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5a00427c-0f8a-49c9-b5e1-3e7bc64da6cf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "41bc3f7b-52f0-4931-ab3f-cbbdfb5515f9",
"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": "2025-11-29T02:39:28.9425708+00:00",
"date_create": "2025-11-29T02:39:28.9425708+00:00",
"date_update": "2025-11-29T02:39:28.9425708+00:00",
"updated_by_user_id": "d51e29eb-a3d2-4a0f-8199-30e44e0783c5",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-29T02:39:28.9425708+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": "2025-11-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-29T02:39:28.9425708+00:00",
"date_last_job": "2025-11-29T02:39:28.9425708+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-29T02:39:28.9425708+00:00",
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00",
"is_mobile_installation": true
},
"job_type_id": "ba3cd2ea-aac7-45dc-8c55-26d4429d2c9b",
"job_type_code": "sample string 7",
"job_type": {
"id": "c5a93d80-d7cd-4f27-9cc6-f1579e17ffe1",
"name": "sample string 2",
"sales_organization_id": "bc9b2a67-1a3b-4171-92f6-3648b2afffd1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00",
"code": "sample string 7"
},
"job_priority_id": "cdfec361-b9b9-4bc3-ad90-5390382411e4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3c178400-102d-4f60-a9ed-20db98da3a9d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "99961d10-03a5-4c70-9236-65e0d10fdf47",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00"
},
"job_status_id": "e7ce7b7a-ad47-4787-a846-fbe416f2cbac",
"job_status_code": "sample string 11",
"db_address_id": "e5206c47-2f82-41a0-8da4-d5f02287ea73",
"contact_id": "892f56f7-bc88-48cb-977a-9ccdedd13b2f",
"requested_by_company_id": "221025b3-2a33-4714-b864-5aaaa3ce1fb2",
"requested_by_contact_id": "b3db0120-1c56-4187-ad32-f3dc9c9a005c",
"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": "2025-11-29T02:39:28.9425708+00:00",
"due_date": "2025-11-29T02:39:28.9425708+00:00",
"date_create": "2025-11-29T02:39:28.9425708+00:00",
"date_update": "2025-11-29T02:39:28.9425708+00:00",
"date_closed": "2025-11-29T02:39:28.9425708+00:00",
"suggested_user_id": "520604bf-eee4-4fc8-a097-999f17cded56",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3181183e-5558-47b5-a117-d3ea2d645fe0",
"db_language_id": "0a83a261-127a-4fed-bc50-a1922c4e0aed",
"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": "2025-11-29T02:39:28.9425708+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d5ab64df-0d69-44cc-92f8-b0c4ae72d240",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "493d9c64-ca6e-4821-9760-b4fab31b8217",
"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": "466d2f36-9fca-4b0c-a54a-61e6387ffff5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f84f2a88-f756-40a9-aa90-a8ceb446c81f"
},
"suggested_date_start": "2025-11-29T02:39:28.9425708+00:00",
"skill_id": "da4a6987-3183-48dd-aed6-8fb8ca79448b",
"skill_code": "sample string 32",
"skill": {
"id": "eca8768c-c228-4d79-aff2-3649d1659268",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1cebf6fb-4bc5-42e6-84a2-fc3fd0ff98b8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "70673b59-d241-4d66-892d-6154a24ea842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc7c2632-3f4f-43a7-8d0c-e945cb9fc440",
"db_currency_id": "e850b9af-0448-4f9d-802a-775378abd106",
"db_language_id": "180b3cc0-1448-4819-b9ee-34ed57d91281",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bc7b7898-5d51-4198-962f-40913ed185c7",
"date_reported_by_company": "2025-11-29T02:39:28.9425708+00:00",
"id2": 36,
"company_id": "73a20bbb-a7d2-4c4b-a1d2-dd6d4e91d6a5",
"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": "b72c0f5d-277f-457d-ac8a-2374e46d7dd3",
"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": "2025-11-29T02:39:28.9425708+00:00"
},
"work_instruction_details_id": "b72a1415-0d72-4d6b-838c-f06127429bc9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bb8378e0-aa54-4294-8a44-aa6b6f40ef37",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c28b1573-021a-4cde-ad40-21b56674d394",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-29T02:39:28.9425708+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": "3c182afb-d521-4796-9a5c-77119e5a6c36",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-29T02:39:28.9425708+00:00"
}