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": "0500f9cc-da2d-4f2e-aa28-103254160db0",
"jobs_id": "94fa6590-67e6-4a90-8185-434b96a15899",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "49cdc85d-1ca6-43f1-bba7-edf7b3abf7bd",
"_parent_id": "5fb16e23-62af-43aa-9be7-f062d9767f38",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e77cc426-c40a-4f36-9c82-b3e59ad8f923",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5dcd81a4-3aed-4bb5-bae7-91ef28793d58",
"_parent_id": "2315b5d0-fac7-49d5-8dfb-a605ee524f13",
"root_parent_id": "49744ad4-467f-4161-8e23-7a0bc293a0ef",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0509dea0-f999-481c-8745-316503e617e6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e1d1d48c-a482-4d68-921a-c9f68cb8ddcf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "227f625e-1b3c-4b94-a92f-6aba7d7837e1",
"_parent_code": "sample string 6",
"sales_organization_id": "428a7fb3-5686-48d5-8a5f-86a30d0ca39c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+00:00"
},
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00"
},
"equipment_model_id": "9979d965-f219-4c3c-855d-5e1d277de32e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b0ac79b9-4e52-47f4-982c-078e73c9283a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3663f3d2-2043-4c61-a234-b307a95bebb4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "129d9a18-8c4e-4295-ac3f-7a8018bb3359",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cd1ab342-0e78-46ea-adbe-c02b036754e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+00:00"
},
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00"
},
"equipment_family_id": "4e0dea29-e228-49be-b8d2-fcb6c6a94828",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e1d1d48c-a482-4d68-921a-c9f68cb8ddcf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "227f625e-1b3c-4b94-a92f-6aba7d7837e1",
"_parent_code": "sample string 6",
"sales_organization_id": "428a7fb3-5686-48d5-8a5f-86a30d0ca39c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+00:00"
},
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00"
},
"date_in_production_since": "2025-07-04T03:35:04.9399638+00:00",
"date_out_of_production_since": "2025-07-04T03:35:04.9399638+00:00",
"date_end_support": "2025-07-04T03:35:04.9399638+00:00",
"sales_organization_id": "9960bbc4-b0cd-4b7b-a734-a02936c3bbd6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+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-07-04T03:35:04.9399638+00:00"
},
"project_status_id": "3a037581-3a8e-49f1-93cc-cccf35d20571",
"project_status_code": "sample string 10",
"project_status": {
"id": "fa6dbb25-cbc2-40ad-8131-1f8a7fdf4bab",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2c409a93-9ca4-422f-b2a9-a8a08fc56337",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00"
},
"company_id": "eaf59aa3-c33e-4436-9ff0-8cc30e68104d",
"company_code": "sample string 12",
"db_address_id": "541f0b16-6718-492e-8949-27281190f7b2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d9d2f717-ca72-403f-9193-24c1fbcaa9b1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3c6c56e7-daf9-4670-ae7b-289833c2016b",
"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-07-04T03:35:04.9399638+00:00",
"date_create": "2025-07-04T03:35:04.9399638+00:00",
"date_update": "2025-07-04T03:35:04.9399638+00:00",
"updated_by_user_id": "92cbda3a-920c-4a68-9a28-fc774953efa2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-04T03:35:04.9399638+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-07-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-04T03:35:04.9399638+00:00",
"date_last_job": "2025-07-04T03:35:04.9399638+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-04T03:35:04.9399638+00:00",
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00",
"is_mobile_installation": true
},
"job_type_id": "bcd09ff5-994b-49a8-bc23-cabc7741d013",
"job_type_code": "sample string 7",
"job_type": {
"id": "3d81cd81-134c-4389-8cd9-8b3a6c34adde",
"name": "sample string 2",
"sales_organization_id": "58d1b520-a59e-423d-a2b3-5386df15a5d8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00",
"code": "sample string 7"
},
"job_priority_id": "76c2aded-ec11-4164-a09e-f3b5c998d817",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "15113662-140c-4707-a275-a44f3700e501",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a8954b39-5d66-4377-8352-08ea9cd802ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00"
},
"job_status_id": "93997427-7222-4d41-b312-46af7cf8c9c5",
"job_status_code": "sample string 11",
"db_address_id": "2441afd3-fafa-41cf-8383-9ec69f678558",
"contact_id": "2fbb129d-d382-4f90-9c06-16768b88763a",
"requested_by_company_id": "ad5af6e5-f22e-4353-85d0-a26f58fe681c",
"requested_by_contact_id": "fe86dcbc-78a1-42af-a1b7-9c08cb8f0ced",
"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-07-04T03:35:04.9399638+00:00",
"due_date": "2025-07-04T03:35:04.9399638+00:00",
"date_create": "2025-07-04T03:35:04.9399638+00:00",
"date_update": "2025-07-04T03:35:04.9399638+00:00",
"date_closed": "2025-07-04T03:35:04.9399638+00:00",
"suggested_user_id": "8c41f93a-4a43-459c-bf2a-6b64312b675f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dbd027fb-1cbb-4e77-993a-ec5a00d33127",
"db_language_id": "c1fb9bd1-abf3-4676-964d-6d43f11fccbb",
"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-07-04T03:35:04.9399638+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eca707ed-a40c-4bfb-8cce-f19b962ab640",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8468f252-a852-410e-95e5-51aec9e601ab",
"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": "edc7323e-7a94-4b7f-93b6-0c2d3df9615e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7121fec0-0c47-402f-8c68-1686001f1124"
},
"suggested_date_start": "2025-07-04T03:35:04.9399638+00:00",
"skill_id": "db095818-b4e1-4f0b-8156-9478756ade54",
"skill_code": "sample string 32",
"skill": {
"id": "7dc8e6e6-f04a-4161-938f-4738241441fc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5103ebe0-22da-4e46-a750-96a5a0d82960",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc65ad80-2709-4d03-a5c2-6540014a3a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "36f0fbd7-7e9c-4287-ab5c-e23e151dfa4a",
"db_currency_id": "d593b53f-acb4-4c9a-81b2-f143638c8f31",
"db_language_id": "93a6a1c8-80fc-4106-a411-05c49e4b4819",
"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-07-04T03:35:04.9399638+00:00"
},
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5073dc1a-5dd4-4b3b-8741-e5f87b354206",
"date_reported_by_company": "2025-07-04T03:35:04.9399638+00:00",
"id2": 36,
"company_id": "672d3d11-8480-499a-a96f-2f74a4e05fd4",
"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": "c9575149-663d-4557-a141-d09a3472859e",
"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-07-04T03:35:04.9399638+00:00"
},
"work_instruction_details_id": "40b2cb68-f16d-41b0-9e19-77cc7a71f886",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3402754f-0f21-4395-ba05-5305be672d47",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "310d0e76-437e-4b76-958c-7a408b464287",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-04T03:35:04.9399638+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": "bb9a09de-46f4-4400-9a41-eb9fe9a5bc3e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-04T03:35:04.9399638+00:00"
}