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": "febb44c4-45ae-4ee9-b689-612ea5ead56b",
"jobs_id": "bac75277-1dcc-42d5-9148-4aa6d19c3e44",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "12ba3a1f-0a3e-4a4c-956c-297892f4f601",
"_parent_id": "5518a0f8-ab80-452f-9dd5-a34c87270a7d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b11c3153-2005-487c-979f-1acc7779cf4c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3ecd025a-b418-497f-9a3e-efbf6ad7750d",
"_parent_id": "d2e39850-5c88-490e-80d3-b440ea096041",
"root_parent_id": "e5430060-0f33-495f-88af-160e557a5df4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c5ba7394-c28a-428a-abab-bc3c74b52871",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "403aa1de-ffa8-4681-aaab-2aeaae9114f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9502090e-152a-4217-94f3-c0df45d2afbc",
"_parent_code": "sample string 6",
"sales_organization_id": "ddab628f-8004-4918-ae71-54395eb47e1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+00:00"
},
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00"
},
"equipment_model_id": "97ea19e8-fad7-43f6-928d-d215df9b0a17",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "42e82554-2447-4a29-b013-5131fe7281f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4fad8353-0404-4866-9aac-f9378468d86d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "92d90b5f-d1bc-47be-b320-611c59e9e571",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fed0cdf3-10a9-4231-8a86-eba7970df8fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+00:00"
},
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00"
},
"equipment_family_id": "b74c507d-3673-4d3f-8dae-e535e2a2c075",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "403aa1de-ffa8-4681-aaab-2aeaae9114f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9502090e-152a-4217-94f3-c0df45d2afbc",
"_parent_code": "sample string 6",
"sales_organization_id": "ddab628f-8004-4918-ae71-54395eb47e1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+00:00"
},
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00"
},
"date_in_production_since": "2025-04-25T15:57:14.3614749+00:00",
"date_out_of_production_since": "2025-04-25T15:57:14.3614749+00:00",
"date_end_support": "2025-04-25T15:57:14.3614749+00:00",
"sales_organization_id": "df19decb-972b-4830-9863-7e1531778ec8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+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-04-25T15:57:14.3614749+00:00"
},
"project_status_id": "3d320347-880a-4753-aac5-8410aa521886",
"project_status_code": "sample string 10",
"project_status": {
"id": "8e13f946-8cc3-43e0-a0bc-fa64d5f9529e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b8506ede-79bf-4e41-832b-bdfbdb37111a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00"
},
"company_id": "64d48367-fd94-4083-8fc0-317b8d430dbe",
"company_code": "sample string 12",
"db_address_id": "e087a48a-5938-48a4-a20a-cf3dd0874e6f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5cbaae41-0a6a-4b94-87ad-4adb0f051d5b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3f614e5a-c8ac-4287-ac74-b335486fa679",
"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-04-25T15:57:14.3614749+00:00",
"date_create": "2025-04-25T15:57:14.3614749+00:00",
"date_update": "2025-04-25T15:57:14.3614749+00:00",
"updated_by_user_id": "cc15e188-b217-42a2-8605-3133704103c2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-04-25T15:57:14.3614749+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-04-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-04-25T15:57:14.3614749+00:00",
"date_last_job": "2025-04-25T15:57:14.3614749+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-04-25T15:57:14.3614749+00:00",
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00",
"is_mobile_installation": true
},
"job_type_id": "e8968879-acd8-44a5-a445-17377552d29e",
"job_type_code": "sample string 7",
"job_type": {
"id": "0844b7c6-28e6-46d4-969c-c1a64d1d7011",
"name": "sample string 2",
"sales_organization_id": "8f6196cc-ccea-4a79-88dd-b3894cd2a79c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00",
"code": "sample string 7"
},
"job_priority_id": "f77a5f44-65dc-4553-836f-06e0da31540b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fbe223d3-91f0-428c-90a6-287696bdfaa2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e745ddcc-0cc3-4c20-a5ee-2059664f287d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00"
},
"job_status_id": "686ec653-97f0-4b86-910e-406186258472",
"job_status_code": "sample string 11",
"db_address_id": "49035c3b-137e-47e2-bb9f-d9497d25cec8",
"contact_id": "89598bb1-3c28-4909-bf3f-cde254ec0c03",
"requested_by_company_id": "9967991a-962f-4ea4-a38b-70e7cf4f43d1",
"requested_by_contact_id": "ae8732a0-0caf-4c6a-8a34-df0693b71515",
"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-04-25T15:57:14.3614749+00:00",
"due_date": "2025-04-25T15:57:14.3614749+00:00",
"date_create": "2025-04-25T15:57:14.3614749+00:00",
"date_update": "2025-04-25T15:57:14.3614749+00:00",
"date_closed": "2025-04-25T15:57:14.3614749+00:00",
"suggested_user_id": "0b524917-dbc7-4589-96eb-c398405b3304",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4648bd84-d4d8-4d79-81bc-42a67d4e9c14",
"db_language_id": "c6bb049e-df4e-42cb-abf3-cc2389ab92e7",
"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-04-25T15:57:14.3614749+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a07babda-6a6d-4a3f-b5b3-3b19f4b1cc5f",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d7049278-9010-4e81-8d17-a901837be2a0",
"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": "a9f26d72-f279-4341-a230-093b998aa447",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4c8b9404-edfe-4a60-b89e-9e9fe1fa4828"
},
"suggested_date_start": "2025-04-25T15:57:14.3614749+00:00",
"skill_id": "401c74cd-ae0a-438a-80c2-a80dc9eba9b1",
"skill_code": "sample string 32",
"skill": {
"id": "e2e8e95c-943f-4da7-9175-1b81138b2f94",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3559622c-a8a4-452d-82d9-0dc93ca50bea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5032ae4-a5bb-4007-b7d9-945b467e9fca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "008bd92c-bb67-4805-b3bf-79081e011f61",
"db_currency_id": "f168cd4e-c447-40dd-8b7c-086dab9fecf0",
"db_language_id": "5fc1f9c3-9513-49b1-b35a-6daab881322d",
"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-04-25T15:57:14.3614749+00:00"
},
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fccd7f28-3a55-44b4-8802-28aa56bdb72d",
"date_reported_by_company": "2025-04-25T15:57:14.3614749+00:00",
"id2": 36,
"company_id": "c6348199-aa10-4547-87af-b1b8af161864",
"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": "a061588e-eee6-4afb-bd6f-2a5515f96b37",
"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-04-25T15:57:14.3614749+00:00"
},
"work_instruction_details_id": "67903860-2fb6-4e14-8c8a-84e0a958bfc4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d5e0df97-331a-4b7d-b566-e7b17c722017",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fae45b3e-f89a-4c3b-af14-36c71725b600",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-04-25T15:57:14.3614749+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": "4c53f0c7-24e7-4e4c-8844-abd214b5be3c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-04-25T15:57:14.3614749+00:00"
}