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": "3369d359-1b1c-4d7b-84b9-da80497a9e82",
"jobs_id": "677926c3-79d9-43b2-a11a-c54c70acfdff",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b3e926ca-487b-4a80-9f05-399478a85b86",
"_parent_id": "a8e1f461-a437-4d56-9df0-f29fa38baa64",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "92426990-1fee-4883-a25d-df6825d2c4be",
"project_reference_back_office": "sample string 5",
"project": {
"id": "60d66516-b60b-485f-95bf-6bed0eee085c",
"_parent_id": "9c80ba54-2185-4f17-921b-0643665c495a",
"root_parent_id": "18e2d393-3b57-4b30-aaee-7d84ba6518da",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0be60758-7ec9-4b42-b145-ccb9ca530d58",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "575faaf0-3bca-4e56-88b4-85d3c1c7283e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9c8ef30-519b-4e4d-ae8c-03d734d79e8a",
"_parent_code": "sample string 6",
"sales_organization_id": "ba116e89-abb0-4736-96c4-ad2f3630071a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+00:00"
},
"modified_dateutc": "2026-10-08T04:04:35.5745092+00:00"
},
"equipment_model_id": "1e0c7b58-50ea-497f-b671-ec20c3ee60d9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ee21bc8a-9144-43a5-9520-a97efadb1e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eeb1dda3-d6ec-4808-8a85-2c6072183730",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "16f6d988-f118-4633-a336-7aaca8bd395a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0b739a5c-2de3-4d37-9b08-81db89d0bb8a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+00:00"
},
"modified_dateutc": "2026-10-08T04:04:35.5745092+00:00"
},
"equipment_family_id": "6315d379-8b42-4dda-80cd-64ec52e4b23a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "575faaf0-3bca-4e56-88b4-85d3c1c7283e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c9c8ef30-519b-4e4d-ae8c-03d734d79e8a",
"_parent_code": "sample string 6",
"sales_organization_id": "ba116e89-abb0-4736-96c4-ad2f3630071a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+00:00"
},
"modified_dateutc": "2026-10-08T04:04:35.5745092+00:00"
},
"date_in_production_since": "2026-10-08T04:04:35.5745092+00:00",
"date_out_of_production_since": "2026-10-08T04:04:35.5745092+00:00",
"date_end_support": "2026-10-08T04:04:35.5745092+00:00",
"sales_organization_id": "2a3e138e-f91b-49e6-b587-215238950c65",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+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-10-08T04:04:35.5874522+00:00"
},
"project_status_id": "2be9ff5c-a1d6-4343-a248-7d380db1abb6",
"project_status_code": "sample string 10",
"project_status": {
"id": "310c6a3a-6156-4e99-b51f-81c5f1e711b3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5c5ad17a-ad23-4546-b110-84f0ddaccf82",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T04:04:35.5874522+00:00"
},
"company_id": "b3a13c50-08a1-42db-8af3-0b3404365ec9",
"company_code": "sample string 12",
"db_address_id": "cfd10b1b-e918-4e2a-9441-5f0118a11ed5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cca12274-37c9-4b6e-aa60-cb6f95bf76cd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6a169fca-0096-48d4-9e0e-1f9e5792f2e3",
"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-10-08T04:04:35.5874522+00:00",
"date_create": "2026-10-08T04:04:35.5874522+00:00",
"date_update": "2026-10-08T04:04:35.5874522+00:00",
"updated_by_user_id": "a73cad41-be72-4a5d-a4bd-ab97536b1a6b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T04:04:35.5874522+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T04:04:35.5874522+00:00",
"date_last_job": "2026-10-08T04:04:35.5874522+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T04:04:35.5874522+00:00",
"modified_dateutc": "2026-10-08T04:04:35.5874522+00:00",
"is_mobile_installation": true
},
"job_type_id": "4697a57f-9070-4fb7-a403-9009a967f696",
"job_type_code": "sample string 7",
"job_type": {
"id": "0bbbac9d-b4c6-4143-814c-c9a05cfd9a9e",
"name": "sample string 2",
"sales_organization_id": "196a3772-7a7b-4ab8-bbf5-19bea8fd83a3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T04:04:35.5874522+00:00",
"code": "sample string 7"
},
"job_priority_id": "bee6d80a-968d-4fda-bed3-0b42cb36ba1e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e58011f4-df09-4580-aa62-12ed965818e3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6bca73fa-3f3a-43b8-b292-cd22ed608434",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T04:04:35.5874522+00:00"
},
"job_status_id": "732379e8-a61b-49ff-a734-5ed4c76b6f1c",
"job_status_code": "sample string 11",
"db_address_id": "48a27b7c-750c-415e-922c-322d31f1b148",
"contact_id": "e436d0c5-6962-4b1c-8dd3-045b2432cef8",
"requested_by_company_id": "6091c628-ba06-478e-a95c-ba46e16ac497",
"requested_by_contact_id": "76f14e9c-444a-4e9b-b6bf-3f71f3e48f2f",
"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-10-08T04:04:35.5874522+00:00",
"due_date": "2026-10-08T04:04:35.5874522+00:00",
"date_create": "2026-10-08T04:04:35.5874522+00:00",
"date_update": "2026-10-08T04:04:35.5874522+00:00",
"date_closed": "2026-10-08T04:04:35.5874522+00:00",
"suggested_user_id": "ccba7992-bbcb-4880-9777-d370a58b9df4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cce6631f-f4b2-43a1-88d2-9270a7995a6d",
"db_language_id": "70bf1188-10f0-4083-914d-60df84ffed09",
"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-10-08T04:04:35.5874522+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "743f8507-b23d-4f57-8b77-b0e2d21436f3",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c50bbaea-31c7-4810-8795-849f0131df9c",
"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": "8d62496d-2273-495c-ba7c-76fa60350b48",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T04:04:35.5874522+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "53ae5f0e-1470-448b-90f9-c79334266714"
},
"suggested_date_start": "2026-10-08T04:04:35.5874522+00:00",
"skill_id": "1fc76ffc-e65f-4812-9159-2e868b2b0d61",
"skill_code": "sample string 32",
"skill": {
"id": "695516fd-993d-4bae-99a9-b816ded2db8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ac695912-cc65-45e6-adc6-67295b859d8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b81deaa-471b-4019-a3c8-5b7620e2ebd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fa9eb7d-920b-4531-bc2c-ddb59cc1b0bd",
"db_currency_id": "5629b1aa-6985-4896-a36d-6d2b4b5ccf11",
"db_language_id": "6c1b9010-b88a-4003-b7de-324f389d718e",
"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-10-08T04:04:35.5745092+00:00"
},
"modified_dateutc": "2026-10-08T04:04:35.5874522+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a39ef63b-27f4-4e4a-b41c-0dbafdb1f076",
"date_reported_by_company": "2026-10-08T04:04:35.6039447+00:00",
"id2": 36,
"company_id": "10cae13c-0226-41a9-b77b-7047964fe78a",
"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": "f2489a5d-afe0-4c85-9288-d4c8ad52ad11",
"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-10-08T04:04:35.6039447+00:00"
},
"work_instruction_details_id": "e7a0c071-ce32-44f3-b6ff-a295dc153bad",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "40a878df-1a2a-4654-9d6d-6c53bf6f7d7b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "22a2d7b1-25cb-491e-85b1-9d3a4bbbd361",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T04:04:35.6039447+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": "5407357f-fbc4-45bc-ac43-8e8b8e2048f1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T04:04:35.6039447+00:00"
}