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": "79b010cd-9a34-4768-a49b-5c70207f9caf",
"jobs_id": "4f50496e-d267-410d-bbd5-76908b26f11d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "92b6fdbb-7d59-4d7b-b152-8c5251a64bcd",
"_parent_id": "48bb6e1a-eaee-46e1-8f03-55df10aee187",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ddc769d6-b4c5-4569-9054-94f1eb2dad0a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fa77882a-f9d3-462e-a93e-2615f9a45b6d",
"_parent_id": "10fcef61-9c53-4551-85d2-ed8ef37ede1f",
"root_parent_id": "f04515a1-9029-470d-8bbc-3e6ca0944804",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f0accfc3-6f83-4595-b572-03d996d37446",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "530be48c-926c-4fb4-9e68-8a8cded601dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aed8f911-a483-467c-8118-9c622dccd56b",
"_parent_code": "sample string 6",
"sales_organization_id": "ffa7d05d-0671-4e8e-bf2e-00df3b42458c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+00:00"
},
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00"
},
"equipment_model_id": "471e6882-a7ac-4d1e-be14-0509a4079787",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ad41c071-cdb7-405e-a34d-ac84d0bf62ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8884a046-b36a-4f8f-b961-b2f2a51c47f8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "86cca4c7-138c-44c7-ac90-22d442a14e30",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9eb2360a-0f32-4e36-b900-49120876fac0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+00:00"
},
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00"
},
"equipment_family_id": "3877c983-4279-4749-b572-09f11f973f85",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "530be48c-926c-4fb4-9e68-8a8cded601dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aed8f911-a483-467c-8118-9c622dccd56b",
"_parent_code": "sample string 6",
"sales_organization_id": "ffa7d05d-0671-4e8e-bf2e-00df3b42458c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+00:00"
},
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00"
},
"date_in_production_since": "2025-05-16T16:52:04.795082+00:00",
"date_out_of_production_since": "2025-05-16T16:52:04.795082+00:00",
"date_end_support": "2025-05-16T16:52:04.795082+00:00",
"sales_organization_id": "3113ef01-7340-43c5-afb4-8e04d2116d6c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+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-05-16T16:52:04.795082+00:00"
},
"project_status_id": "733af29b-5b1b-4560-9500-350cf9de16c4",
"project_status_code": "sample string 10",
"project_status": {
"id": "76b37bc7-13e8-4558-9b43-fe8de15215c3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1bb08a4a-f403-4072-bd28-64d41d2fd3cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00"
},
"company_id": "6065628d-e031-488d-951c-b1fdcd03f841",
"company_code": "sample string 12",
"db_address_id": "14352793-9c67-4982-bc26-6206a622029c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8a0fb7d1-1e5b-4055-b92b-c64ccb2def1f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1e732a05-1dc2-465a-8fe6-e7db289fb89a",
"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-05-16T16:52:04.795082+00:00",
"date_create": "2025-05-16T16:52:04.795082+00:00",
"date_update": "2025-05-16T16:52:04.795082+00:00",
"updated_by_user_id": "41dea8c5-63ff-4d70-9814-061b320e606a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-16T16:52:04.795082+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-05-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-16T16:52:04.795082+00:00",
"date_last_job": "2025-05-16T16:52:04.795082+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-16T16:52:04.795082+00:00",
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00",
"is_mobile_installation": true
},
"job_type_id": "365a43a4-9493-48bf-b063-bf72285f0ec4",
"job_type_code": "sample string 7",
"job_type": {
"id": "460b2929-d193-44da-a597-4fd8cc710b06",
"name": "sample string 2",
"sales_organization_id": "93fe65a1-07da-476a-9115-f4658473c64a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00",
"code": "sample string 7"
},
"job_priority_id": "a420648b-4b64-4809-b890-1e42b8b3104b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "77508268-812c-4810-ae63-9b76b2bc92d7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "12cee850-473a-46bb-a9d3-c593137e44a4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00"
},
"job_status_id": "ffcca15a-7997-46e1-b2fc-c3b38b1a8045",
"job_status_code": "sample string 11",
"db_address_id": "0948f078-3407-450f-974e-19657fe2ca1c",
"contact_id": "652cdd17-6826-4911-824c-966a4afc04ce",
"requested_by_company_id": "c0e860b4-4344-423a-8dfe-034f8166fe65",
"requested_by_contact_id": "5285eb03-9e08-4210-aa49-c20c7c054322",
"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-05-16T16:52:04.795082+00:00",
"due_date": "2025-05-16T16:52:04.795082+00:00",
"date_create": "2025-05-16T16:52:04.795082+00:00",
"date_update": "2025-05-16T16:52:04.795082+00:00",
"date_closed": "2025-05-16T16:52:04.795082+00:00",
"suggested_user_id": "70967065-db86-4f5f-9e7a-8e082ae147ec",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a72fd11d-746c-4dd0-85bd-e6fa40da05c8",
"db_language_id": "9706d75a-ed1b-4969-99c8-38d53a4680a2",
"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-05-16T16:52:04.795082+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e5f2059c-d74b-44f5-9cab-3588667447bd",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9a5dafbf-d226-4362-8856-3695fb60182b",
"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": "744c2d74-0e84-42ac-9e34-b1d7adf7b394",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ede1332f-ca21-4081-9520-c122a776ecd3"
},
"suggested_date_start": "2025-05-16T16:52:04.795082+00:00",
"skill_id": "19f7651f-49ee-49a5-bc83-adde8b6d3108",
"skill_code": "sample string 32",
"skill": {
"id": "fbb89d77-7854-4e4b-a988-ae2ea9199399",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ac6be947-b48e-46bb-ab78-5d79f4c48500",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "567e8ac6-2355-40c1-a234-913b86ba5532",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03e969b2-49aa-4d63-856e-a954c128dbfb",
"db_currency_id": "5f460521-c6de-4f76-aa29-f48830204ca5",
"db_language_id": "5a3d2035-e7fe-4107-857c-9ac94cf81ac6",
"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-05-16T16:52:04.795082+00:00"
},
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f020c983-5f28-406c-822f-047121da4ceb",
"date_reported_by_company": "2025-05-16T16:52:04.795082+00:00",
"id2": 36,
"company_id": "1103746a-d82c-4375-8052-be4e8689ae8f",
"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": "b9e0bb06-45d6-4017-92e0-713e202b711e",
"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-05-16T16:52:04.795082+00:00"
},
"work_instruction_details_id": "8a86bd1f-25f2-4561-8e00-18bda2d4485c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c7bd955c-5786-423b-8ab4-80690d170798",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d544e87e-b35e-4a24-aeca-d623d920695d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-16T16:52:04.795082+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": "c37e689c-637d-4ec4-a914-3ab62c2616ab",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-16T16:52:04.795082+00:00"
}