Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "90c8145c-a536-4a13-93f2-f94ae2bced20",
"jobs_id": "ae01e59f-23cd-4838-82e2-2fa4ba306f46",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "86d744cf-98fa-4af2-8f85-e399fb2d7073",
"_parent_id": "8020caef-2d55-43be-b71d-7768354d39ea",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8ba248e2-4a7e-4c63-9dd7-801358348a6a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "230e8327-767d-4982-ba0d-b216def90770",
"_parent_id": "a2883a2d-48b8-4315-b7f5-405077df3d7e",
"root_parent_id": "4adc496d-8e56-4f13-b73e-efb50651547d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "29052c0b-b7c2-4e3d-baac-036dbe59caa6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "adcae22b-6470-4a43-bdaf-d03ebe7d1ba4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff2674fb-0583-4658-b832-ac84e80be92e",
"_parent_code": "sample string 6",
"sales_organization_id": "8d816fc6-e3eb-46c5-b1ae-312426412baf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+00:00"
},
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00"
},
"equipment_model_id": "b3b778ee-cfb3-479d-b02a-77b7d5b3abc1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "953e5292-e077-4951-800f-9c59da340b7c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "625537a9-bdb1-4bf3-ac77-c6a45b1bc7d3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "000eef27-7b63-4bac-84d3-2a00f290fa33",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fc929cde-5e61-4aeb-a690-c81f02b52efe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+00:00"
},
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00"
},
"equipment_family_id": "3a05eb10-a839-44a8-ac8e-028452dee7a7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "adcae22b-6470-4a43-bdaf-d03ebe7d1ba4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff2674fb-0583-4658-b832-ac84e80be92e",
"_parent_code": "sample string 6",
"sales_organization_id": "8d816fc6-e3eb-46c5-b1ae-312426412baf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+00:00"
},
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00"
},
"date_in_production_since": "2026-02-24T23:46:18.0542188+00:00",
"date_out_of_production_since": "2026-02-24T23:46:18.0542188+00:00",
"date_end_support": "2026-02-24T23:46:18.0542188+00:00",
"sales_organization_id": "e783c47e-75b3-4f6c-8afb-7d0ea9621afd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+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-02-24T23:46:18.0542188+00:00"
},
"project_status_id": "7b646810-73b1-4db8-a571-acf81469aae7",
"project_status_code": "sample string 10",
"project_status": {
"id": "a1d2c534-0f88-4a18-8a71-cbbe4d79d780",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "defe0a5b-192c-45a2-8400-a61d5d88865b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00"
},
"company_id": "c63312e6-d5b9-46d5-8fb1-3c2d544952d3",
"company_code": "sample string 12",
"db_address_id": "830278b8-505d-4928-a0e7-972c07c56b66",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bd1d08c5-e686-4c05-93cb-84867ef23732",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5060456c-f50b-42f7-b148-be98876c3c6a",
"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-02-24T23:46:18.0542188+00:00",
"date_create": "2026-02-24T23:46:18.0542188+00:00",
"date_update": "2026-02-24T23:46:18.0542188+00:00",
"updated_by_user_id": "fe4263e2-f263-4b37-9174-05dcabc51b50",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-24T23:46:18.0542188+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-02-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-24T23:46:18.0542188+00:00",
"date_last_job": "2026-02-24T23:46:18.0542188+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-24T23:46:18.0542188+00:00",
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00",
"is_mobile_installation": true
},
"job_type_id": "6e38d93e-8e6c-454b-be31-3e801feaac3a",
"job_type_code": "sample string 7",
"job_type": {
"id": "571de45a-bb6b-4053-b01b-f859f4ea7563",
"name": "sample string 2",
"sales_organization_id": "e412eecc-6d46-4001-a877-589e8328171f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00",
"code": "sample string 7"
},
"job_priority_id": "2f1aab79-3d7d-426c-8455-d227d2d1db85",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bee4d1cd-9da4-46b6-bc83-123d328497e6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "82b2147a-f43b-4c1b-98ff-680b9b905bc2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00"
},
"job_status_id": "a7558de5-c7ab-4439-b48f-4362e9433152",
"job_status_code": "sample string 11",
"db_address_id": "d270fa7a-3ad4-4cad-9403-67dd48c764d8",
"contact_id": "69bc1476-21db-48d5-9825-807ad76e1113",
"requested_by_company_id": "7888afa6-eda9-4017-a844-a9372637964c",
"requested_by_contact_id": "2088688f-afc3-479c-ba85-8c2ee7037599",
"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-02-24T23:46:18.0542188+00:00",
"due_date": "2026-02-24T23:46:18.0542188+00:00",
"date_create": "2026-02-24T23:46:18.0542188+00:00",
"date_update": "2026-02-24T23:46:18.0542188+00:00",
"date_closed": "2026-02-24T23:46:18.0542188+00:00",
"suggested_user_id": "d92b7e04-9072-4928-adfa-2dea255a1ba9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9c558f6d-0e47-41ed-9320-f0b2db027ce7",
"db_language_id": "2374435d-729d-4e2d-bd65-3f227ce1efd9",
"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-02-24T23:46:18.0542188+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e9374e44-36d6-4212-b31e-289cfd633131",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7a821c9c-71f6-4888-bf10-5b8218d8d137",
"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": "c5d28337-2725-4b7f-a96a-c2b609efa60e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dd553ba7-30fc-4b78-be97-f2a8f8f72b7a"
},
"suggested_date_start": "2026-02-24T23:46:18.0542188+00:00",
"skill_id": "dd90072b-1387-4593-9461-2a5b7f9f00d9",
"skill_code": "sample string 32",
"skill": {
"id": "9e6260e8-8acc-49d1-a90a-8914c42e541c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "442f20af-117b-4675-800a-4e7deb4ca7d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40dbe73a-3d2e-4366-9e35-6b2a45cc3e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ca89c68-5db8-4ae7-aa05-d731ab68283f",
"db_currency_id": "1aa79853-548c-4b52-8bf4-e21f052b23aa",
"db_language_id": "c5fbad97-d499-434e-9d14-f43bfb410308",
"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-02-24T23:46:18.0542188+00:00"
},
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bf229314-b126-4336-bcf2-e4979eb7ada2",
"date_reported_by_company": "2026-02-24T23:46:18.0542188+00:00",
"id2": 36,
"company_id": "48b6d11b-bf5b-40b2-9476-aac16d51a8c1",
"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": "38dc2cbd-89e4-4ed0-9cb3-4efb5ef04dc9",
"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-02-24T23:46:18.0542188+00:00"
},
"work_instruction_details_id": "8e3ea704-c5b9-4fd2-ac0b-473e82b368fc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bd3885a4-8dcc-45a9-b604-becaafc7f322",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ac424f2-3575-4c9d-8cba-cbbf234821db",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-24T23:46:18.0542188+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": "4f80f974-3612-4d1f-960f-e6e2a3ab9dcb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-24T23:46:18.0542188+00:00"
}