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": "376a124d-081f-4583-85b5-bda457ea6df8",
"jobs_id": "3bdef139-2b49-4e7f-be4f-fc1fe68f5df2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "926c1c1a-3b78-4390-918d-923d8d971d66",
"_parent_id": "77b0d664-941a-4887-a949-60c804971c3f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "762d28f8-dd0a-44e2-aa20-8318f421d06a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b668afe3-8360-4b05-9111-ad86cec8deb9",
"_parent_id": "1640fdf6-ea02-4e7d-90ed-26f4f0b23e59",
"root_parent_id": "b3cc08e2-c239-4173-85bd-de4f49f60c64",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d1fd5b9b-759f-4ee5-87c5-e7f22be2f054",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a1ab6b4b-7964-415c-a765-42ffacab6474",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db44cd4f-1993-426a-ae3d-e29afcb326fe",
"_parent_code": "sample string 6",
"sales_organization_id": "119e6aa2-f4b7-493c-b64c-0279099be84b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+00:00"
},
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00"
},
"equipment_model_id": "8ad4b7b3-6339-4aa8-a7e5-c73ab1eae31f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5b6c3b6b-228c-4875-97db-b41942645bb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "810036ad-cf93-4e38-81da-fa33323c544e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eed463eb-388a-4bc5-a092-3352fd4c7659",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b45fea02-675c-442c-86aa-c4492b096f5d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+00:00"
},
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00"
},
"equipment_family_id": "68b5ee61-a093-4960-99b4-ea0e325c7774",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a1ab6b4b-7964-415c-a765-42ffacab6474",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db44cd4f-1993-426a-ae3d-e29afcb326fe",
"_parent_code": "sample string 6",
"sales_organization_id": "119e6aa2-f4b7-493c-b64c-0279099be84b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+00:00"
},
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00"
},
"date_in_production_since": "2026-10-30T15:10:42.5828207+00:00",
"date_out_of_production_since": "2026-10-30T15:10:42.5828207+00:00",
"date_end_support": "2026-10-30T15:10:42.5828207+00:00",
"sales_organization_id": "878cfb01-bfd5-402c-bc99-28bcb8a16d92",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+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-10-30T15:10:42.5828207+00:00"
},
"project_status_id": "6a5ee7da-7162-4e1e-9aba-51eefcb9056c",
"project_status_code": "sample string 10",
"project_status": {
"id": "956e657e-3bce-4a89-95f4-df2b7d02671a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8d7ecb88-23d2-4df4-b29d-5dbeaeddfa2b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00"
},
"company_id": "4d7888d4-f498-4f27-a97f-2453d9aec0b3",
"company_code": "sample string 12",
"db_address_id": "211dcd83-b90a-4859-b909-6e462e2b41e0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "947a8ffd-30c9-4c61-b02f-af563db88bac",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "00ff44b4-067f-47f1-b624-153328bcfe87",
"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-10-30T15:10:42.5828207+00:00",
"date_create": "2026-10-30T15:10:42.5828207+00:00",
"date_update": "2026-10-30T15:10:42.5828207+00:00",
"updated_by_user_id": "7b792282-5168-428f-bf1f-af4be2606c2e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-30T15:10:42.5828207+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-10-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-30T15:10:42.5828207+00:00",
"date_last_job": "2026-10-30T15:10:42.5828207+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-30T15:10:42.5828207+00:00",
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00",
"is_mobile_installation": true
},
"job_type_id": "68f947d5-99ca-4473-aae3-9c1e3ca8a1f3",
"job_type_code": "sample string 7",
"job_type": {
"id": "8929b405-2fcb-4e1d-affb-549551edf203",
"name": "sample string 2",
"sales_organization_id": "c0670087-3484-423b-8d06-b9fb796838c0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00",
"code": "sample string 7"
},
"job_priority_id": "e4e5d822-9d95-46d6-b853-676f037e30fb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "611e59a6-ded6-44ef-bf39-33d7bee16749",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "34b32f1e-c1b9-4251-ac8c-7f7d9907e831",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00"
},
"job_status_id": "9032de99-2645-426a-a57d-917d82638198",
"job_status_code": "sample string 11",
"db_address_id": "f9338bba-bc62-4ccb-bf76-d6bf0fab0948",
"contact_id": "105992e7-0869-414a-bc51-dc25a516568c",
"requested_by_company_id": "f25c1092-ed93-484f-b552-0360bb446a8a",
"requested_by_contact_id": "0b3e779b-ddf1-499b-962f-7a4cd4c15767",
"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-10-30T15:10:42.5828207+00:00",
"due_date": "2026-10-30T15:10:42.5828207+00:00",
"date_create": "2026-10-30T15:10:42.5828207+00:00",
"date_update": "2026-10-30T15:10:42.5828207+00:00",
"date_closed": "2026-10-30T15:10:42.5828207+00:00",
"suggested_user_id": "18d26506-11ab-4484-a0bc-1e44d021ea22",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b71dae71-6b76-4506-a773-9b0f3639ad2e",
"db_language_id": "c5aa0db3-179e-47ec-9a81-92e4c365f68f",
"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-10-30T15:10:42.5828207+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "52c7684b-2d21-411e-94eb-844cb74535b5",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "18564b9b-46f1-4a19-b8c9-43c4ca59614a",
"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": "28b4f3ef-c557-43c4-855f-6e8b259ec801",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-30T15:10:42.5828207+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "44029923-1cd2-453c-92d7-9f0cd4e34a03"
},
"suggested_date_start": "2026-10-30T15:10:42.5828207+00:00",
"skill_id": "8dfd6300-c976-4b7e-ab10-38b822fb3384",
"skill_code": "sample string 32",
"skill": {
"id": "0056f01f-4aa0-4ae8-b8de-8ac35c6a298a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2bf96b82-4f67-4370-a165-f162ab42c71a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a3ee716-92fa-4508-b3a6-c03eae531763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a078001-e576-4977-be2b-377fe8a64eec",
"db_currency_id": "d8dc512b-240e-4f8d-acd5-8893655d4805",
"db_language_id": "94da5ac5-7f58-4c17-ad6f-666c71da4b65",
"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-10-30T15:10:42.5828207+00:00"
},
"modified_dateutc": "2026-10-30T15:10:42.5963149+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a5088c51-cc7b-4a15-86f3-2a19972175a5",
"date_reported_by_company": "2026-10-30T15:10:42.5963149+00:00",
"id2": 36,
"company_id": "f57758fa-a4f0-4f8a-a4a8-f3e0eb62b363",
"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": "ca9de9fb-0504-44b0-bf83-d221dac06b96",
"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-10-30T15:10:42.5963149+00:00"
},
"work_instruction_details_id": "6bea58ba-3a41-4e46-87fe-65147f7ad746",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "155f5256-cbdd-4ecc-80c9-0755dc633551",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "65b8c4c9-37da-4ce8-be19-87fe51ed3b2f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-30T15:10:42.5963149+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": "cce7053a-346b-4eab-a1b5-de28d162414f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-30T15:10:42.5963149+00:00"
}