Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
job_work_instruction_listName | 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
{ "id": "1368a585-52ec-4a9e-a79a-0416edc59ee7", "jobs_id": "a65e191f-968b-469f-8aaf-c396a5c8551d", "jobs_reference_back_office": "sample string 3", "jobs": { "id": "8dad5476-7513-4d27-8c3d-25bf5113f2df", "_parent_id": "bee5d154-1ee9-4783-b739-6206624ee0a8", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "7476d4f4-aed5-4eee-9a16-d27039942881", "project_reference_back_office": "sample string 5", "project": { "id": "c68bcb2b-f57d-428c-8341-78e9a58b6c22", "_parent_id": "cef58b3d-0f64-49f9-be1b-b89ffaf8651d", "root_parent_id": "e794f8a2-3301-4420-a4fc-ec090a3b22d0", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "58149638-4ab1-40e5-afc4-eecf1e056feb", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d9fa1f32-6f3c-4406-af63-ad37da413686", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1edf8578-b3a9-403a-9bc6-e7de01d8d2e5", "_parent_code": "sample string 6", "sales_organization_id": "a220e412-0ea1-4d2f-9345-5dfaead6d767", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+00:00" }, "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00" }, "equipment_model_id": "32a0c707-ef2c-49ec-bd25-b15dcca6af33", "equipment_model_code": "sample string 8", "equipment_model": { "id": "001e3c47-6015-4563-9741-75d2f87a9f7f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "1b2ed9f2-e0e4-4aef-8a60-b91d531d2c2d", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "f316f634-189c-4b6d-a460-2f5e0809610d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7287529f-20b7-45cc-a981-1a3bb034498a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+00:00" }, "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00" }, "equipment_family_id": "8805bff4-d570-4eab-854a-59759ae55934", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d9fa1f32-6f3c-4406-af63-ad37da413686", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "1edf8578-b3a9-403a-9bc6-e7de01d8d2e5", "_parent_code": "sample string 6", "sales_organization_id": "a220e412-0ea1-4d2f-9345-5dfaead6d767", "sales_organization_code": "sample string 8", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+00:00" }, "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00" }, "date_in_production_since": "2024-03-27T08:14:29.7296858+00:00", "date_out_of_production_since": "2024-03-27T08:14:29.7296858+00:00", "date_end_support": "2024-03-27T08:14:29.7296858+00:00", "sales_organization_id": "7576bd3f-f2de-4e95-8b6a-005c74fa40da", "sales_organization_code": "sample string 13", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+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": "2024-03-27T08:14:29.7296858+00:00" }, "project_status_id": "4fd97add-880c-4d5f-a732-56d1f21b3d04", "project_status_code": "sample string 10", "project_status": { "id": "6f1296b3-896d-4ddf-b7b6-2d8a59bf942e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "9cc61370-f17e-4b35-8034-c06f086baec4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00" }, "company_id": "2f9a0f99-0023-4e22-9877-06379365e76e", "company_code": "sample string 12", "db_address_id": "9599c47c-f6ba-4db0-a4d8-e19d79c8ac7d", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "1872e7af-bd82-4e70-8d5c-af6e8e0b6814", "contact_reference_back_office": "sample string 17", "owner_user_id": "429719ae-a333-4c28-a9a6-3314f43d357d", "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": "2024-03-27T08:14:29.7296858+00:00", "date_create": "2024-03-27T08:14:29.7296858+00:00", "date_update": "2024-03-27T08:14:29.7296858+00:00", "updated_by_user_id": "18bdd503-115e-482a-862b-97e15ae9be84", "customer_reference": "sample string 28", "warranty_date_until": "2024-03-27T08:14:29.7296858+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": "2024-03-27T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-03-27T08:14:29.7296858+00:00", "date_last_job": "2024-03-27T08:14:29.7296858+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-03-27T08:14:29.7296858+00:00", "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00", "is_mobile_installation": true }, "job_type_id": "bba54bec-b016-40ba-a9e3-444819a8d3d0", "job_type_code": "sample string 7", "job_type": { "id": "fde73a54-f38d-41fe-a1a4-46e892acc068", "name": "sample string 2", "sales_organization_id": "f0f9ec54-ed10-431c-9893-5d7bc5f2d500", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00", "code": "sample string 7" }, "job_priority_id": "f3b1e399-bf36-4d75-a751-80afa32c1766", "job_priority_code": "sample string 9", "job_priority": { "id": "88afbc22-7b9e-440f-969f-e580d7afcf1b", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "2ee8f989-1c19-4692-b3d6-63ca57461009", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00" }, "job_status_id": "85877aa5-aba4-4918-96c2-5ef50c01ca0e", "job_status_code": "sample string 11", "db_address_id": "633b9ed3-74e0-451a-af3b-27b0570b6a01", "contact_id": "a0dc8034-2fc1-4c6b-a623-2c26f90ded45", "requested_by_company_id": "06c4e7c1-3700-477f-be4e-45426ea15e71", "requested_by_contact_id": "36bb45ff-3779-4b30-9172-049392bb162a", "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": "2024-03-27T08:14:29.7296858+00:00", "due_date": "2024-03-27T08:14:29.7296858+00:00", "date_create": "2024-03-27T08:14:29.7296858+00:00", "date_update": "2024-03-27T08:14:29.7296858+00:00", "date_closed": "2024-03-27T08:14:29.7296858+00:00", "suggested_user_id": "6457fc6e-333b-48e3-9a3a-4df0c941384e", "suggested_user_code": "sample string 29", "suggested_user": { "id": "34e9ac2e-145f-498f-8371-900746b16f4a", "db_language_id": "9464e34d-50e9-41b9-99bb-139a7de6bf49", "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": "2024-03-27T08:14:29.7296858+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "74bfd228-60c6-4ef7-8876-2f2d0433d25a", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "49d43cb6-5bdc-4f03-8c8f-f7e78bb6f798", "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": "1ab16f65-de7c-4a46-8410-9f0c1fde1a65", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "c3e14496-1850-4b13-9140-fa2ea68c4bfc" }, "suggested_date_start": "2024-03-27T08:14:29.7296858+00:00", "skill_id": "2820f83c-f82c-4824-9df4-066da2a3ed6e", "skill_code": "sample string 32", "skill": { "id": "e5a97e31-1f44-48a0-9eaa-0c982b06502e", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "9a6fe3a2-df75-48ae-ad98-84034b35e1ad", "sales_organization_code": "sample string 6", "sales_organization": { "id": "1a7f67e3-8fd2-48bf-a30d-9954827a71ad", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a27d7673-d5c3-44ce-9ee0-057c90fe2af7", "db_currency_id": "2a08a96c-161c-4f96-b7ea-8ad73f10005f", "db_language_id": "e81db50f-649d-4367-9491-b024afbec849", "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": "2024-03-27T08:14:29.7296858+00:00" }, "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "1c78695b-c749-4b3b-8e8f-115c478c402e", "date_reported_by_company": "2024-03-27T08:14:29.7296858+00:00", "id2": 36, "company_id": "48fa6b85-3147-4891-998c-f7ff4e798c0e", "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": "d7e89807-f568-41cc-8e8a-84758e51956b", "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": "2024-03-27T08:14:29.7296858+00:00" }, "work_instruction_details_id": "7fb6991c-630d-4fd1-8464-78b7edf8c59a", "work_instruction_details_reference_back_office": "sample string 5", "user_id": "d0e67bb0-e14b-4c7c-9196-c05e1d001ff1", "work_instruction_action_type": "sample string 7", "work_instruction_id": "6989365f-857e-4082-a0c5-96aa10fc8270", "work_instruction_reference_back_office": "sample string 9", "name": "sample string 10", "status": "sample string 11", "date_done": "2024-03-27T08:14:29.7296858+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": "8ea89a46-dd07-41c3-8336-e2e7d35f8afd", "db_report_type_name": "sample string 18", "modified_dateutc": "2024-03-27T08:14:29.7296858+00:00" }