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": "d8784ece-f59e-4b6a-b23b-6cc96b9a735f",
"jobs_id": "a62d793a-a46a-459a-ab9e-9139e9864a6d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "07b59b4f-8b13-4bb6-a879-c4487d6aeaa6",
"_parent_id": "92824f4a-9884-4e94-89ab-f6976ececb58",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6ce92ff6-7b2e-471a-a37c-90b743e2b8d1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dd1709d2-8202-448a-b4b5-abea7312c1d5",
"_parent_id": "18c55ee1-afdf-4f44-b5e8-4a0ba93247c0",
"root_parent_id": "be004e7d-001c-4cd3-906a-644a86f92450",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2a16d519-11ef-40e4-aead-11e39a7e2cbf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b801c8cb-3125-4640-add0-462ccbd86e33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50ddc1f4-69f8-4a10-9232-8238631ab0d0",
"_parent_code": "sample string 6",
"sales_organization_id": "e001f5f5-15df-4c1c-baa8-f7595b5f10fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+00:00"
},
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00"
},
"equipment_model_id": "97343c4c-94cc-4be6-891f-5fd06db74399",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8485c3bb-9ede-43df-9c84-02359743e721",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3e6c9369-546c-4c10-a6b9-97bae816e1c8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7b9da6b1-c903-4426-bc68-bb1285be5728",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0fae6741-6aad-4bff-beba-b316ff4d8cb1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+00:00"
},
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00"
},
"equipment_family_id": "2ae453d1-1df2-4f4c-97a3-c6120871b388",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b801c8cb-3125-4640-add0-462ccbd86e33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50ddc1f4-69f8-4a10-9232-8238631ab0d0",
"_parent_code": "sample string 6",
"sales_organization_id": "e001f5f5-15df-4c1c-baa8-f7595b5f10fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+00:00"
},
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00"
},
"date_in_production_since": "2026-11-13T20:09:14.9484674+00:00",
"date_out_of_production_since": "2026-11-13T20:09:14.9484674+00:00",
"date_end_support": "2026-11-13T20:09:14.9484674+00:00",
"sales_organization_id": "a2a4a7f8-4222-4d39-8356-dd5cd17b5e7a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+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-11-13T20:09:14.9484674+00:00"
},
"project_status_id": "3143208a-d25f-44a3-a23f-fc21bd585664",
"project_status_code": "sample string 10",
"project_status": {
"id": "7f0902c4-c624-4f82-ac46-865d0db66d3c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "34c81e67-1cc2-41eb-ba1c-e4cd90a23fb5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00"
},
"company_id": "742a7362-7770-49f2-bcf6-dfd6a88100b3",
"company_code": "sample string 12",
"db_address_id": "fd093332-0245-4911-b037-d5ee90f141e4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "df55b409-dc05-4c42-9456-975fa56b5417",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a65e567f-fc91-4e2f-a1ee-d0da59460e92",
"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-11-13T20:09:14.9484674+00:00",
"date_create": "2026-11-13T20:09:14.9484674+00:00",
"date_update": "2026-11-13T20:09:14.9484674+00:00",
"updated_by_user_id": "3e779a36-a7d6-452d-aa1d-f4832338ce63",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-13T20:09:14.9484674+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-11-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-13T20:09:14.9484674+00:00",
"date_last_job": "2026-11-13T20:09:14.9484674+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-13T20:09:14.9484674+00:00",
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00",
"is_mobile_installation": true
},
"job_type_id": "c160b0f1-4e6a-44c4-83f2-6a93eea095cf",
"job_type_code": "sample string 7",
"job_type": {
"id": "0c61fc8b-880d-47b4-afe2-c2fe0f4d7741",
"name": "sample string 2",
"sales_organization_id": "79c63691-2b9b-445e-b8c2-07422dca6763",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00",
"code": "sample string 7"
},
"job_priority_id": "92f36b02-33bf-47b0-9f6a-25eb98fb6dfb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d6ec5be9-3722-48df-9260-c070b9a777d6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "48b43c87-3260-46b2-96e9-ed4c705fa6c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00"
},
"job_status_id": "ab5b7df6-1b73-4467-a61a-d402fe3c601a",
"job_status_code": "sample string 11",
"db_address_id": "4f1d92ff-f3d8-4a9e-bd0c-c469935925ed",
"contact_id": "504c8a4d-c8d5-4113-a3b0-7a634c0c1567",
"requested_by_company_id": "b4c50e39-8df8-4573-811d-0f5c2e1910bd",
"requested_by_contact_id": "1cd944fa-f1d2-4960-b97e-7b5af66f0ae4",
"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-11-13T20:09:14.9484674+00:00",
"due_date": "2026-11-13T20:09:14.9484674+00:00",
"date_create": "2026-11-13T20:09:14.9484674+00:00",
"date_update": "2026-11-13T20:09:14.9484674+00:00",
"date_closed": "2026-11-13T20:09:14.9484674+00:00",
"suggested_user_id": "744b189f-7f27-450f-90b8-18660d89312a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ef766706-159f-4325-b15d-ab5312239736",
"db_language_id": "d922ee39-f479-474f-b82c-9938c5b61e5d",
"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-11-13T20:09:14.9484674+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "49df0c24-f27f-4248-b7f0-492c4c81e48a",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0c794671-3423-4b6b-9220-90cae95aa168",
"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": "4678e2d4-d088-48bd-807e-ae60d81e3911",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "28f6e7b1-e664-4c90-88bb-f7a4226479f1"
},
"suggested_date_start": "2026-11-13T20:09:14.9484674+00:00",
"skill_id": "21ec351a-f0fc-45fd-9b33-1f074195f5c7",
"skill_code": "sample string 32",
"skill": {
"id": "57d529dd-11c6-4528-b8cc-a1fcba789b97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2b2ae4a1-7db9-4994-b034-19a556e90c59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c966d3d-e979-4e11-bb09-744703fb1964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2fb2d73-9e11-4a4c-95c1-e9aa43d19c32",
"db_currency_id": "4072c590-37e7-4c51-bf95-a70378e6cd4c",
"db_language_id": "ab1aa1a5-64e9-4699-a6f4-b6d393d11546",
"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-11-13T20:09:14.9484674+00:00"
},
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d463cebd-04c3-4113-bee6-c27508352b3d",
"date_reported_by_company": "2026-11-13T20:09:14.9484674+00:00",
"id2": 36,
"company_id": "ef4e44f4-d7a4-48db-901b-458ba55edc28",
"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": "dd19c8b6-8467-4ec6-89ff-f61b8399294f",
"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-11-13T20:09:14.9484674+00:00"
},
"work_instruction_details_id": "81798503-7cec-4c45-be2a-33609ada05ad",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b6d5056c-f631-4a42-91fc-10d9c3741ed8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "043d0bc0-d0f2-44ca-a361-ca5fb24572a1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-13T20:09:14.9484674+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": "8d720a06-864f-4295-ad4b-b45cdf2fb1d1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-13T20:09:14.9484674+00:00"
}