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": "e4156ba8-36eb-4ebf-97f4-7c1fd6e98cfc",
"jobs_id": "8e6d0828-2c3e-407e-b457-e39efd6a23b7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "12af45db-dddc-443b-a607-49e4dced7023",
"_parent_id": "b47d6e54-6e32-402b-a790-54e3476a4c3c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ed37cf77-3ec5-40ba-b9d7-fd46a748ebc2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cfb87cbc-2c90-4471-8775-c31123b0835c",
"_parent_id": "f789279b-aea8-46ee-9946-fc9f6dc08601",
"root_parent_id": "219b44f8-f797-482d-bf89-c0459189cac7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1b8dfb8c-dc3c-42db-8b2c-eeb9bd45a7a4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1bd6c2e5-ed4d-43e9-85f1-f8970b2a4f42",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ad7d00d-0299-4856-869a-ac73a11ee915",
"_parent_code": "sample string 6",
"sales_organization_id": "41319c1c-b431-4157-9762-3a1d9d95ba2c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+00:00"
},
"modified_dateutc": "2026-01-07T19:46:52.3198347+00:00"
},
"equipment_model_id": "69a64c27-0e98-475a-bd61-1f92b0f247e5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "06a945f0-6792-4436-9612-6470aa42e806",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3bedc959-8a13-49fb-85a8-c38ca9926c8f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dddbdd58-dd2f-40f1-8c56-3907fc1ad201",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c6418940-56d9-4a5c-b2cb-267a736161cf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+00:00"
},
"modified_dateutc": "2026-01-07T19:46:52.3198347+00:00"
},
"equipment_family_id": "e911d4a9-8e80-47e4-89e8-52ec24df3c5b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1bd6c2e5-ed4d-43e9-85f1-f8970b2a4f42",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ad7d00d-0299-4856-869a-ac73a11ee915",
"_parent_code": "sample string 6",
"sales_organization_id": "41319c1c-b431-4157-9762-3a1d9d95ba2c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+00:00"
},
"modified_dateutc": "2026-01-07T19:46:52.3198347+00:00"
},
"date_in_production_since": "2026-01-07T19:46:52.3198347+00:00",
"date_out_of_production_since": "2026-01-07T19:46:52.3198347+00:00",
"date_end_support": "2026-01-07T19:46:52.3198347+00:00",
"sales_organization_id": "4c0a0b10-e8f7-4ae8-8105-0a94d3386a63",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+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-01-07T19:46:52.3198347+00:00"
},
"project_status_id": "8b8cf6a3-18f5-440e-904d-7dc271f589ed",
"project_status_code": "sample string 10",
"project_status": {
"id": "f3377c49-82bf-4694-837f-f27c3f1957f6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c0324a42-db7d-4718-8629-8b88354f42a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T19:46:52.3198347+00:00"
},
"company_id": "ed51a3a5-651e-4012-8c99-79bb0e2b9bfc",
"company_code": "sample string 12",
"db_address_id": "dcb2670e-3d68-49e9-8f2f-07af52a52556",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5b1a1f95-9d55-40f7-b751-23c9449554e9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "634540e9-3e38-409a-953b-9b29e8f57622",
"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-01-07T19:46:52.3198347+00:00",
"date_create": "2026-01-07T19:46:52.3198347+00:00",
"date_update": "2026-01-07T19:46:52.3198347+00:00",
"updated_by_user_id": "b0b30604-2c86-47ab-ae3c-f562a0ec1cf7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-07T19:46:52.3198347+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-01-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-07T19:46:52.3198347+00:00",
"date_last_job": "2026-01-07T19:46:52.3198347+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-07T19:46:52.3198347+00:00",
"modified_dateutc": "2026-01-07T19:46:52.3198347+00:00",
"is_mobile_installation": true
},
"job_type_id": "73ea7f02-1b30-4e14-a383-8196a417e37c",
"job_type_code": "sample string 7",
"job_type": {
"id": "f82dfda4-870f-46c2-bdf2-42605108a2f8",
"name": "sample string 2",
"sales_organization_id": "bb679afc-fd5a-4a30-976e-98cf6e6e272d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-07T19:46:52.3198347+00:00",
"code": "sample string 7"
},
"job_priority_id": "c59b1272-4e7c-45ab-9ea6-4bebd31f1aeb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0ab1980e-4309-4b4e-9a7a-dccfda2417ca",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bb89564a-40a9-4bd9-8ca1-49f4830649b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T19:46:52.3354595+00:00"
},
"job_status_id": "5977dce5-3a18-46b3-95a5-e78c56147de5",
"job_status_code": "sample string 11",
"db_address_id": "8222ef87-8353-417e-b97f-13fb710b7159",
"contact_id": "f1c5f939-2651-4ee9-9dd0-6d828349e8c9",
"requested_by_company_id": "98a392f3-7a30-4b1a-b9d2-d557beb21d76",
"requested_by_contact_id": "198c6d3a-3248-4acc-884b-90f717af1a9e",
"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-01-07T19:46:52.3354595+00:00",
"due_date": "2026-01-07T19:46:52.3354595+00:00",
"date_create": "2026-01-07T19:46:52.3354595+00:00",
"date_update": "2026-01-07T19:46:52.3354595+00:00",
"date_closed": "2026-01-07T19:46:52.3354595+00:00",
"suggested_user_id": "a99e8992-3f8f-4aad-b8b2-035ff5ab3766",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a1dc7d55-5caa-42ca-b6ee-916588065d38",
"db_language_id": "3bb4463a-1307-40eb-b0c2-749f7c510d36",
"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-01-07T19:46:52.3354595+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5971a6f2-3a36-4db9-9400-24f86c4155a6",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "344f4160-aaaa-4383-a584-610392dd9023",
"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": "44cb9d0d-dbfa-4a9d-9a74-be549c46a28b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-07T19:46:52.3354595+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "27716690-7b73-4624-964b-36df567b6e69"
},
"suggested_date_start": "2026-01-07T19:46:52.3354595+00:00",
"skill_id": "6cb1fb1d-fcc8-4cfd-b285-f78a12d7730a",
"skill_code": "sample string 32",
"skill": {
"id": "adf72ac8-fe34-48ab-81f7-33ebc8226911",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "72df2c7a-8245-471f-876f-6130744dea48",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ed35d71-557b-48cb-a49e-59bc42a1b42a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a53f6a2a-ff1c-456a-b07c-67edf8a252b4",
"db_currency_id": "8b7d7370-9877-47e5-a4b7-52ee279a3380",
"db_language_id": "16dfc515-51e1-4560-bdd3-44427d6178b3",
"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-01-07T19:46:52.3198347+00:00"
},
"modified_dateutc": "2026-01-07T19:46:52.3354595+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4cf0554c-10ec-4045-a5a3-7cefbb0dee4e",
"date_reported_by_company": "2026-01-07T19:46:52.3354595+00:00",
"id2": 36,
"company_id": "d5ae5642-7d70-4bd5-a68c-2f5e1f14f347",
"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": "861a940c-4f05-4eab-82b9-8fc8387ab0f9",
"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-01-07T19:46:52.3354595+00:00"
},
"work_instruction_details_id": "47472d25-d251-4a1c-aded-f532d0066f9e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "98587afb-e3a2-480f-b2f4-0fb47096bbe2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "324cf6ee-65c1-4908-a1c9-03ee48dedb49",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-07T19:46:52.3354595+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": "3efbff46-8b2d-4342-bc2e-c184055a5866",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-07T19:46:52.3354595+00:00"
}