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": "46777023-2b9f-4376-bf53-a8a5439550a0",
"jobs_id": "629ed82b-47b9-41a4-955b-9c7b97ca555b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aa051ea5-f4fa-4bf2-a7c2-e2c9c6ebebf8",
"_parent_id": "3004022e-71eb-435d-a71f-0dc8c26e5209",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d1316a57-2a1d-41f5-bd2b-5ec522e949e7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d773c612-7f06-4ac2-ac8a-8de07598c21c",
"_parent_id": "330244b8-81b9-452a-b882-056ffdfc5b7d",
"root_parent_id": "cd5518bc-a5e9-4c3f-8da9-765f77724e8e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e7693983-3a3e-4f98-a1c3-ca1297cb0317",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4e35a884-a0a0-48d0-9494-02ebc5496438",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b863506-67ab-417e-92f0-6a7087edf59f",
"_parent_code": "sample string 6",
"sales_organization_id": "dd17e221-0319-40e3-8829-e34e1c2aad81",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00"
},
"equipment_model_id": "02018282-aa56-4c36-86a9-8912a09502f5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eee78a47-a4a2-42fa-98fd-78af2887bb9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fddae1b2-82b7-494a-b530-7759e907b4d3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "60b0cc58-6ae7-40a8-81c3-563d720e489f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "12e209e4-2bfd-4e21-954d-6acb475761c5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00"
},
"equipment_family_id": "0dde4673-81cd-4c80-a37b-22b7fb61fdfc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4e35a884-a0a0-48d0-9494-02ebc5496438",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b863506-67ab-417e-92f0-6a7087edf59f",
"_parent_code": "sample string 6",
"sales_organization_id": "dd17e221-0319-40e3-8829-e34e1c2aad81",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00"
},
"date_in_production_since": "2025-12-18T08:47:57.8906602+00:00",
"date_out_of_production_since": "2025-12-18T08:47:57.8906602+00:00",
"date_end_support": "2025-12-18T08:47:57.8906602+00:00",
"sales_organization_id": "2d073e39-05f7-440b-8ed5-cfbc020497e9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+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": "2025-12-18T08:47:57.8906602+00:00"
},
"project_status_id": "04512bef-cb8e-4b74-ac3e-0db0bb84c46f",
"project_status_code": "sample string 10",
"project_status": {
"id": "64746a8c-8eb2-42e9-b32c-a0a13c6b7eff",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f613bd67-a11b-492a-af8f-903eea961f52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00"
},
"company_id": "821ed730-eb8d-4338-82d2-480c27ff0a4b",
"company_code": "sample string 12",
"db_address_id": "40bc7f4a-74b6-492f-bce0-ab4c22774d94",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ab75659e-e6fa-4151-95e6-229dba6a75c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9e58266f-0dad-4aca-8e5f-9d7ef3cec1a5",
"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": "2025-12-18T08:47:57.8906602+00:00",
"date_create": "2025-12-18T08:47:57.8906602+00:00",
"date_update": "2025-12-18T08:47:57.8906602+00:00",
"updated_by_user_id": "9b8fcabe-92c0-4d25-9b86-72c16d930de2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-18T08:47:57.8906602+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": "2025-12-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-18T08:47:57.8906602+00:00",
"date_last_job": "2025-12-18T08:47:57.8906602+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-18T08:47:57.8906602+00:00",
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00",
"is_mobile_installation": true
},
"job_type_id": "d39299a8-8cba-4429-905c-4a48d45e3745",
"job_type_code": "sample string 7",
"job_type": {
"id": "c389a3d2-975c-4ae9-8acd-931315ff5c66",
"name": "sample string 2",
"sales_organization_id": "fbb6c0f9-9578-40bc-8da0-bf928b646760",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00",
"code": "sample string 7"
},
"job_priority_id": "396c13a1-01ae-497f-a2be-193e18b9285a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "352dd606-ee7e-4a94-a05c-681f864faa3f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3fc91ddf-b376-4c1c-b671-c13a061768ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00"
},
"job_status_id": "26bbab3f-9b05-452b-afd3-365121760b4a",
"job_status_code": "sample string 11",
"db_address_id": "914ec4d3-b632-49cf-b557-fcbdfa6b96f5",
"contact_id": "59f5afd4-3587-429d-a8c1-32a6f0ef6dae",
"requested_by_company_id": "c71b7d1f-1896-43b5-8f84-a2a481ebe339",
"requested_by_contact_id": "d41dd139-2a37-49ac-8469-af583755b0d2",
"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": "2025-12-18T08:47:57.8906602+00:00",
"due_date": "2025-12-18T08:47:57.8906602+00:00",
"date_create": "2025-12-18T08:47:57.8906602+00:00",
"date_update": "2025-12-18T08:47:57.8906602+00:00",
"date_closed": "2025-12-18T08:47:57.8906602+00:00",
"suggested_user_id": "e48a046f-d0e7-40a3-98df-f864daecfab9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0e84ea3e-4117-4010-a0a7-8f16f3846bb8",
"db_language_id": "cf24c1fe-8eb0-424f-9b31-a7165450b765",
"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": "2025-12-18T08:47:57.8906602+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "46c30455-2c1c-4aee-8d8e-157987a5d831",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6fc808ff-0d05-438f-bf8a-912c2dee6341",
"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": "132c845c-bd89-416e-a14b-797d00ba2905",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "26c15170-709e-4492-a401-4ec9817d7d4b"
},
"suggested_date_start": "2025-12-18T08:47:57.8906602+00:00",
"skill_id": "a5bb6730-0390-4384-8273-b3a75082be40",
"skill_code": "sample string 32",
"skill": {
"id": "dfbb060d-8cf3-45c1-bc32-14248dc0958a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "693596e7-7989-44b1-8070-7592f698cbbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c809930-1c40-4c14-b3b4-660b7ceeb90c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "17628260-d0ac-4470-84be-951edfc58b66",
"db_currency_id": "b828cfd5-7ed6-4f4d-a189-a07069666e58",
"db_language_id": "48ced66e-ea52-4241-a9ca-b0e1806e03d1",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"modified_dateutc": "2025-12-18T08:47:57.8906602+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fae9491f-df46-4689-b3b3-4d2f74f691a1",
"date_reported_by_company": "2025-12-18T08:47:57.8906602+00:00",
"id2": 36,
"company_id": "41f6d6b5-f569-4406-92ff-c1fb18dc7bfc",
"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": "26ccf97f-3b89-41eb-a6d7-3cdf93fd1922",
"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": "2025-12-18T08:47:57.8906602+00:00"
},
"work_instruction_details_id": "f6c972e4-4230-4000-a99c-c4993e0fbe68",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "935ab8e7-1eee-4ea6-8db2-2c075930a023",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d562272d-60b8-4013-80b7-7588e2d6bb5a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-18T08:47:57.9062843+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": "2a79669f-a05e-4e97-80cf-efa36f20ac9c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-18T08:47:57.9062843+00:00"
}