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": "852fa9d2-e0e5-4978-9d03-b104bd29e83c",
"jobs_id": "4952ccd9-c20e-4b03-9d49-8672fe2791c0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f1f5cf11-1470-47ce-b410-98693654d139",
"_parent_id": "e973ed77-e91c-450e-90f7-e3a002242c57",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fd9ab3a0-ae79-4684-8c0b-a0b167b4ac5b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "59f41eb2-c0e7-4deb-9b02-645377eefc31",
"_parent_id": "68943ec1-8132-431e-89b2-95355efbc295",
"root_parent_id": "c1329407-79ad-4dc9-9f2d-b7c9d503bd3d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "74ad61dc-4ce4-47d2-9bde-a90a370996b9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1805dff2-328f-488b-b753-ce72b7c35203",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9dd047f3-0c65-4877-86bd-45309c4b443a",
"_parent_code": "sample string 6",
"sales_organization_id": "e3f0d846-0e7f-4f86-b400-e98bdf7f2636",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+00:00"
},
"modified_dateutc": "2026-11-11T19:20:42.7505501+00:00"
},
"equipment_model_id": "d2be20cd-1887-4226-9d23-af52a6620e5a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e8ad0d08-b8e6-4724-9455-7b432c78a84f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7dda3d3a-54c3-4b78-8018-734e2f233d8b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9d88ae94-38d8-4384-9d60-c6ced87471ed",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "80ad2a01-777d-4224-992b-67411dae07e5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+00:00"
},
"modified_dateutc": "2026-11-11T19:20:42.7505501+00:00"
},
"equipment_family_id": "c4b582a0-bd85-4034-abea-9da5410ae718",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1805dff2-328f-488b-b753-ce72b7c35203",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9dd047f3-0c65-4877-86bd-45309c4b443a",
"_parent_code": "sample string 6",
"sales_organization_id": "e3f0d846-0e7f-4f86-b400-e98bdf7f2636",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+00:00"
},
"modified_dateutc": "2026-11-11T19:20:42.7505501+00:00"
},
"date_in_production_since": "2026-11-11T19:20:42.7505501+00:00",
"date_out_of_production_since": "2026-11-11T19:20:42.7505501+00:00",
"date_end_support": "2026-11-11T19:20:42.7505501+00:00",
"sales_organization_id": "03fc0212-747c-4988-92a1-acdbecda8543",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+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-11T19:20:42.7505501+00:00"
},
"project_status_id": "976c7e99-5e15-4484-a8b4-9d2825144d68",
"project_status_code": "sample string 10",
"project_status": {
"id": "4bdd33e9-cc43-41da-a3e9-d6a9aedbb4bc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "720f4f80-dfe2-4642-b18a-dc9a1015f27e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-11T19:20:42.7505501+00:00"
},
"company_id": "92b92402-afc2-44f9-a57f-c3638215ebfa",
"company_code": "sample string 12",
"db_address_id": "2a88bb34-766e-4d5a-a27a-6556e24bc63b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0b0601b6-d182-4c71-b7b1-fb356b47e232",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "95ecbcb7-585f-47d9-bf9e-d82657add36d",
"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-11T19:20:42.7505501+00:00",
"date_create": "2026-11-11T19:20:42.7505501+00:00",
"date_update": "2026-11-11T19:20:42.7505501+00:00",
"updated_by_user_id": "76336e65-c00a-4beb-9a9c-9ec0921a5c44",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-11T19:20:42.7505501+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-11T19:20:42.7613957+00:00",
"date_last_job": "2026-11-11T19:20:42.7613957+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-11T19:20:42.7613957+00:00",
"modified_dateutc": "2026-11-11T19:20:42.7613957+00:00",
"is_mobile_installation": true
},
"job_type_id": "9bbcd497-498d-49c9-96e1-7832751b4269",
"job_type_code": "sample string 7",
"job_type": {
"id": "dadcf003-012f-4086-b41f-e520e46bb75e",
"name": "sample string 2",
"sales_organization_id": "01a04c21-e053-4c76-876e-fb41289719d2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-11T19:20:42.7613957+00:00",
"code": "sample string 7"
},
"job_priority_id": "bf798fb4-0709-47b7-a9f8-ff26bb3718ce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6bb63be2-903f-4db8-8c75-5ede5b8cdd39",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ccca7701-ada0-4900-a8f1-4f3299235d9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-11T19:20:42.7613957+00:00"
},
"job_status_id": "78073cb2-b491-47f1-a856-3b09917af8d3",
"job_status_code": "sample string 11",
"db_address_id": "a3dc43e5-bd6a-40cb-852c-fb5894aef015",
"contact_id": "d38e8ac1-efef-4d34-9bee-8ebf5f1876a1",
"requested_by_company_id": "d201773a-088f-4391-9ed4-11a81c4ff3bb",
"requested_by_contact_id": "9700b457-d450-46c7-b0e9-67a3ed3f119d",
"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-11T19:20:42.7613957+00:00",
"due_date": "2026-11-11T19:20:42.7613957+00:00",
"date_create": "2026-11-11T19:20:42.7613957+00:00",
"date_update": "2026-11-11T19:20:42.7613957+00:00",
"date_closed": "2026-11-11T19:20:42.7613957+00:00",
"suggested_user_id": "5678bf53-1957-40cf-b376-1dcd54ad7a2f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b03dc688-7ad4-4966-b419-10961b9c421c",
"db_language_id": "73c35690-29a2-4c58-8a99-9243b8d199ae",
"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-11T19:20:42.7613957+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ce630a27-b6ab-4d95-9b32-8248949c11ed",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4978dbaa-a950-44b1-be18-eba4780eb546",
"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": "5f714363-c8a6-4def-8192-d1b7376fe1af",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-11T19:20:42.7613957+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fecafaaa-8a9f-4af6-ba30-64245ffb08e6"
},
"suggested_date_start": "2026-11-11T19:20:42.7613957+00:00",
"skill_id": "3e0fda6a-1005-4022-a214-f39300c7d490",
"skill_code": "sample string 32",
"skill": {
"id": "b3ce727d-87d9-42d6-9a81-bc60e1a1b318",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4582a07e-a617-465b-a155-99b4104267f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "99d9f11a-29de-4e33-bc5a-1c0797c9f087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f74fe5-c799-4617-abc0-f0fe169f353b",
"db_currency_id": "6f0d34cf-ee2d-4e09-a724-3884f6ba01e5",
"db_language_id": "1870929b-0e5e-4fc1-8394-a6ae051287a1",
"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-11T19:20:42.7505501+00:00"
},
"modified_dateutc": "2026-11-11T19:20:42.7613957+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fab8f380-0df7-475f-a7c3-447a92e7c8af",
"date_reported_by_company": "2026-11-11T19:20:42.7613957+00:00",
"id2": 36,
"company_id": "285f62b1-d9f8-4da9-a7ab-31a01dba05af",
"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": "0ea3bcb6-afa9-43ec-b30a-74fc1cd9a147",
"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-11T19:20:42.7613957+00:00"
},
"work_instruction_details_id": "3e1857c5-0abf-448f-a8ef-03b15d4e4b61",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9c39deaa-2765-40ae-8128-45dc8fc7c0fb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7b9c30cc-3f72-4357-a212-3916656b7d8f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-11T19:20:42.7613957+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": "65048026-e643-44d1-b13e-3939eb8ad1b2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-11T19:20:42.7613957+00:00"
}