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": "e1a044a8-d96c-4f58-bfa4-5247ec2acbd6",
"jobs_id": "cdf0ba3b-5253-4a89-8075-a1860f2e55e7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ed132292-6553-4ea0-92a2-a495af17f6a8",
"_parent_id": "c733d3e6-cd56-4d37-9f64-f09efce3f129",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "52723b17-60ae-4ee7-ac72-b6d495a9a263",
"project_reference_back_office": "sample string 5",
"project": {
"id": "58dce27a-2dad-4992-82f8-96a8f140183f",
"_parent_id": "ceac9b63-f214-4bf0-bfc7-06d479f1038d",
"root_parent_id": "3667b006-a6c0-4da6-b449-b506775120d5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "332899aa-34fc-4c67-9137-a8c3d083c51e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c227261a-bb18-408b-8e87-5d03e2d9c4f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db4c3d18-448e-4eac-8233-d148ce73288d",
"_parent_code": "sample string 6",
"sales_organization_id": "a4ab6ded-7484-4bc7-9af9-be345c6dfc71",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00"
},
"equipment_model_id": "5a84e3d7-fc81-4de8-971a-4ef0c65c6f3c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5825d839-d93f-4cd7-aa90-f0eaf0854d7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9ac161a2-7077-4442-aa52-f9d163d2b9d8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1b7b955b-4f50-43e4-9825-ff12563f7de6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "21c91752-f7f8-412b-b1b2-594c90a3f350",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00"
},
"equipment_family_id": "f10a9270-e9d1-4439-a66b-40f95be2434f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c227261a-bb18-408b-8e87-5d03e2d9c4f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db4c3d18-448e-4eac-8233-d148ce73288d",
"_parent_code": "sample string 6",
"sales_organization_id": "a4ab6ded-7484-4bc7-9af9-be345c6dfc71",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00"
},
"date_in_production_since": "2026-05-23T10:05:29.1915153+00:00",
"date_out_of_production_since": "2026-05-23T10:05:29.1915153+00:00",
"date_end_support": "2026-05-23T10:05:29.1915153+00:00",
"sales_organization_id": "39b1fb06-2c2c-4dd3-bfa1-4b32262ccc7d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+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-05-23T10:05:29.1915153+00:00"
},
"project_status_id": "858c3e1c-d524-477b-86c2-e7bed29572c7",
"project_status_code": "sample string 10",
"project_status": {
"id": "5fe4da6b-ce61-404c-8696-ae2f27d0257c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4b6f8b22-2a98-425f-8e6d-b82c342e5c0d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00"
},
"company_id": "531ed67c-9f27-46b2-b37e-744bc92a4152",
"company_code": "sample string 12",
"db_address_id": "c9a7b537-8c61-40b6-8b15-e7b89c2bd977",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2df61f60-bf3e-4989-8ef8-36c3b94d0ada",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "07cca345-5e70-4700-bd1f-9c0a38099b5f",
"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-05-23T10:05:29.1915153+00:00",
"date_create": "2026-05-23T10:05:29.1915153+00:00",
"date_update": "2026-05-23T10:05:29.1915153+00:00",
"updated_by_user_id": "3d5708b6-90b4-4e2d-9e23-1b24849c8e1c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-23T10:05:29.1915153+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-05-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-23T10:05:29.1915153+00:00",
"date_last_job": "2026-05-23T10:05:29.1915153+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-23T10:05:29.1915153+00:00",
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00",
"is_mobile_installation": true
},
"job_type_id": "8f308981-eb3b-4949-a4dd-3f0f4d7a720a",
"job_type_code": "sample string 7",
"job_type": {
"id": "ebaa44f6-d0f5-4d04-93c3-89bc3e9660a2",
"name": "sample string 2",
"sales_organization_id": "4695f9f9-c157-4955-8569-aff6ca6b8ab8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00",
"code": "sample string 7"
},
"job_priority_id": "3a0ac831-8195-4470-b576-77b03b30a24c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "61847071-a84b-44d1-8cf4-6e434a046064",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bad6ff20-395c-4a37-87cb-1e2b25bbbd6a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00"
},
"job_status_id": "7876626b-04aa-4d82-a0e1-087fbe15dd81",
"job_status_code": "sample string 11",
"db_address_id": "e96b402a-b8eb-4a27-b88b-bb7c01275dff",
"contact_id": "df2e8300-312e-45f7-9254-c80fe118dd90",
"requested_by_company_id": "c17e2c14-ea32-4050-8fe5-467c413ad3c6",
"requested_by_contact_id": "b1c32bd2-73d0-4aef-90ff-1c3195ff9565",
"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-05-23T10:05:29.1915153+00:00",
"due_date": "2026-05-23T10:05:29.1915153+00:00",
"date_create": "2026-05-23T10:05:29.1915153+00:00",
"date_update": "2026-05-23T10:05:29.1915153+00:00",
"date_closed": "2026-05-23T10:05:29.1915153+00:00",
"suggested_user_id": "7f228650-e19d-4c32-a555-29714271184c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2c5a4f21-3291-411f-bd70-02eb6840c0ff",
"db_language_id": "237388dd-822d-43de-b491-307e2d5dc9d5",
"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-05-23T10:05:29.1915153+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "73f9e010-e89a-424e-adad-39da21fad7f2",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5f12c846-0278-4fa9-bc28-84e8bbad88a7",
"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": "2c6feb4c-b452-4ceb-8045-af65f771a37e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "34168e67-b143-49e3-a81f-0d6bfce79bf2"
},
"suggested_date_start": "2026-05-23T10:05:29.1915153+00:00",
"skill_id": "e8203c94-4501-4dc9-bd5d-87623e92c0e0",
"skill_code": "sample string 32",
"skill": {
"id": "1f8ed4e4-1782-4bb3-b464-1620ce67b4f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1f326093-e911-4a8b-bf36-d4b0fefe1121",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b2915d48-f4e6-41bc-9992-3359798d02c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f952400-9120-4464-833a-c1483dfa2b13",
"db_currency_id": "a4c66499-0f35-46e6-a448-56ac6a9c109b",
"db_language_id": "33ce5405-ab8b-472b-82a4-fa9bdf0f1245",
"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-05-23T10:05:29.1915153+00:00"
},
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1c242a08-9628-4d27-919d-069b76ffd770",
"date_reported_by_company": "2026-05-23T10:05:29.1915153+00:00",
"id2": 36,
"company_id": "52c8e604-42a2-4c22-a350-67b2b79eddb5",
"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": "ee3fec0f-f1b4-4e6a-9642-43e438928c6f",
"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-05-23T10:05:29.1915153+00:00"
},
"work_instruction_details_id": "5e670f55-326f-46cd-addf-d7cd9e82cbfd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "70e6425b-706d-43d4-b1cd-95c4f5944455",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3acb43ef-0d0a-4db2-952a-613da42f75c5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-23T10:05:29.1915153+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": "cd41791d-280b-41f3-b3c4-b5c41e42bdd4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-23T10:05:29.1915153+00:00"
}