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": "10a35bf1-9093-40c9-af21-0ed95e8ae24a",
"jobs_id": "94f148f4-18d0-4498-b099-bbd711e78524",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1a15b81c-f4d0-4d34-918b-3140510eba54",
"_parent_id": "7610899d-6313-41ac-9eb5-8d4467323f78",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "af21e4c4-40a9-4802-acc4-e14417cba285",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6f5d68ff-b130-4a05-9c07-db2c33275537",
"_parent_id": "a0ff6e9d-e96c-4dd2-9f20-b75d46190f55",
"root_parent_id": "237647d6-ae56-4bb4-b022-6e6fecd62d51",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e2acec23-2da8-4ab1-b29f-de61a1d841e4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "845ebc7c-daff-4004-9766-e4dcfb127ad8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be63bbb8-ffff-4e0d-92b9-f3e1d1d7a579",
"_parent_code": "sample string 6",
"sales_organization_id": "16ad88be-5965-436c-a295-b0c035a9388c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00"
},
"equipment_model_id": "66c37964-20b9-49a0-96e2-17050b5a8ebe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "df92534b-f8a0-40dc-b72f-b81bff24f991",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2becf642-5eff-4df1-b147-e87497e5b4e6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1bc0d865-97f9-445b-b6f5-bee0c4de9864",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a045086e-f69e-47d4-acbb-945e45477b99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00"
},
"equipment_family_id": "0145d5b7-8289-4810-b099-f51681729f77",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "845ebc7c-daff-4004-9766-e4dcfb127ad8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be63bbb8-ffff-4e0d-92b9-f3e1d1d7a579",
"_parent_code": "sample string 6",
"sales_organization_id": "16ad88be-5965-436c-a295-b0c035a9388c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00"
},
"date_in_production_since": "2026-08-14T04:29:17.4901166+00:00",
"date_out_of_production_since": "2026-08-14T04:29:17.4901166+00:00",
"date_end_support": "2026-08-14T04:29:17.4901166+00:00",
"sales_organization_id": "0877ffb1-5d53-40f3-a780-868ce9429dfe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+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-08-14T04:29:17.4901166+00:00"
},
"project_status_id": "6400a18b-c108-4851-b98c-cac134218ea9",
"project_status_code": "sample string 10",
"project_status": {
"id": "4daef524-c13d-4def-9fec-e919fe7e9ef8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "794613b6-e98c-4e6d-bb68-398d436e2951",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00"
},
"company_id": "c06a9be6-93c8-4d55-b10a-6141fc515ac4",
"company_code": "sample string 12",
"db_address_id": "258d14cd-2576-4749-8aab-357ee896ba96",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f1b86ea7-10f8-4c98-abca-e3dedf95099d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6da9da24-9a07-47cb-b835-c2cc1ea1df52",
"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-08-14T04:29:17.4901166+00:00",
"date_create": "2026-08-14T04:29:17.4901166+00:00",
"date_update": "2026-08-14T04:29:17.4901166+00:00",
"updated_by_user_id": "c176ae36-45cb-4dab-86fd-4a0cc5799e5d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T04:29:17.4901166+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-08-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T04:29:17.4901166+00:00",
"date_last_job": "2026-08-14T04:29:17.4901166+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T04:29:17.4901166+00:00",
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00",
"is_mobile_installation": true
},
"job_type_id": "332be641-1c99-4130-ae16-d83840ac12e4",
"job_type_code": "sample string 7",
"job_type": {
"id": "b8ef573a-a857-44c4-923c-557ac30a0635",
"name": "sample string 2",
"sales_organization_id": "adb2a7a1-3b14-4ed1-9d90-7cf91b050342",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00",
"code": "sample string 7"
},
"job_priority_id": "c8f738ca-c728-494b-8faf-ff025ff9ef98",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c3327aab-caf5-42b5-89cd-37e3ca3155a7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "31ff2a70-ff70-4a62-b6a1-a28f3073d57c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00"
},
"job_status_id": "6a861d37-878f-4f98-8e26-da97e6f70eee",
"job_status_code": "sample string 11",
"db_address_id": "83bc982b-2aba-4b7f-a4c2-e0a8011c328a",
"contact_id": "caa7bb1b-735d-4426-973c-ee0a0c365acf",
"requested_by_company_id": "8fdbcaff-b579-4d92-b19f-12673c75f0de",
"requested_by_contact_id": "e9b40d2c-c13f-4c6f-ba32-76099d215d14",
"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-08-14T04:29:17.4901166+00:00",
"due_date": "2026-08-14T04:29:17.4901166+00:00",
"date_create": "2026-08-14T04:29:17.4901166+00:00",
"date_update": "2026-08-14T04:29:17.4901166+00:00",
"date_closed": "2026-08-14T04:29:17.4901166+00:00",
"suggested_user_id": "d1354372-443a-4117-a8fd-8e27c19dc250",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ffb5b3e1-eaf0-4fda-936c-39a9fe9006c8",
"db_language_id": "45ed6df1-3839-4d31-838c-7c9797b5ce78",
"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-08-14T04:29:17.4901166+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "86f2e6fe-1ca0-4b6b-97dc-f5c620734100",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "200cd61e-7bb3-40ec-ade4-59a1f9539045",
"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": "82dbb26b-04ad-4eb3-8315-efdbfe4357a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2631d3b9-5405-4eac-9752-c9a1022c624b"
},
"suggested_date_start": "2026-08-14T04:29:17.4901166+00:00",
"skill_id": "ea8344be-ac64-4f6d-a0a8-0efce19ac0b1",
"skill_code": "sample string 32",
"skill": {
"id": "54ecc63b-b0f1-428a-8054-c188a490adb0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eb718d8e-9390-4820-9df3-e9c3f7990f91",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f825be09-ccb0-4bed-bc4e-4b7fa2ffe50c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "933eb5c9-a5a8-4f77-981a-d00ffbf9e745",
"db_currency_id": "44f67b53-1b11-4d64-bdba-4fcf650df2a2",
"db_language_id": "4b48c303-8a6d-4f29-83c7-f1fd0508eb55",
"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-08-14T04:29:17.4901166+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "26482fde-8ee4-40be-a85b-f1a91fb22ff0",
"date_reported_by_company": "2026-08-14T04:29:17.4901166+00:00",
"id2": 36,
"company_id": "8bff2775-b6bb-4901-893c-54c9014c96e5",
"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": "c936d1e3-d459-4d97-93e0-9ac39a4b5df8",
"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-08-14T04:29:17.4901166+00:00"
},
"work_instruction_details_id": "a3c95ef4-dd15-42e4-9411-e7e7c15d4d26",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cce01c4e-2313-4b52-9544-5ab3508132c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1dcc63f7-b20f-4cdc-8a92-807d1fbd5de7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T04:29:17.4901166+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": "5f3b0096-352c-44b1-8b4f-75f325b86774",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T04:29:17.4901166+00:00"
}